We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Create a payout
POSThttps://api.circle.com/v1/businessAccount/payouts
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 |
Body parameters
amount
object
Required
destination
object
Required
The destination bank account.
idempotencyKey
uuid
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
Response
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 "errorCode": "insufficient_funds",
24 "riskEvaluation": {
25 "decision": "approved",
26 "reason": "3000"
27 },
28 "adjustments": {
29 "fxCredit": {
30 "amount": "3.14",
31 "currency": "USD"
32 },
33 "fxDebit": {
34 "amount": "3.14",
35 "currency": "USD"
36 }
37 },
38 "return": {
39 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
40 "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
41 "amount": {
42 "amount": "3.14",
43 "currency": "USD"
44 },
45 "fees": {
46 "amount": "3.14",
47 "currency": "USD"
48 },
49 "reason": "payout_returned",
50 "status": "pending",
51 "createDate": "2020-04-10T02:13:30.000Z",
52 "updateDate": "2020-04-10T02:13:30.000Z"
53 },
54 "createDate": "2020-04-10T02:13:30.000Z",
55 "updateDate": "2020-04-10T02:13:30.000Z"
56 }
57}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
