Skip to main content
GET
/
v1
/
payouts
/
{id}
Get a payout
curl --request GET \
  --url https://api-sandbox.circle.com/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "sourceWalletId": "53535335",
    "destination": {
      "type": "address_book",
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29"
    },
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "toAmount": {
      "amount": "3.14",
      "currency": "ETH"
    },
    "fees": {
      "amount": "3.14",
      "currency": "USD"
    },
    "networkFees": {
      "amount": "0.14",
      "currency": "USD"
    },
    "purposeOfTransfer": "PMT001",
    "status": "pending",
    "errorCode": "transaction_denied",
    "riskEvaluation": {
      "decision": "denied",
      "reason": "4000"
    },
    "externalRef": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906",
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

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

Response

Successfully retrieved a payout.

​
data
object

Payout resource returned by create and get operations. Includes purposeOfTransfer when it was provided at create time (required for CIRCLE_SG entities).