Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://payouts.api.trykarat.com/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "description": "<string>",
      "referenceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "statusUpdates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "processing",
          "reason": "<string>",
          "date": "2023-11-07T05:31:56Z"
        }
      ],
      "recipient": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "autoAcceptPayouts": true
      },
      "payoutLink": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
Authorization
string
header
required

Pass your API key as a bearer token: Authorization: Bearer <API_KEY>.

Query Parameters

​
limit
integer
default:100

Maximum number of results to return (max 100, default 100).

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of results to skip for pagination (default 0).

Required range: x >= 0
​
recipientId
string<uuid>

Filter payments by recipient ID.

​
batchId
string<uuid>

Filter payments by the batch they were created in.

​
referenceId
string

Filter payments by your own reference ID.

Response

A paginated list of payments.

​
data
object[]
​
meta
object