GET
/
payoutRequests
/
{payoutRequestId}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

payoutRequestId
string
required

Unique identifier of the payout request.

Response

200 - application/json
id
string

Unique identifier for this Payout Request.

reference
string

Reference sent in by merchant to identify Payout Request.

customerId
string

Reference to customer who owns the Payout Target for which the Payout Request was created.

customerDetails
object

Details about the customer who owns the Payout Target for which the Payout Request was created.

payoutTargetId
string

Reference to the Payout Target for which the Payout Request was created.

payoutTargetDetails
object

Details about the Payout Target for which the Payout Request was created.

status
enum<string>

Status of the Payout Request.

Available options:
processing,
approved,
cancelled
statusMessage
enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:
AUTHENTICATION_FAILED,
CUSTOMER_CANCELLATION,
DECLINED_BY_BANK,
EXPIRED,
INVALID_ACCOUNT,
NOT_ENOUGH_FUNDS,
ERROR
amount
number

Amount to send to the customer’s Payout Target.

amountSent
number

Amount sent by Payout Request. Starts at amount and changes to 0 if cancelled.

fee
number

Fee charged for the transaction. This fee will be subtracted from amountCollected at settlement time.

sourceMerchantAccountId
string

Reference to Merchant Account. Safe to ignore if Merchant Accounts are not being used.

createdAt
string

ISO string indicating when the Payout Request was created.

updatedAt
string

ISO string indicating when the Payout Request was last updated.

Get All Payout RequestMerchant Accounts