curl --request GET \
--url https://api.sandbox.z2pay.com/v1/pix-authorizations/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/pix-authorizations/{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/pix-authorizations/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "pxa_j43n74fbt2geb8c1y86ssf6iw",
"customerId": "cust_hqx4mkpi8dcxbrb2nzynxnjky",
"subscriptionId": "sub_m4n6b8v0c2x4z6a8s0d2f4g6h",
"status": "active",
"frequency": "monthly",
"recurrenceBeginningDay": "2026-09-01",
"endDay": null,
"createdAt": "2026-08-31T14:22:05.000Z",
"updatedAt": "2026-08-31T14:24:40.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}Buscar autorização por ID
Retorna o estado atual de uma autorização de Pix Automático — se o pagador já autorizou e se ela está vinculada a uma assinatura.
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/pix-authorizations/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/pix-authorizations/{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/pix-authorizations/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "pxa_j43n74fbt2geb8c1y86ssf6iw",
"customerId": "cust_hqx4mkpi8dcxbrb2nzynxnjky",
"subscriptionId": "sub_m4n6b8v0c2x4z6a8s0d2f4g6h",
"status": "active",
"frequency": "monthly",
"recurrenceBeginningDay": "2026-09-01",
"endDay": null,
"createdAt": "2026-08-31T14:22:05.000Z",
"updatedAt": "2026-08-31T14:24:40.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}GET /pix-authorizations/:id
Faz parte do recurso Pix Automático — a tabela de status e o que produz
cada um estão lá.
Devolve a autorização como ela está agora. O webhook é o caminho principal para saber que o pagador
autorizou ou revogou; esta consulta serve para conferir o estado quando você perdeu um evento ou
precisa decidir algo na hora — por exemplo, antes de criar a assinatura.
404. A autorização pertence à conta da chave que a abriu; fora
dela, o endereço não existe.charge só vem na resposta da
abertura. O primeiro pagamento continua consultável pela
transação de charge.transactionId.Exemplo
curl https://api.sandbox.z2pay.com/v1/pix-authorizations/pxa_j43n74fbt2geb8c1y86ssf6iw \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
{
"id": "pxa_j43n74fbt2geb8c1y86ssf6iw",
"customerId": "cust_hqx4mkpi8dcxbrb2nzynxnjky",
"subscriptionId": "sub_m4n6b8v0c2x4z6a8s0d2f4g6h",
"status": "active",
"frequency": "monthly",
"endDay": null,
"createdAt": "2026-08-31T14:22:05.000Z",
"updatedAt": "2026-08-31T14:24:40.000Z"
}
Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID da autorização (pxa_)
Response
Autorização
ID da autorização (pxa_).
Cliente pagador (cust_). Na resposta da abertura vem nulo quando o pagador foi enviado em customer: o vínculo é preenchido logo depois, e o GET já o traz.
Assinatura que usa esta autorização como forma de pagamento. Nulo até a assinatura ser criada — e para sempre numa autorização que nunca virou assinatura.
Situação da autorização: pending, active, canceled ou expired. canceled e expired são finais.
pending, active, canceled, expired Periodicidade que o pagador autorizou: weekly, monthly, quarterly, semiannual ou annual. Precisa ser a mesma da assinatura.
weekly, monthly, quarterly, semiannual, annual Primeiro dia em que o débito pode acontecer (YYYY-MM-DD), no calendário da sua conta. Na abertura pela API é o dia seguinte — o primeiro pagamento sai na hora, pelo QR.
Último dia de validade (YYYY-MM-DD), resolvido a partir do endDate enviado. Nulo quando a autorização vale até ser encerrada.
Criação, ISO 8601.
Última alteração, ISO 8601.