Authorizations

Authorization
string
header
required

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

Body

application/json
amount
integer
required
Required range: x > 0
platform
enum<string>
required
Available options:
ach
user_id
string
required
account_id
string

The user's ACH account ID.

ach_info
object

Specifies the bank account to draw the payment from. This can be used as an alternative to a stored account ID.

customer_id
string
metadata
any

Response

201 - application/json

The transfer object.

amount
number
created
string
external_data
object
id
string
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.

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

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