API Reference

Create a payout

posthttps://api-sandbox.circle.com/v1/businessAccount/payouts

Reference
Playground

Create a payout.

The following table includes the supported pairs of amount.currency and toAmount.currency for FX payouts:

amount.currency	toAmount.currency
USD	BRL

amount.currency

toAmount.currency

USD

BRL

Body parameters

amount

object

Required

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDEURMXNSGDBRL

destination

object

Required

The destination bank account.

Show 2 properties

type

string

Required

Allowed valueswirecubixpixsepasepa_instant

string

Required

Unique system generated identifier for the entity.

idempotencyKey

string

Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

toAmount

object

To be used when requesting currency exchange

Show 2 properties

amount

string

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDEURMXNSGDBRL

Response

201CreateBusinessPayoutResponse

Response Body

object

data

object

Show 14 properties

string

Unique system generated identifier for the entity.

sourceWalletId

string

The identifier of the source wallet used to fund a payout.

destination

object

The destination bank account.

Show 3 properties

type

string

Required

The destination bank account type.

Allowed valueswirecubix

string

Required

Unique system generated identifier for the entity.

name

string

Bank name plus last four digits of the bank account number or IBAN.

amount

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDEURMXNSGDBRL

toAmount

object

Show 2 properties

amount

string

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDEURMXNSGDBRL

fees

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

status

string

Status of the payout. Status pending indicates that the payout is in process; complete indicates it finished successfully; failed indicates it failed.

Allowed valuespendingcompletefailed

trackingRef

string

A payout tracking reference. Will be present once known.

errorCode

string

Indicates the failure reason of a payout. Only present for payouts in failed state. Possible values are [insufficient_funds, transaction_denied, transaction_failed, transaction_returned, bank_transaction_error, fiat_account_limit_exceeded, invalid_bank_account_number, invalid_ach_rtn, invalid_wire_rtn, vendor_inactive]'

Allowed valuesinsufficient_fundstransaction_deniedtransaction_failedtransaction_returnedbank_transaction_errorfiat_account_limit_exceededinvalid_bank_account_numberinvalid_ach_rtninvalid_wire_rtnvendor_inactive

riskEvaluation

object

Results of risk evaluation. Only present if the payment is denied by Circle's risk service.

Show 2 properties

decision

string

Enumerated decision of the account.

Allowed valuesapproveddeniedreview

reason

string

Risk reason for the definitive decision outcome.

adjustments

object

Final adjustment which increases (credits) or decreases (debits) the total returned amount to the source wallet.

Show 2 properties

fxCredit

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

fxDebit

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

return

object

Return information if the payout is returned by bank. Only present if errorCode of payout is transaction_returned.

Show 8 properties

string

Unique system generated identifier for the entity.

payoutId

string

Universally unique identifier (UUID v4) of the payout that is associated with the return.

amount

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

fees

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

reason

string

Reason for the return.

status

string

Status of the return. A pending status indicates that the return is in process; complete indicates it finished successfully; failed indicates it failed.

Allowed valuespendingcompletefailed

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

400BadRequest

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "sourceWalletId": "53535335",
5    "destination": {
6      "type": "wire",
7      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
8      "name": "COMMERZBANK AG ****3000"
9    },
10    "amount": {
11      "amount": "3.14",
12      "currency": "USD"
13    },
14    "toAmount": {
15      "amount": "3.14",
16      "currency": "USD"
17    },
18    "fees": {
19      "amount": "3.14",
20      "currency": "USD"
21    },
22    "status": "pending",
23    "trackingRef": "CIR-6ESOQANEP3NAO",
24    "errorCode": "insufficient_funds",
25    "riskEvaluation": {
26      "decision": "approved",
27      "reason": "3000"
28    },
29    "adjustments": {
30      "fxCredit": {
31        "amount": "3.14",
32        "currency": "USD"
33      },
34      "fxDebit": {
35        "amount": "3.14",
36        "currency": "USD"
37      }
38    },
39    "return": {
40      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
41      "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
42      "amount": {
43        "amount": "3.14",
44        "currency": "USD"
45      },
46      "fees": {
47        "amount": "3.14",
48        "currency": "USD"
49      },
50      "reason": "payout_returned",
51      "status": "pending",
52      "createDate": "2020-04-10T02:13:30.000Z",
53      "updateDate": "2020-04-10T02:13:30.000Z"
54    },
55    "createDate": "2020-04-10T02:13:30.000Z",
56    "updateDate": "2020-04-10T02:13:30.000Z"
57  }
58}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy