Skip to main content
POST
/
v1
/
pix
/
cashout
/
consult
Consultar status de um pagamento PIX (cash-out)
curl --request POST \
  --url https://api.paysurebr.com/v1/pix/cashout/consult \
  --header 'Content-Type: application/json' \
  --header 'ci: <api-key>' \
  --data '
{
  "reference_code": "<string>"
}
'
{
  "cashout": {
    "reference_code": "<string>",
    "external_reference": "<string>",
    "end_to_end": "<string>",
    "occurred_at": "2023-11-07T05:31:56Z"
  }
}
Consulta status de um pagamento PIX (cash-out) usando o reference_code retornado quando você criou o pagamento.
Confie no webhook como fonte primária. Esta rota serve para reconciliação manual.

Authorizations

ci
string
header
required

Autenticação por par client-credentials. Envie dois headers em toda requisição:

  • ci: client_id (público)
  • cs: client_secret (privado — nunca exponha no frontend)

Gere as credenciais no painel da Paysure em API Keys. Você pode ter múltiplas chaves ativas.

Body

application/json
reference_code
string
required

Response

Status do cash-out

cashout
object