Create a payout

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.

Headers

Straddle-Account-Id

string

For use by platforms to specify an account id and set scope of a request.

Request-Id

string

Optional client generated identifier to trace and debug a request.

Correlation-Id

string

Optional client generated identifier to trace and debug a series of requests.

Body

paykey

string

required

Paykey.

description

string

required

Description.

amount

integer

required

Amount.

currency

string

required

Currency.

payment_date

string

required

Payment date.

Available options:

internet,

signed

device

object

required

external_id

string

required

External id.

config

object

required

metadata

object | null

Metadata.

Response

201

text/plain

Created

meta

object

required

response_type

enum<string>

required

Available options:

object,

array,

error,

none

data

object

required

data.id

string

required

Id.

data.paykey

string

required

Paykey.

data.description

string

required

Description.

data.amount

integer

required

Amount.

data.currency

string

required

Currency.

data.payment_date

string

required

Payment date.

Available options:

internet,

signed

data.device

object

required

data.external_id

string

required

External id.

data.config

object

required

data.status

enum<string>

required

Available options:

created,

scheduled,

failed,

cancelled,

on_hold,

pending,

paid,

reversed

data.status_details

object

required

data.status_history

object[]

required

Status history.

data.payment_rail

enum<string>

Available options:

ach

data.customer_details

object

data.paykey_details

object

data.created_at

string | null

Created at.

data.updated_at

string | null

Updated at.

data.processed_at

string | null

Processed at.

data.effective_at

string | null

Effective at.

data.metadata

object | null

Metadata.

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Authorizations

Headers

Body

Response