v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Payout

Creates a Payout resource.

post/payouts

Request body

idstring

Unique identifier for payout note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

amountinteger

The amount to be transferred to a bank account or debit card in cents e.g. 74753

arrivalDatestring nullable

The date and time the payout is expected to arrive in the bank e.g. "2020-11-03T02:17:40.080Z"

automaticstring nullable

Whether the payout was created by an automated payout schedule or not e.g. "true"

balanceTransactionIdstring nullable

The ID of the balance transaction that describes the impact of this payout on the account balance e.g. "7464"

createdstring nullable

The date and time this payout was created e.g. "2020-11-03"

currencystring nullable

Currency the payout is made in e.g. "USD"

payoutDescriptionstring nullable

A description of the payout e.g. "Payout description"

destinationIdstring nullable

The ID of the bank account or card the payout is sent to e.g. "44"

failureBalanceTransactionIdstring nullable

The ID of the balance transaction if the payout failed or cancelled e.g. "py_1L9D8G2eZgTElo2CaKQjce77"

failureCodestring nullable

Error code explaining reason for payout failure.

failureMessagestring nullable

Message to user further explaining reason for payout failure e.g. "payment failed"

methodstring nullable

Method used to send this payout e.g. "Standard" e.g. "Instant" e.g. "Standard"

sourceTypestring nullable

The source balance this payout came from e.g. "card" e.g. "bank_account"

statusstring nullable

Current status of the payout e.g. "paid" e.g. "pending"

payoutTypestring nullable

Type of payout e.g. "bank_account" e.g. "card"

Example request

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  "amount": 74753,
  "arrivalDate": "2020-11-03T02:17:40.080Z",
  "automatic": "true",
  "balanceTransactionId": "7464",
  "created": "2020-11-03",
  "currency": "USD",
  "payoutDescription": "Payout description",
  "destinationId": "44",
  "failureBalanceTransactionId": "py_1L9D8G2eZgTElo2CaKQjce77",
  "failureCode": "error 43",
  "failureMessage": "payment failed",
  "method": "Standard",
  "sourceType": "card",
  "status": "pending",
  "payoutType": "card"
}

Response

Payout resource created