Retrieve a list of payout requests

Retrieves a list of payout requests.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of payout requests retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

currency
required
string = 3 characters

Currency of the payout.

amount
required
number <double>

Amount of the payout.

customerId
required
string <= 50 characters

ID of the customer who is requesting a payout.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

paymentInstrumentId
string <= 50 characters

ID of the requested payment instrument to offer for the payout.

unallocatedAmount
number <double>

Available payout request amount that has not been allocated.

status
string

Status of the request.

Enum: Description
pending

Request is awaiting customer's selection of the payment instrument or fulfillment.

instrument-selected

Request has a selected payment instrument and is awaiting fulfillment.

partially-fulfilled

Request is partially paid out when availableAmount is less than amount.

fulfilled

Request is fully paid out when availableAmount reaches zero.

selectPaymentInstrumentUrl
string <uri>

URL for the customer to select a preferred payment instrument.

Array of objects

List of credit transactions that are allocated to reduce the available amount of a payout request.

Array
transactionId
string <= 50 characters

ID of the transaction to which the payout request is allocated.

transactionResult
string

Result of a transaction.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"
gatewayName
string or null

Name of the payment gateway that processed, or is selected to process, the transaction.

Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 170 more
paymentInstrumentId
string <= 50 characters

ID of the selected payment instrument for the transaction.

amount
number <double>

Payout amount that is allocated from the payout request to the credit transaction.

createdTime
string <date-time>

Date and time when a payout request is allocated.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

createdTime
string <date-time>

Date and time when the payout request is created.

updatedTime
string <date-time>

Date and time when the payout request is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/payout-requests
Request samples
Response samples
application/json
[
  • {
    }
]