GET
/
payouts
curl --request GET \
    --url https://api.sandbox.example.gr4vy.app/payouts
{
  "items": [
    {
      "type": "payout",
      "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
      "merchant_account_id": "default",
      "amount": 1299,
      "currency": "USD",
      "created_at": "2022-01-01T12:00:00+00:00",
      "updated_at": "2022-01-01T12:00:00+00:00",
      "payment_service": {
        "type": "payment-service",
        "id": "stripe-card-faaad066-30b4-4997-a438-242b0752d7e1",
        "display_name": "Stripe (Main)",
        "method": "card",
        "payment_service_definition_id": "stripe-card"
      },
      "payment_service_payout_id": "example",
      "category": "online_gambling",
      "status": "pending",
      "external_identifier": "user-789123",
      "merchant": {
        "type": "merchant",
        "name": "Merchant",
        "identification_number": "<string>",
        "phone_number": "+1234567890",
        "url": "<string>",
        "statement_descriptor": "<string>",
        "merchant_category_code": "<string>",
        "address": {
          "city": "London",
          "country": "GB",
          "postal_code": "789123",
          "state": "Greater London",
          "state_code": "GB-LND",
          "house_number_or_name": "10",
          "line1": "10 Oxford Street",
          "line2": "New Oxford Court",
          "organization": "Gr4vy"
        }
      },
      "buyer": {
        "type": "buyer",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "billing_details": {
          "type": "billing-details",
          "first_name": "John",
          "last_name": "Lunn",
          "email_address": "john@example.com",
          "phone_number": "+1234567890",
          "address": {
            "city": "London",
            "country": "GB",
            "postal_code": "789123",
            "state": "Greater London",
            "state_code": "GB-LND",
            "house_number_or_name": "10",
            "line1": "10 Oxford Street",
            "line2": "New Oxford Court",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "gb.vat"
          }
        },
        "display_name": "John L.",
        "external_identifier": "user-789123",
        "account_number": "1234567"
      },
      "payment_method": {
        "type": "payment-method",
        "id": "77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5",
        "approval_target": "any",
        "approval_url": "https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve",
        "country": "US",
        "currency": "USD",
        "details": {
          "bin": "412345",
          "card_type": "credit",
          "card_issuer_name": "Bank"
        },
        "expiration_date": "11/25",
        "external_identifier": "user-789123",
        "label": "1111",
        "last_replaced_at": "2023-07-26T19:23:00.000+00:00",
        "method": "card",
        "payment_account_reference": "V0010014629724763377327521982",
        "scheme": "visa",
        "fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17"
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

This endpoint requires the payouts.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json

Returns a paginated list of payouts for an account.

A list of payouts.

​
items
object[]

A list of payouts.

​
limit
integer
default:20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 <= x <= 100
Example:

1

​
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

​
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

null