Enum and error list for the pix charge endpoint. (/pix/brcode/erp/v2/dynamic/immediate)
Responses:
In the responseyou can have these type of enums for this endpoint.
pixChargeStatus enum
| Value | Description |
|---|---|
pending | The QRCode is pending of payment. |
paid | The QRCode is paid. |
expired | The QRCode is expired; Cannot be paid anymore. |
pixChargeQrCodeType enum
| Value | Description |
|---|---|
immediate | Instantly confirm the transaction |
billingDueDate | The charge is generated with a payment deadline, with the option of interest and discount rules. |
pixTransactionStatus enum
| Value | Description |
|---|---|
pending | The transaction is pending to be registered in bacen. |
fail | The transaction failed; The transaction is reversed. |
success | The transaction is successful. |
waiting | The transaction has been registered with the central bank, however it is awaiting the web hook from the central bank. |
reject | The transaction has been rejected by the central bank because of any problem with the transaction. (EG: Timeout) |
Error list:
customerErrors
| Error Code | Message | Status Code |
|---|---|---|
CUSTOMER_NOT_FOUND | The customer provided was not found, check it and try again. | 404 |
CUSTOMER_ID_REQUIRED | A customer ID is required. | 400 |
CUSTOMER_BLOCKED | The customer provided is blocked. | 403 |
partnerErrors
| Error Code | Message | Status Code |
|---|---|---|
PARTNER_ERP_TOKEN_PARAMETER_NOT_FOUND | The ERP token parameter for the partner was not found. | 404 |
PARTNER_ERP_TOKEN_PARAMETER_INVALID | The ERP token parameter provided for the partner is invalid. | 401 |
PARTNER_NOT_FOUND | The partner was not found. | 404 |
pixChargeErrors
| Error Code | Message | Status Code |
|---|---|---|
PIX_CHARGE_INVALID_PARAMETER | One or more parameters provided for the Pix charge are invalid. | 400 |
PIX_CHARGE_ID_NOT_FOUND | The Pix charge ID provided was not found. | 404 |
PIX_CHARGE_INTERNAL_ERROR | Error on generating Dynamic QRCode Immediate. | 500 |
qrCodeErrors (Validation)
| Error Code | Message | Status Code |
|---|---|---|
QRCODE_DICT_KEY_NOT_FOUND | QR code dictionary key not found. | 404 |
QRCODE_DICT_KEY_INVALID | QR code dictionary key is invalid. | 400 |
QRCODE_CITY_NOT_FOUND | QR code city not found. | 404 |
QRCODE_CITY_INVALID | QR code city is invalid. | 400 |
QRCODE_CUSTOMER_ID_INVALID | The customer ID provided in the QR code is invalid | 400 |
QRCODE_ZIP_CODE_NOT_FOUND | QR code ZIP code not found. | 404 |
QRCODE_ZIP_CODE_INVALID | QR code ZIP code is invalid. | 400 |
QRCODE_EXPIRATION_INVALID | QR code expiration is invalid. | 400 |
QRCODE_EXPIRATION_REQUIRED | QR code expiration is required. | 400 |
QRCODE_EXTERNAL_ID_REQUIRED | External ID is required for the QR code. | 400 |
QRCODE_EXTERNAL_ID_INVALID | The external ID provided for the QR code is invalid. | 400 |
QRCODE_EXTERNAL_ID_DUPLICATED | The external ID provided for the QR code is already in use. | 409 |
QRCODE_AMOUNT_REQUIRED | Amount is required for the QR code. | 400 |
QRCODE_AMOUNT_INVALID | The amount provided for the QR code is invalid. | 400 |
QRCODE_MIN_AMOUNT_INVALID | The minimum amount for the QR code is invalid. | 400 |
QRCODE_DESCRIPTION_INVALID | QR code description is invalid. | 400 |
QRCODE_DESCRIPTION_MAX_LENGTH | QR code description exceeds maximum length. | 400 |
QRCODE_TAX_ID_NOT_FOUND | Tax ID for QR code not found. | 404 |
QRCODE_TAX_ID_INVALID | The tax ID for the QR code is invalid. | 400 |
QRCODE_TAX_ID_NOT_ALLOWED | The tax ID provided for the QR code is not allowed. | 403 |
QRCODE_TAX_ID_REQUIRED | Tax ID is required for the QR code. | 400 |
QRCODE_PAYER_REQUEST_INFORMATION_INVALID | Payer request information for the QR code is invalid. | 400 |
QRCODE_PAYER_REQUEST_INFORMATION_LENGTH | Payer request information for the QR code exceeds maximum length. | 400 |
QRCODE_RESTRICT_PAYERS_TAX_ID_INVALID | The tax ID of restrict payers provided in the QR code is invalid. | 400 |
QRCODE_INVALID_FORMAT | QR code has an invalid format. | 400 |
QRCODE_INVALID_PAYLOAD | QR code payload is invalid. | 400 |
QRCODE_INVALID_IMMEDIATE_PAYLOAD | Immediate payload for QR code is invalid. | 400 |
QRCODE_RECEIVER_INFORMATION_INVALID | The receiver information provided is invalid | 400 |
QRCODE_ADDITIONAL_DATA_FIELD_INVALID | Additional data field for QR code is invalid. | 400 |
QRCODE_TAX_ID_NOT_ALLOWED_PAYMENT | Tax ID not allowed for QR code payment. | 403 |
QRCODE_NAME_INVALID | Name for QR code is invalid. | 400 |
QRCODE_EXPIRATION | QR code expiration error. | 400 |
SPI Errors
| Error | Message | StatusCode |
|---|---|---|
ERROR_SAVING_STATUS_FROM_JDPI | ERROR_SAVING_STATUS_FROM_JDPI | 400 |
ERROR_SAVING_PAYMENT_ORDER | ERROR_SAVING_PAYMENT_ORDER | 400 |
ERROR_SAVING_CREDIT_INFOS | exception.error ou INTERNAL_SERVER_ERROR | 400 |
ERROR_WEBHOOK_CREDIT_QUEUE | ERROR_WEBHOOK_CREDIT_QUEUE | 400 |
ERROR_REQUEST_PAYMENT | ERROR_REQUEST_PAYMENT | 400 |
CALLBACK_AUTHORIZATION_INVALID | CALLBACK_AUTHORIZATION_INVALID | 400 |
INVALID_END_TO_END_ID_STRING | INVALID_END_TO_END_ID_STRING | 400 |
INITIATION_FORM_INVALID | De acordo com os retornos de erros da JDPI paragrafo 8.7 | 400 |