Create a payout
Create a stablecoin payout.
To send a fiat payout to a Managed Payments beneficiary, use Create a fiat payout instead. It’s the same POST /v1/payouts endpoint with destination.type set to fiat_address_book.
The following table includes the supported pairs of amount.currency and toAmount.currency for stablecoin address book payouts:
| amount.currency | toAmount.currency |
|---|---|
| USD | USD |
| EUR | EUR |
Required fields depend on your Circle entity; use the request body options that match your integration.
For Singapore (CIRCLE_SG) entities and customers using Managed Payments, purposeOfTransfer is required and must use a payment reason code from Crypto Payouts payment reason codes. Invalid or missing values can return error code 5020.
Authorizations
Body
- General customers
- FR customers
- SG customers
For Circle entities other than CIRCLE_SG.
Payment reason code for the payout. Aligned with Circle payment reason codes for Crypto Payouts. Do not use PMT006. See Crypto Payouts payment reason codes.
Invalid values can return error code 5020.
PMT000, PMT001, PMT002, PMT003, PMT004, PMT005, PMT007, PMT008, PMT009, PMT010, PMT011, PMT012, PMT013, PMT014, PMT015, PMT016, PMT017, PMT018, PMT019, PMT020, PMT021, PMT022, PMT023, PMT024, PMT025, PMT026, PMT027, PMT028, PMT029, PMT030 "PMT001"