Skip to main content
POST
/
v1
/
businessAccount
/
payouts
Create a payout
curl --request POST \
  --url https://api-sandbox.circle.com/v1/businessAccount/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
  "destination": {
    "type": "wire",
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29"
  },
  "amount": {
    "amount": "3.14",
    "currency": "USD"
  },
  "toAmount": {
    "currency": "USD"
  },
  "source": {
    "id": "212000",
    "type": "wallet"
  }
}
'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "sourceWalletId": "53535335",
    "destination": {
      "type": "wire",
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "name": "COMMERZBANK AG ****3000"
    },
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "toAmount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "fees": {
      "amount": "3.14",
      "currency": "USD"
    },
    "status": "pending",
    "trackingRef": "CIR-6ESOQANEP3NAO",
    "errorCode": "insufficient_funds",
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "adjustments": {
      "fxCredit": {
        "amount": "3.14",
        "currency": "USD"
      },
      "fxDebit": {
        "amount": "3.14",
        "currency": "USD"
      }
    },
    "return": {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "payoutId": "abdb500d-4a59-457c-801f-2d418c8703ac",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "reason": "payout_returned",
      "status": "pending",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    },
    "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.

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

​
amount
object
required
​
toAmount
object

To be used when requesting currency exchange

​
source
object

The source wallet to pay out from. If not provided, the deposit will come from the main wallet of the account.

You can get wallet IDs associated with your account using the Core API for Institutions.

Response

Successfully created a payout.

​
data
object