Developer docs
/
Rebilly API
/
Transactions
/
Retrieve a payout request

Retrieve a payout request

Retrieves a payout request with a specified ID.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

get
/payout-requests/{id}
Responses

200

Payout request retrieved.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID.

websiteId
required
string (WebsiteId) <= 50 characters
customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

paymentInstrumentId
string or null <= 50 characters

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

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Amount of the payout.

availableAmount
number <double>

Available payout request amount that has not been allocated.

description
string or null

Description of payout request.

status
string

Status of the request.

Enum Value 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.

canceled

Request is canceled by merchant or customer.

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.

selectedPaymentInstrumentRedirectUrl
string <uri>

URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.

object or null (PayoutRequestCancellation)

Reason the payout request is canceled.

createdTime
string <date-time> (ServerTimestamp)

Read-only timestamp in ISO 8601 date-time format.

updatedTime
string <date-time> (UpdatedTime)

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

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
{
"id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80",
"websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
"currency": "USD",
"amount": 0.1,
"availableAmount": 0.1,
"description": "string",
"status": "pending",
"selectPaymentInstrumentUrl": "http://example.com",
"allocations": [

],
"selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}",
"cancellationReason": {
"canceledBy": "merchant",
"description": "string"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"_links": [

]
}