Get a Pix Automático Charge

Retrieve a single charge by id. Scoped to the authenticated payer. The response carries the sanitized attempts array; the internal debit result code is never exposed.

GET /v1/recurrences/payer/charges/{id}

Get a Pix Automático Charge

cURL

curl --request GET \
  --url https://api.example.com/v1/recurrences/payer/charges/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": "29.90",
  "attemptCount": 1,
  "attempts": [
    {
      "dayIndex": 0,
      "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "scheduledFor": "2026-04-24T03:00:00Z",
      "attemptedAt": "2023-11-07T05:31:56Z",
      "endToEndId": "E30306294202606241200abcdef00001",
      "failureCode": "DEBIT_FAILED",
      "failureMessage": "The debit attempt could not be completed.",
      "outcome": "EXECUTED"
    }
  ],
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "createdAt": "2023-11-07T05:31:56Z",
  "dueDate": "2026-04-25",
  "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J4",
  "maxAttempts": 4,
  "status": "SCHEDULED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "currentDayIndex": 0,
  "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "executedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "failureCode": "CHARGE_REJECTED",
  "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID (UUID format)

Parámetros de ruta

id · string<uuid> · requerido

Charge ID (UUID format)

Respuesta

200

application/json

OK

accountId · string · requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

amount · string · requerido

Ejemplo:

"29.90"

attemptCount · integer<int64> · requerido

Ejemplo:

1

attempts · object[] · requerido

Show child attributes

authorizationRequestId · string · requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

createdAt · string<date-time> · requerido

dueDate · string<date> · requerido

Ejemplo:

"2026-04-25"

externalChargeId · string · requerido

Ejemplo:

"90d0b9e1551447f695985409bf9b7fb5"

id · string · requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

journey · enum<string> · requerido

Opciones disponibles: J1, J2, J3, J4

Ejemplo:

"J4"

maxAttempts · integer<int64> · requerido

Ejemplo:

4

status · enum<string> · requerido

Opciones disponibles: RECEIVED, SCHEDULED, EXECUTED, FAILED, CANCELLED

Ejemplo:

"SCHEDULED"

updatedAt · string<date-time> · requerido

authorizationId · string

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

cancelledAt · string<date-time>

currentDayIndex · integer<int64>

Ejemplo:

0

currentScheduleId · string

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

executedAt · string<date-time>

failedAt · string<date-time>

failureCode · string

Ejemplo:

"CHARGE_REJECTED"

recurrenceId · string

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"