Create a payout
posthttps://api-sandbox.circle.com/v1/payouts
- Reference
- Playground
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
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code for the amount.
Allowed valuesUSDEURBTCETH
destination
object
Required
The destination.
type
string
Required
The destination type.
Allowed valuesaddress_book
id
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.
source
object
A source wallet location.
type
string
Required
Allowed valueswallet
id
string
Required
The id of the wallet.
identities
array of objects
type
string
Required
The type of identity for the originator.
individual- A uniquely distinguishable individual.business- Any entity other than a natural person that can establish a permanent customer relationship with an affected entity or otherwise own property. This can include companies, foundations, anstalt, partnerships, associations and other relevantly similar entities.
Allowed valuesindividualbusiness
name
string
Required
Full name of the identity.
addresses
array of objects
Required
line1
string
Required
Line one of the street address.
line2
string
Line two of the street address.
city
string
Required
City portion of the address.
district
string
Required
State / County / Province / Region portion of the address. If the country is US or Canada, then district is required and should use the two-letter code for the subdivision.
postalCode
string
Required
Postal / ZIP code of the address.
country
string
Required
Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.
toAmount
object
currency
string
Required
Currency code for the amount.
Allowed valuesUSDEURBTCETHMTC
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-2025 Circle Technology Services, LLC. All rights reserved.
