Payouts
List payouts created.
Account updater
Buyers - Payment methods
Payment methods
Payment methods - Payment service tokens
Payment methods - Network tokens
Buyers - Gift cards
Buyers - Shipping details
Card scheme definitions
Digital wallets - Setup
Digital wallets - Sessions
Transactions
Refunds
Payment options
Payment service definitions
Payment services
Audit logs
Checkout sessions
Merchant accounts
Payouts
List payouts created.
Returns a list of payouts made.
GET
/
payouts
curl --request GET \
--url https://api.{id}.gr4vy.app/payouts \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"type": "payout",
"id": "6f96a57e-a35b-4f98-b192-d298995f811a",
"amount": 1299,
"buyer": {
"type": "buyer",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"display_name": "John Doe",
"external_identifier": "buyer-12345",
"billing_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "john@example.com",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
},
"tax_id": {
"value": "12345678931",
"kind": "us.ein"
}
},
"account_number": "<string>"
},
"category": "online_gambling",
"created_at": "2013-07-16T19:23:00.000+00:00",
"currency": "EUR",
"external_identifier": "payout-12345",
"merchant": {
"type": "merchant",
"name": "Acme Inc",
"identification_number": "12345",
"phone_number": "+14155552671",
"url": "https://example.com",
"statement_descriptor": "Winnings",
"merchant_category_code": "1234",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
}
},
"merchant_account_id": "default",
"payment_method": {
"type": "payment-method",
"approval_url": "https://gr4vy.app/redirect/12345",
"country": "US",
"currency": "USD",
"details": {
"bin": "<string>",
"card_type": "credit",
"card_issuer_name": "<string>"
},
"expiration_date": "12/30",
"fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
"label": "1234",
"last_replaced_at": "2013-07-16T19:23:00.000+00:00",
"method": "card",
"mode": "card",
"scheme": "visa",
"id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
"approval_target": "any",
"external_identifier": "card-12345",
"payment_account_reference": "V0010014629724763377327521982"
},
"payment_service": {
"type": "payment-service",
"id": "b6c9eb12-2b62-4103-99b9-e3efc94e396d",
"method": "card",
"payment_service_definition_id": "nuvei-card",
"display_name": "Nuvei"
},
"payment_service_payout_id": "pout-12345",
"status": "succeeded",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The ID of the merchant account to use for this request.
Examples:
"default"
Query Parameters
A pointer to the page of results to return.
Examples:
"ZXhhbXBsZTE"
The maximum number of items that are at returned.
Required range:
1 <= x <= 100
Examples:
20
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.{id}.gr4vy.app/payouts \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"type": "payout",
"id": "6f96a57e-a35b-4f98-b192-d298995f811a",
"amount": 1299,
"buyer": {
"type": "buyer",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"display_name": "John Doe",
"external_identifier": "buyer-12345",
"billing_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "john@example.com",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
},
"tax_id": {
"value": "12345678931",
"kind": "us.ein"
}
},
"account_number": "<string>"
},
"category": "online_gambling",
"created_at": "2013-07-16T19:23:00.000+00:00",
"currency": "EUR",
"external_identifier": "payout-12345",
"merchant": {
"type": "merchant",
"name": "Acme Inc",
"identification_number": "12345",
"phone_number": "+14155552671",
"url": "https://example.com",
"statement_descriptor": "Winnings",
"merchant_category_code": "1234",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
}
},
"merchant_account_id": "default",
"payment_method": {
"type": "payment-method",
"approval_url": "https://gr4vy.app/redirect/12345",
"country": "US",
"currency": "USD",
"details": {
"bin": "<string>",
"card_type": "credit",
"card_issuer_name": "<string>"
},
"expiration_date": "12/30",
"fingerprint": "20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17",
"label": "1234",
"last_replaced_at": "2013-07-16T19:23:00.000+00:00",
"method": "card",
"mode": "card",
"scheme": "visa",
"id": "852b951c-d7ea-4c98-b09e-4a1c9e97c077",
"approval_target": "any",
"external_identifier": "card-12345",
"payment_account_reference": "V0010014629724763377327521982"
},
"payment_service": {
"type": "payment-service",
"id": "b6c9eb12-2b62-4103-99b9-e3efc94e396d",
"method": "card",
"payment_service_definition_id": "nuvei-card",
"display_name": "Nuvei"
},
"payment_service_payout_id": "pout-12345",
"status": "succeeded",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}