Create Exchange Cashout

Create an exchange cashout order.

Endpoint

POST /cashout/exchange/pay-for-pix-key

Authentication

Merchant Credential. See Authentication.

Important Notes

WARNING

Note: If the API times out or returns a non-200 HTTP status, you must query order status via Check Exchange Cashout

Request headers

Name	In	Type	Required	Description	Example
Content-Type	header	string	Yes		application/json
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Request body

Field	Type	Required	Description
amount	number	Yes	Amount — Supports up to 2 decimal places (min=10; max=50000)
mchOrderNo	string	Yes	Merchant order number — Merchant order number; allows A-Za-z0-9|_|- (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})
key	string	Yes	Account — Format differs by pixKey type CPF：^\d{11}$ CNPJ：^\d{14}$ EVP：[1]{8}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{12}$ PHONE：^+55\d{11}$ EMAIL：[2]+@[A-Za-z0-9-]+(?:.[A-Za-z0-9-]+)+$
confirmAmt	number	Yes	Confirmed exchange amount
settlement	string	Yes	Settlement cycle
pair	string	Yes	Pair type
priceId	string	Yes	Exchange rate version ID

Request example

{
  "mchOrderNo": "payout_16622125006",
  "key": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/da6433a8-1c96-49c7-a3b0-91846b2a0f375204000053039865802BR5925WR COMERCIO E INDUSTRIA D6009SAO PAULO62070503***6304F644",
  "amount": 521,
  "confirmAmt": 100,
  "settlement": "T0",
  "pair": "USDT_BRL",
  "priceId": 12
}

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes
msg	null	Yes
data	object	Yes

data fields

Field	Type	Required	Description
mchOrderNo	string	Yes
platOrderNo	string	Yes
applyTime	integer	Yes
amount	integer	Yes
receivedAmount	integer	Yes
orderStatus	string	Yes
priceId	integer	Yes
settlement	string	Yes
price	number	Yes
confirmAmt	integer	Yes
pair	string	Yes

Response example

{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "payout_16622125006",
    "platOrderNo": "PO_250508VcTNg0zWbfj9H312ccFQ",
    "applyTime": 16622125006,
    "amount": 521,
    "receivedAmount": 521,
    "orderStatus": "PENDING",
    "priceId": 12,
    "settlement": "T0",
    "price": 5.21,
    "confirmAmt": 100,
    "pair": "USDT_BRL"
  }
}

---

1. 0-9 a-z ↩︎

2. A-Za-z0-9.!#$%&'*+/=?^_`{|}~- ↩︎