logo

Retrieve a payout request

Retrieves a payout request with a specified ID.

SecurityCustomerJWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Payout request retrieved.

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

Unique resource ID. Defaults to UUID v4.

websiteId
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.

paymentInstrumentId
string

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

currency
string = 3 characters

Currency of the payout.

amount
number <double>

Amount of the payout.

status
string

Status of the request.

Enum: Description
pending

Request 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.

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

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "paymentInstrument"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/payout-requests/{id}
Request samples 
Response samples 
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "websiteId": "example.com",
  • "paymentInstrumentId": "string",
  • "currency": "USD",
  • "amount": 0,
  • "status": "pending",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Update a payout request