Get a payout

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved 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 bank account.

Show child attributes

data.destination.type

enum<string>

required

The destination bank account type.

Available options:

wire,

cubix

data.destination.id

string<uuid>

required

Unique system generated identifier for the entity.

Example:

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

data.destination.name

string

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

Example:

"COMMERZBANK AG ****3000"

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.

Available options:

USD,

EUR,

MXN,

SGD,

BRL

data.toAmount

object

Show child attributes

data.toAmount.currency

enum<string>

required

Currency code.

Available options:

USD,

EUR,

MXN,

SGD,

BRL

data.toAmount.amount

string

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

Example:

"3.14"

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.

Available options:

USD

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

string | null

A payout tracking reference. Will be present once known.

Example:

"CIR-6ESOQANEP3NAO"

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

object

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

Show child attributes

data.adjustments.fxCredit

object

Show child attributes

data.adjustments.fxCredit.amount

string

required

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

Example:

"3.14"

data.adjustments.fxCredit.currency

enum<string>

required

Currency code.

Available options:

USD

data.adjustments.fxDebit

object

Show child attributes

data.adjustments.fxDebit.amount

string

required

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

Example:

"3.14"

data.adjustments.fxDebit.currency

enum<string>

required

Currency code.

Available options:

USD

data.return

object

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

Show child attributes

data.return.id

string<uuid>

Unique system generated identifier for the entity.

Example:

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

data.return.payoutId

string<uuid>

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

Example:

"abdb500d-4a59-457c-801f-2d418c8703ac"

data.return.amount

object

Show child attributes

data.return.amount.amount

string

required

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

Example:

"3.14"

data.return.amount.currency

enum<string>

required

Currency code.

Available options:

USD

data.return.fees

object

Show child attributes

data.return.fees.amount

string

required

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

Example:

"3.14"

data.return.fees.currency

enum<string>

required

Currency code.

Available options:

USD

data.return.reason

string

Reason for the return.

Example:

"payout_returned"

data.return.status

enum<string>

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

Available options:

pending,

complete,

failed

data.return.createDate

string

ISO-8601 UTC date/time format.

Example:

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

data.return.updateDate

string

ISO-8601 UTC date/time format.

Example:

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

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

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Authorizations

Path Parameters

Response