Create a payout

amount.currency	toAmount.currency
USD	USD
EUR	EUR

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

idempotencyKey

string<uuid>

required

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

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

destination

object

required

The destination.

Show child attributes

destination.type

enum<string>

required

The destination type.

Available options:

address_book

destination.id

string<uuid>

required

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

amount

object

required

Show child attributes

amount.amount

string

required

The numeric value of the amount, expressed in units of the specified currency. Use a period (.) as the decimal separator.

Example:

"3.14"

amount.currency

enum<string>

required

The ISO 4217 currency code for the amount.

Available options:

USD,

EUR

source

object

A source wallet location.

Show child attributes

source.type

enum<string>

required

Available options:

wallet

source.id

string

required

The id of the wallet.

Example:

"12345"

source.identities

object[]

Show child attributes

source.identities.type

enum<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.

Available options:

individual,

business

source.identities.name

string

required

Full name of the identity.

Maximum string length: 1024

Example:

"Satoshi Nakamoto"

source.identities.addresses

object[]

required

Show child attributes

source.identities.addresses.line1

string

required

Line one of the street address.

Maximum string length: 1024

Example:

"100 Money Street"

source.identities.addresses.city

string

required

City portion of the address.

Maximum string length: 1024

Example:

"Boston"

source.identities.addresses.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.

Maximum string length: 16

Example:

"MA"

source.identities.addresses.postalCode

string

required

Postal / ZIP code of the address.

Maximum string length: 16

Example:

"01234"

source.identities.addresses.country

string

required

Country portion of the address. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Maximum string length: 2

Example:

"US"

source.identities.addresses.line2

string

Line two of the street address.

Maximum string length: 1024

Example:

"Suite 1"

toAmount

object

Show child attributes

toAmount.amount

string

required

The numeric value of the amount, expressed in units of the specified currency. Use a period (.) as the decimal separator.

Example:

"3.14"

toAmount.currency

enum<string>

required

The ISO 4217 currency code for the amount.

Available options:

USD,

EUR

Response

Successfully created a payout.

data

object

Show child attributes

data.id

string<uuid>

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.sourceWalletId

string

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

Example:

"53535335"

data.destination

object

The destination.

Show child attributes

data.destination.type

enum<string>

required

The destination type.

Available options:

address_book

data.destination.id

string<uuid>

required

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.amount

object

Show child attributes

data.amount.amount

string

required

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

Example:

"3.14"

data.amount.currency

enum<string>

required

Currency code for the amount.

Available options:

USD,

EUR,

BTC,

ETH,

MTC,

FLW,

MAN

data.toAmount

object

Show child attributes

data.toAmount.amount

string

required

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

Example:

"3.14"

data.toAmount.currency

enum<string>

required

Currency code for the amount.

Available options:

USD,

EUR,

BTC,

ETH,

MTC,

FLW,

MAN

data.fees

object

Show child attributes

data.fees.amount

string

required

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

Example:

"3.14"

data.fees.currency

enum<string>

required

Currency code for the amount.

Available options:

USD,

EUR,

BTC,

ETH,

MTC,

FLW,

MAN

data.networkFees

object

Show child attributes

data.networkFees.amount

string

required

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

Example:

"3.14"

data.networkFees.currency

enum<string>

required

Currency code for the amount.

Available options:

USD,

EUR,

BTC,

ETH,

MTC,

FLW,

MAN

data.status

enum<string>

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

Available options:

pending,

complete,

failed

data.errorCode

enum<string> | null

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]'

Available options:

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

data.riskEvaluation

object

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

Show child attributes

data.riskEvaluation.decision

enum<string>

Enumerated decision of the account.

Available options:

approved,

denied,

review

data.riskEvaluation.reason

string | null

Risk reason for the definitive decision outcome.

Example:

"3000"

data.createDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.updateDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

Core API

API Overview

Core API for Institutions

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Authorizations

Body

Response