curl --request GET \
--url https://api.sandbox.z2pay.com/v1/refunds/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/refunds/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/refunds/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "rfd_j3cpkaysqmix17mxhcmv8qypl",
"transactionId": "txn_aqbcw2lky42xfidw5pcdss8h1",
"paymentId": "pay_jxt9b5qv1x0h0h8ustleqjgr8",
"amount": 14990,
"currency": "BRL",
"status": "pending",
"reason": "Cliente solicitou cancelamento da compra",
"requestedByType": "api",
"paymentMethod": "credit_card",
"customerId": "cust_lhsmn6ugmjotm5qvnunrr2hz1",
"customerName": "Maria Silva",
"customerEmail": "maria.silva@example.com",
"customerDocument": "12345678909",
"customerDocumentType": "cpf",
"additionalInfo": {
"checkoutLinkId": "chk_byd8p3p79re859jpkmr0j65n3"
},
"failureReason": null,
"reviewedAt": null,
"refundedAt": null,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Refund not found"
}
}Buscar reembolso por ID
Retorna um reembolso específico pelo seu ID, com o estado atual e as datas do ciclo.
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/refunds/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/refunds/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/refunds/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "rfd_j3cpkaysqmix17mxhcmv8qypl",
"transactionId": "txn_aqbcw2lky42xfidw5pcdss8h1",
"paymentId": "pay_jxt9b5qv1x0h0h8ustleqjgr8",
"amount": 14990,
"currency": "BRL",
"status": "pending",
"reason": "Cliente solicitou cancelamento da compra",
"requestedByType": "api",
"paymentMethod": "credit_card",
"customerId": "cust_lhsmn6ugmjotm5qvnunrr2hz1",
"customerName": "Maria Silva",
"customerEmail": "maria.silva@example.com",
"customerDocument": "12345678909",
"customerDocumentType": "cpf",
"additionalInfo": {
"checkoutLinkId": "chk_byd8p3p79re859jpkmr0j65n3"
},
"failureReason": null,
"reviewedAt": null,
"refundedAt": null,
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Refund not found"
}
}GET /refunds/:id
Faz parte do recurso Reembolsos — o objeto, os status e o ciclo estão lá.Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do refund
Response
Dados do refund
Identificador único do registro.
ID da transação relacionada ao registro.
ID do pagamento relacionado ao registro.
Valor em centavos.
Moeda no padrão ISO 4217 (ex.: BRL).
Situação do reembolso. Valores: pending, approved, processing, refunded, refused, failed, awaiting_bank_details, bank_details_received, invalid_bank_details, ted_processing.
Motivo informado para a operação.
Origem da solicitação: api, admin, customer ou gateway.
Forma de pagamento (ex.: credit_card, pix, boleto).
Comprador da venda estornada (cust_), copiado da transação quando o estorno é criado. Nulo quando a transação não tem cliente.
Nome do comprador quando o estorno foi criado.
E-mail do comprador quando o estorno foi criado.
Documento do comprador (CPF ou CNPJ) quando o estorno foi criado.
Tipo do documento do comprador: cpf ou cnpj.
Vínculo com a venda de origem, copiado da transação quando o estorno é criado. Nulo quando a venda foi criada direto pela API, sem link de checkout.
Show child attributes
Show child attributes
Motivo da falha do processamento.
Data e hora em que a solicitação foi revisada (ISO 8601).
Data e hora em que o estorno foi concluído (ISO 8601).
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).