Skip to main content
POST
Create a BRE-B payout

Authorizations

Authorization
string
header
required

Integration API key. Send as Bearer copby_live_pk_….

Headers

Idempotency-Key
string

Replays the same payout when reused by this integration

Body

application/json
userAddress
string
required
Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x2222222222222222222222222222222222222222"

destinationCop
string
required
Example:

"10000"

breBKey
string
required
accountOwnerName
string
required
fromToken
enum<string>
default:USDC
Available options:
USDC,
COPm
quoteId
string

Response

Prepared payout

payoutId
string
status
string
fromToken
string
sourceAmount
string
fees
object[]
quote
object
receipt
object

Consumer receipt (REQ-INT-RCPT-01). Fees are included in exchangeRate.effectiveUsdCop. Use feesItemized only for partner backoffice / disputes.

deposit
object
transaction
object
feeTransaction
object
destinationPreview
object