Authorizations

​
Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
transfer_id
string
required

ID of the transfer to retrieve

Response

200 - application/json

The transfer object.

​
id
string
​
created
string
​
user_id
string
​
status
enum<string>
Available options:
created,
pending,
failed,
completed,
reversed,
canceled,
flagged
​
type
enum<string>
Available options:
refill,
payout,
balance
​
amount
number
​
external_data
object
​
transactions
object[]
​
payout_link_id
string

ID of the payout-link that the transfer belongs to.

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

Create an Organization TransferList all Flows