curl --request GET \
--url https://api.paygentic.io/v0/payouts \
--header 'Authorization: Bearer <token>'
{
"object": "list",
"data": [
{
"id": "<string>",
"object": "payout",
"organizationId": "<string>",
"status": "pending",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"platformFee": 123,
"methodFee": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>",
"transferredAmountInCents": 123
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Retrieve a list of payouts.
curl --request GET \
--url https://api.paygentic.io/v0/payouts \
--header 'Authorization: Bearer <token>'
{
"object": "list",
"data": [
{
"id": "<string>",
"object": "payout",
"organizationId": "<string>",
"status": "pending",
"description": "<string>",
"amountInCents": 123,
"currency": "<string>",
"method": "bank_transfer",
"sourceId": "<string>",
"destinationId": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"platformFee": 123,
"methodFee": 123,
"transactionId": "<string>",
"failureCode": "<string>",
"failureMessage": "<string>",
"transferredAmountInCents": 123
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Unique identifier for an organization
pending
, success
, failed
, cancelled
1 <= x <= 100
x >= 0
List of payouts
The response is of type object
.