We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Create a payout
POSThttps://api.circle.com/v1/payouts
Create a crypto payout.
The following table includes the supported pairs of amount.currency and toAmount.currency for address book payouts:
| amount.currency | toAmount.currency |
|---|---|
| USD | USD |
| USD | BTC |
| USD | ETH |
| USD | MTC |
| EUR | EUR |
| BTC | USD |
| BTC | BTC |
| ETH | USD |
| ETH | ETH |
Body parameters
amount
object
Required
destination
object
Required
The destination.
idempotencyKey
uuid
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
source
object
A source wallet location.
toAmount
object
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "sourceWalletId": "53535335",
5 "destination": {
6 "type": "address_book",
7 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29"
8 },
9 "amount": {
10 "amount": "3.14",
11 "currency": "USD"
12 },
13 "toAmount": {
14 "amount": "3.14",
15 "currency": "USD"
16 },
17 "fees": {
18 "amount": "3.14",
19 "currency": "USD"
20 },
21 "networkFees": {
22 "amount": "3.14",
23 "currency": "USD"
24 },
25 "status": "pending",
26 "errorCode": "insufficient_funds",
27 "riskEvaluation": {
28 "decision": "approved",
29 "reason": "3000"
30 },
31 "createDate": "2020-04-10T02:13:30.000Z",
32 "updateDate": "2020-04-10T02:13:30.000Z"
33 }
34}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
