Create PIX Out

Create a PIX payout order.

Endpoint

POST /cashout/pix/create

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 Pix Out

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})
document	string	No	Tax ID: CPF for individuals, CNPJ for companies — This field must be real and valid
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-]+)+$

Request example

{
  "mchOrderNo": "payout_16622125006",
  "key": "test@gmail.com",
  "amount": 180.5,
  "document": "45920019932"
}

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes	Status — 200 success
msg	string|null	Yes	Message
data	object	Yes

data fields

Field	Type	Required	Description
applyTime	integer	Yes	Application time
amount	number	Yes	Order amount
platOrderNo	string	Yes	Platform order number
mchOrderNo	string	Yes	Merchant order number
orderStatus	string	Yes	Order status (enum=SUCCESS, FAILED, PENDING, REFUND)
receivedAmount	number	Yes	Amount credited

Response example

{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "payout_1662104438",
    "platOrderNo": "wussXUCOoXO3yptr7rQV",
    "applyTime": 1662104742,
    "amount": 180.34,
    "receivedAmount": 0,
    "orderStatus": "PENDING"
  }
}

---

1. 0-9 a-z ↩︎

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