Create a Payment

Authorizations

Authorization

string

headerrequired

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

Body

application/json

user_id

string

required

amount

integer

required

Required range: x > 0

platform

enum<string>

required

Available options:

ach

customer_id

string

ach_info

object

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

account_id

string

The user's ACH account ID.

metadata

any

Response

201 - application/json

The transfer object.

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[]

transactions.id

integer

transactions.amount

number

transactions.created

string

transactions.source_name

string

transactions.destination_name

string

transactions.type

enum<string>

The general category of the transaction

Available options:

balance,

refill,

payout,

payment,

fee,

surrogate

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

transactions.transfer_id

string

ID of the transfer that the transaction belongs to.

transactions.transfer

object

The transfer that the transaction belongs to. This is only present if include_transfer is true.

transactions.transfer.id

string

transactions.transfer.created

string

transactions.transfer.user_id

string

transactions.transfer.status

enum<string>

Available options:

created,

pending,

failed,

completed,

reversed,

canceled,

flagged

transactions.transfer.type

enum<string>

Available options:

refill,

payout,

balance

transactions.transfer.amount

number

transactions.transfer.external_data

object

transactions.transfer.transactions

object[]

transactions.transfer.payout_link_id

string

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

transactions.transfer.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.

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.

Overview

Guides

References

Create a Payment

Authorizations

Body

Response