payout-requests
Retrieve a Payout Request
payout-requests
Retrieve a Payout Request
Get a payout request by its id.
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
payout_request_id
string
requiredId of the payout request
Response
200 - application/json
The payout-request id.
id
string
ID of the payout-request.
created
string
Date that the payout-request was created.
amount
number
Amount in cents of the payout-request.
status
enum<string>
Status of the payout-request.
Available options:
created, approved, rejected payee
object
payout-link
object
The payout-link that was sent when the payout-request was approved.
user
object
The user that requested the payout.
metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
memo
string