API Reference
Start typing to search…

Pix Automatic Webhooks


eventType

Type of notificationDescription
pix_automatic_authorization_authorizedThe authorization for automatic pix is ok.
pix_automatic_authorization_rejectedThe authorization for automatic pix is rejected.
pix_automatic_authorization_expiredThe authorization for automatic pix is expired.
pix_automatic_authorization_cancelledThe authorization for automatic pix is cancelled.
pix_automatic_scheduling_successThe automatic scheduling was completed successfully.
pix_automatic_scheduling_failedThe automatic scheduling was failed.
pix_automatic_scheduling_cancelledThe automatic scheduling was cancelled.
pix_automatic_transaction_successThe transaction for automatic scheduling was completed successfully

Payload examples

pix_automatic_authorization_authorized

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_authorization_authorized",
  "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
  "pixAutomaticAuthorization": {
    "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
    "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
    "receiverPixKey": "48175416000177",
    "descriptionToPayer": "Descrição para o pagador",
    "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
    "payer": {
      "name": "My Name",
      "cpfCnpj": "53933755069"
    },
    "firstPayment": {
      "immediateChargeAmount": 1
    },
    "additionalInformation": [
      {
        "name": "Informação",
        "content": "Informação adicional"
      }
    ],
    "restrict": {
      "cpfCnpj": [
        "14518139453"
      ],
      "bankAccounts": [
        {
          "ispb": "00360305",
          "branchCode": "2348",
          "accountNumber": "12880008028898473",
          "accountType": "SVGS",
          "cpfCnpj": "14518139453"
        }
      ]
    },
    "recurrence": {
      "recurrenceId": "RR3098053920250807f27fe4ddd39 ",
      "status": "AUTHORIZED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
			"amount": 1,
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_authorization_rejected

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_authorization_rejected",
  "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
  "pixAutomaticAuthorization": {
    "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
    "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
    "receiverPixKey": "48175416000177",
    "descriptionToPayer": "Descrição para o pagador",
    "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
    "payer": {
      "name": "My Name",
      "cpfCnpj": "53933755069"
    },
    "firstPayment": {
      "immediateChargeAmount": 1
    },
    "additionalInformation": [
      {
        "name": "Informação",
        "content": "Informação adicional"
      }
    ],
    "restrict": {
      "cpfCnpj": [
        "14518139453"
      ],
      "bankAccounts": [
        {
          "ispb": "00360305",
          "branchCode": "2348",
          "accountNumber": "12880008028898473",
          "accountType": "SVGS",
          "cpfCnpj": "14518139453"
        }
      ]
    },
    "recurrence": {
      "recurrenceId": "RR3098053920250807f27fe4ddd39 ",
      "status": 'REJECTED',
      "error": 'AG03',
      "errorDescription": 'Transaction type is not authorized for receiver bank account.',
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "amount": 1,
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_authorization_expired

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_authorization_expired",
  "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
  "pixAutomaticAuthorization": {
    "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
    "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
    "receiverPixKey": "48175416000177",
    "descriptionToPayer": "Descrição para o pagador",
    "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
    "payer": {
      "name": "My Name",
      "cpfCnpj": "53933755069"
    },
    "firstPayment": {
      "immediateChargeAmount": 1
    },
    "additionalInformation": [
      {
        "name": "Informação",
        "content": "Informação adicional"
      }
    ],
    "restrict": {
      "cpfCnpj": [
        "14518139453"
      ],
      "bankAccounts": [
        {
          "ispb": "00360305",
          "branchCode": "2348",
          "accountNumber": "12880008028898473",
          "accountType": "SVGS",
          "cpfCnpj": "14518139453"
        }
      ]
    },
    "recurrence": {
      "recurrenceId": "RR3098053920250807f27fe4ddd39 ",
      "status": 'EXPIRED',
      "error": 'AP07',
      "errorDescription": 'The authorization has expired',
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "amount": 1,
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_authorization_cancelled

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_authorization_expired",
  "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
  "pixAutomaticAuthorization": {
    "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
    "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
    "receiverPixKey": "48175416000177",
    "descriptionToPayer": "Descrição para o pagador",
    "externalId": "1d591505-96a1-4427-bbd1-7a6520162c90",
    "payer": {
      "name": "My Name",
      "cpfCnpj": "53933755069"
    },
    "firstPayment": {
      "immediateChargeAmount": 1
    },
    "additionalInformation": [
      {
        "name": "Informação",
        "content": "Informação adicional"
      }
    ],
    "restrict": {
      "cpfCnpj": [
        "14518139453"
      ],
      "bankAccounts": [
        {
          "ispb": "00360305",
          "branchCode": "2348",
          "accountNumber": "12880008028898473",
          "accountType": "SVGS",
          "cpfCnpj": "14518139453"
        }
      ]
    },
    "recurrence": {
      "recurrenceId": "RR3098053920250807f27fe4ddd39 ",
      "status": 'CANCELLED',
			"cancelledReason": "USER_REQUESTED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "amount": 1,
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_scheduling_success

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_scheduling_success",
  "externalId": "E3098053920250807111417545760880",
  "pixAutomaticScheduling": {
    "pixAutomaticSchedulingId": "f6aa7c72-361a-40e9-87e0-82f908b01205",
    "amount": 1,
    "dueDate": '2025-05-27T08:58:35.197Z',
    "status": "SCHEDULED",
    "schedulingDate": '2025-05-27T08:58:35.197Z',
    "endToEndId": "E3098053920250807111417545760880",
    "createdAt": "2025-08-07T00:00:00.000Z",
    "updatedAt": "2025-08-07T00:00:00.000Z",
    "recurrence": {
      "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
      "status": "AUTHORIZED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_scheduling_failed

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_scheduling_failed",
  "externalId": "E3098053920250807111417545760880",
  "pixAutomaticScheduling": {
    "pixAutomaticSchedulingId": "f6aa7c72-361a-40e9-87e0-82f908b01205",
    "amount": 1,
    "dueDate": '2025-05-27T08:58:35.197Z',
    "status": "FAILED",
    "schedulingDate": '2025-05-27T08:58:35.197Z',
    "error": 'AC06',
    "errorDescription": 'Pagamento rejeitado pelo PSP do recebedor',
    "endToEndId": "E3098053920250807111417545760880",
    "createdAt": "2025-08-07T00:00:00.000Z",
    "updatedAt": "2025-08-07T00:00:00.000Z",
    "recurrence": {
      "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
      "status": "AUTHORIZED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_scheduling_cancelled

{
  "callbackStatus": "created",
  "callbackId": "019710f7-0b3d-7223-a3fc-292ddf677667",
  "customerId": "01944b36-21db-7337-9114-063a6b232f54",   
  "eventType": "pix_automatic_scheduling_cancelled",
  "externalId": "E3098053920250807111417545760880",
  "pixAutomaticScheduling": {
    "pixAutomaticSchedulingId": "f6aa7c72-361a-40e9-87e0-82f908b01205",
    "amount": 1,
    "dueDate": '2025-05-27T08:58:35.197Z',
    "status": "CANCELLED",
    "schedulingDate": '2025-05-27T08:58:35.197Z',
    "endToEndId": "E3098053920250807111417545760880",
    "createdAt": "2025-08-07T00:00:00.000Z",
    "updatedAt": "2025-08-07T00:00:00.000Z",
    "recurrence": {
      "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
      "status": "AUTHORIZED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    }
  }
}

pix_automatic_transaction_success

{
  "callbackId": "4f0d25c5-28ea-4aa9-abe4-f175a59788ca",
  "callbackStatus": "created",
  "externalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
  "eventType": "pix_automatic_transaction_success",
  "pixAutomaticScheduling": {
    "pixAutomaticSchedulingId": "f6aa7c72-361a-40e9-87e0-82f908b01205",
    "amount": 10,
    "dueDate": '2025-05-27T08:58:35.197Z',
    "status": "COMPLETED",
    "schedulingDate": '2025-05-27T08:58:35.197Z',
    "endToEndId": "E3098053920250807111417545760880",
    "createdAt": "2025-08-07T00:00:00.000Z",
    "updatedAt": "2025-08-07T00:00:00.000Z",
    "recurrence": {
      "pixAutomaticRecurrenceId": "019884e2-4b9b-743f-845b-313e0d25eda3",
      "status": "AUTHORIZED",
      "journeyType": "JOURNEY_THREE",
      "expirationDate": "2025-08-07T00:00:00.000Z",
      "recurrenceDetails": {
        "frequency": "WEEKLY",
        "dateFirstRecurrence": "2025-08-08T00:00:00.000Z",
        "dateLastRecurrence": "2025-10-27T08:58:35.197Z",
        "totalRecurrences": 3
      },
      "contract": {
        "contractDescription": "Descrição do contrato",
        "contractId": "6076f3da37eb4863a52689bf4e0eabf5",
        "canBePaidAfterRecurrencyDueDate": true
      },
      "minimumAmount": 1,
      "createdAt": "2025-05-27T08:58:35.197Z",
      "updatedAt": "2025-05-27T08:58:35.197Z"
    },
    "pixTransaction": {
      "pixTransactionId": "049d0c73-a528-40f0-8368-9ad55b6a86ed",
      "pixTransactionAmount": 10,
      "pixTransactionStatus": "success",
      "pixTransactionType": "credit",
      "customerId": "fb15a339-4c0b-4065-888d-0ef71cc14888",
      "pixTransactionCreatedAt": "2024-01-15T16:47:03.570Z",
      "pixTransactionUpdatedAt": "2024-01-15T16:47:03.671Z",
      "pixTransactionEndToEndId": "E3098053920240115164700397678057",
      "pixTransactionExternalId": "13e032b8-6452-4ed9-aca0-483535bca80a",
      "pixAccountInfos": {
        "id": "3b52709e-1274-435a-bb9a-6e40a2f182ca",
        "branch": "1",
        "account": "10000294290",
        "ispb": "30980539",
        "taxId": "60418443734",
        "accountType": "TRAN",
        "personType": "CPF",
        "name": "conta teste carga"
      },
    }
  }
}