API Reference
Fetch payout card list
GET/v2/payout-profiles/cardPayout Profiles
Request
Query Params
itemsPerPage
string
optional
Limit of results
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Page of results
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
enum<string>
optional
Direction of order
Allowed values:
ascdesc
Default:
asc
sortBy
enum<string>
optional
column sorting
Allowed value:
createdAt
Default:
createdAt
Header Params
request-id
string
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
customer-id
string <uuid>
optional
A customer identifier
external-customer-id
string
optional
A customer identifier from merchant system
Request samples
Responses
OK(200)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
optional
One of
data
array [object {9}]
required
meta
object
Meta
Example
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"cardName": "string",
"recipientFirstName": "string",
"recipientLastName": "string",
"last4": "stri",
"fundsAvailability": "string",
"createdAt": "2019-08-24T14:15:22.123Z",
"updatedAt": "2019-08-24T14:15:22.123Z"
}
],
"meta": {
"itemsPerPage": "10",
"page": "1",
"direction": "asc",
"sortBy": "createdAt"
}
}Modified at 10 days ago