Error Codes
Error Codes
The Convera API Suite uses a standardized list of error codes to help diagnose issues from data validation to payment processing.
API Error Codes
Below are the possible error codes that are returned in the HTTP response when submitting an API request.
While great care has been taken to reduce the number of unhandled exceptions, it is possible to encounter a scenario that does not have a specific error code associated with it. If you encounter this scenario, please contact the Convera customer support team so we can work to get the error resolved and associated with an error code.
Error Code | Error Description | Conditions | Actions to Take |
---|---|---|---|
1000 | Generic web service error | An unhandled exception has occurred | Resend request 2-3 times over a 5 minute interval. If issue persists, please contact the Convera customer support team |
1001 | Access denied | Client certificate or API token cannot be verified, or a request has been made to unauthorized resources | Ensure proper authorization is attached to request, or request access to resource |
1003 | Required field validation error | A required data field was either not included or was passed with a null or empty string value | Populate field indicated in error message e.g. 1003: paymentMethod |
1004 | Conditional field validation error | A conditional field was either not included or was passed with a null or empty string value | Refer to the API Reference for more information on conditional field requirements |
1005 | Input field value validation error | Value is outside the bounds of syntax or format validation e.g. specifying a string value in an amount field | Refer to the API Reference for more information on field datatype and syntax expectations |
1006 | Unexpected field submitted | Request contains a field that is not part of the API resource model | Remove fields not specified in the API resource model |
1007 | Defined limit exceeded | Limit has been exceeded for resources with a maximum e.g. number of webhook endpoints | Delete or update existing resources with desired information |
1100 | Generic web service error | An unhandled exception has occurred | Resend request 2-3 times over a 5 minute interval. If issue persists, please contact the Convera customer support team |
1101 | Resource not found | A resource was requested but not found | Ensure resources are created in the API before attempting to utilize them |
1102 | Invalid quote | Quote not generated for order commit | Establish a valid Quote ID before attempting to commit an order |
1103 | Quote expired | Previously generated quote ID has expired and must be regenerated prior to order commit | Regenerate quote ID for order |
1104 | Payment update not supported | Attempted update of payment that has been accepted as Created | Delete payment from batch and create a new payment with requested updates |
1105 | Payment cannot be cancelled | Attempted deletion of payment in either status notAccepted or past Created status | Payments that have entered workflow cannot be cancelled via API and may be irrevocable. Please call Convera customer support for more information. |
1107 | Customer cannot be found | Customer is not registered with the Convera API Suite, or the provided customer ID is invalid | Register customer ID with Convera or provide valid customer ID |
1108 | Each settlement currency may only be specified once when committing a batch | A settlement currency is specified more than once in a commit batch request | Remove duplicate instances of settlement currencies in a commit batch request |
1109 | Payment settlement currency cannot be determined | Customer does not have a default settlement account assigned, or the settlement currency has not been specified in request | Configure customer with default settlement currency, or provide settlement currency in request |
1110 | Extra settlement currency provided when committing a batch | A settlement currency not previously provided is now being specified when committing a batch | Ensure payment settlement currencies match settlement currencies of batch commit |
1111 | Insufficient holding balance for settlement | Customer is attempting to settle using a holding balance that cannot cover the cost of the transaction | Fund holding balance with additional funds, or change settlement method |
1112 | Currency not supported | Currency specified in the request is not supported by Convera | Specify a currency supported by Convera. |
1113 | Payments cannot be added to a committed or deleted batch | Attempted addition of payments to a batch in Committed or Cancelled status | Create a new batch for additional payments |
1114 | Currency pair must be unique | A quote is being requested for the same currency pair more than once in a single request | Submit unique currency pairs in a request |
1115 | Unsupported currency and payment method combination | Payment has been submitted with a currency and payment method combination that is not supported by Convera | Specify a currency and payment method combination that is supported by Convera. |
1116 | Payment method invalid or not supported | Payment method specified during payment submission is invalid or not supported | Specify a valid payment method when submitting a payment |
1117 | Remittance type invalid or not supported | Remittance type specified during payment submission was invalid or is not supported | Specify a valid remittance type when submitting a payment |
1118 | Remittance type mismatch | Remittance type specified is supported, but may not be valid for specified payment currency, method, region, beneficiary type, or number of addenda records | Verify the payment is utilizing the correct remittance type |
1120 | Primary webhook cannot be deleted | Primary webhook cannot be deleted when multiple webhooks exist | Delete secondary webhooks before attempting to delete primary webhook |
1206 | Batch is empty | Attempt to quote or commit an empty batch | Submit at least one valid payment before quoting and committing the batch |
1207 | Amount is fixed on a currency that is inconsistent with similar payments | A payment has a fixed amount specified that is different than others payments of the same currency pair | Ensure all payments of a currency pair are submitted with a fixed amount, or none are submitted with a fixed amount |
1209 | Total amount of the order exceeds the customers debit limit | Order booked that exceeds customers e-debit account limit | Change settlement method, or change the order amount |
1210 | Customer is not setup to use settlement method | Specified settlement method not configured for customer | Change settlement method or contact Convera for configuration |
1211 | Minimum amount not met | Specified field does not meet required minimum amount for processing. | Increase amount for processing or specify different currency. |
1212 | Maximum limit exceeded | Specified field exceeds allowed amount for payment method and currency combination. | Specify a different amount, payment method, or currency. |
1213 | Currency not holding enabled | Specified currency not supported as holding-enabled | Specify a different currency |
1217 | Validation error when generating instructions for bank | Field format or contents validation error during workflow | Address failure reason or contact Convera customer support team for investigation |
1218 | Error occurred when generating payment instructions for bank | Error occurred when generating payment instructions for bank | Contact Convera customer support team for investigation |
1219 | Error occurred when committing the batch | Error occurred when committing the batch | Contact Convera customer support team for investigation |
1222 | Error in FAB service | Input field validation failed for request | Ensure FAB requests meet input field validation requirements |
1223 | Invalid country code | Country code does not adhere to ISO 3166 alpha-2 syntax or country is not supported. | Ensure country code is valid and in the proper format. |
1224 | Multiple payments added to batch where not allowed | More than one payment submitted in a Dodd-Frank or Draft payment batch | Create a new batch for additional payments |
1225 | Payment is non-Dodd-Frank payment | Attempt to call disclosure API for a non-Dodd-Frank payment | Submit a Dodd-Frank payment before submitting Disclosure request |
1226 | Invalid SWIFT code format | SWIFT code provided is not either 8 or 11 characters alphanumeric | Provide a valid SWIFT code format |
1229 | CAML payments can not include a Postal Installation. | For payments into or out of Canada, PO Boxes are not allowed. Please see Canadian Payments for conditions. | Remove PO box from any payment address fields. |
NOC Codes
Notice of Change (NOC) codes indicated errors that have been generated by a receiving bank that are destined to the payment originator. These codes typically indicate that a portion of the requested bank information is now invalid and must be changed to prevent future payment rejections.
NOC Code | Code Description | Condition |
---|---|---|
C01 | Incorrect bank account number | Incorrect bank account number or format |
C02 | Incorrect transit/routing number | Once valid transit/routing number must be changed |
C03 | Incorrect transit/routing number and bank account number | Once valid transit/routing number must be changed and causes a change to bank account number structure |
C05 | Incorrect payment code | Entry posted to demand account should contain savings payment codes or vice-versa |
C06 | Incorrect bank account number and transit code | Bank account number must be changed and payment code should indicate posting to another account type (demand/savings) |
C07 | Incorrect transit/routing number, bank account number, and payment code | Changes required in three fields indicated |
Return Codes
Return codes are given by the API when a payment encounters scenarios where the payment cannot be applied to the beneficiary account.
Return Code | Code Description |
---|---|
RTN01 | Account closed |
RTN02 | No account or unable to locate account |
RTN03 | Account number and beneficiary do not match |
RTN04 | Invalid account number |
RTN05 | Invalid beneficiary name |
RTN06 | Beneficiary declined funds; unable to contact beneficiary |
RTN07 | Beneficiary did not claim funds |
RTN08 | Invalid or insufficient payment details |
RTN09 | Invalid or insufficient beneficiary bank branch details |
RTN10 | Invalid routing code |
RTN11 | Invalid SWIFT code |
RTN12 | Incorrect currency |
RTN13 | Rejected per internal policy (Compliance) |
RTN14 | Per recall request |
RTN15 | Bank endorsement missing |
RTN16 | Payment amount insufficient or minimum amount not met |
RTN17 | Debits and credits not allowed |
RTN18 | Other freeform reference included |
RTN19 | No reason provided |
RTN20 | BBK internal policy |
RTN21 | Beneficiary deceased |
RTN22 | Beneficiary reference needed |
RTN23 | Blocked account |
RTN24 | Correspondent bank internal policy |
RTN25 | Duplicate payment |
RTN26 | Foreign exchange relations |
RTN27 | IBK details missing or incorrect |
RTN28 | IBK internal policy |
RTN29 | Only accepts SEPA payments |
RTN30 | Overpayment |
RTN31 | Per beneficiary request |
RTN32 | Purpose of payment not provided or unclear |
RTN33 | Refund |
RTN34 | Remitter details |
RTN35 | Stale dated draft |
Updated 4 months ago