Skip to content

Query PIX Out Proof

Query proof / receipt for a PIX payout.

Endpoint

GET /cashout/pix/proof

Authentication

Merchant Credential. See Authentication.

Request headers

NameInTypeRequiredDescriptionExample
X-NonceheaderstringYesa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-IdheaderstringYes2492265300
X-TimestampheaderstringYes1638123456
DigestheaderstringYesSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringYesSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Query parameters

NameInTypeRequiredDescriptionExample
mchOrderNoquerystringNoMerchant order numberorder_{{$date.timestamp}}

Response

HTTP 200 — Success

FieldTypeRequiredDescription
statusintegerYesStatus
msgnullYesMessage
dataobjectYes

data fields

FieldTypeRequiredDescription
mchOrderNostringYesMerchant order number
platOrderNostringYesPlatform order number
proofUrlstringYesProof page URL