Error Codes
The error codes allow a Partner to understand what generated errors mean and to ensure that the WUBS endpoint is reachable.
| 1000 | Generic Mass Payments Web Service Error | An unhandled exception has occurred. | Nothing. These exceptions have been logged and will be dealt with by the development team. |
| 1001 | Access denied | Client Certificate can't be verified or an attempt has been made to use a resources that you do not have access to. | The partner must ensure that it has access to the resource that it is requesting or that a client certificate is attached to a request |
| 1003 | Required Field Validation Error | A required data input field was either not included in the request or was included as a NULL or empty value. This type of error could optionally include an indication as to what field was missing. For example: 1003:paymentMethod - indicates that the payment method of a payment was not included in the request or had a NULL or empty value. | The partner must ensure that all required fields are included in the request in accordance with the provided API documentation. |
| 1004 | Conditional Field Validation Error | When it was required to be provided, a conditional data input field was either not included in the request or was included as a NULL or empty value. This type of error could optionally include an indication as to what field(s) were not included in a request when they should have been included. For example: 1004:beneficiary.firstName,beneficiary.lastName - in this case, the beneficiary was of type 'individual' and both first and last name were not specified during payment submission. 1004:beneficiary.taxId - in this case, the payment currency (“currencyCode”) was “MXN” (Mexican Pesos) and the beneficiary Tax ID was not specified during payment submission. |
The partner must ensure that all conditional fields are included in the request, when required, and in accordance with the provided API documentation. |
| 1005 | Input Field Value Validation Error | A specific value or value in a specific format was expected. This type of error could optionally include an indication as to what field was not correctly specified. For example: 1005: paymentMethod - indicates that the payment method for a payment has an invalid value (not the one of the acceptable values). 1005: id - indicates that the id for a resource has an invalid value or invalid format NOTE: All numeric fields are converted to 0 with invalid values. They will raise 1003 errorcode instead of 1005. For example: 1003: amount - when amount is "test" or "abc" | The Partner must ensure that all fields in a request are in accordance with the API documentation. |
| 1006 | Unexpected Field Submitted | A partner's request payload contained a field that was unexpected as it is not defined as a part of the resource structure. | The Partner must ensure that all requests are structured as defined in the API documentation. |
| 1007 | Defined Limit Exceeded | Some resources (such as webhooks) have a defined limit on how many of them can be added. | If possible, delete or update one or more existing resources. |
| 1101 | Resource Not Found | A resource was requested as part of a collection or as a nested resource and the requested resource was not found. | The customer must verify that the submitted resource ID is valid and was not deleted after it was created. |
| 1102 | Invalid Quote | Partner request batch commit without valid quote (without calling quote API or due to any other reason quote is not associated with a batch commit. | Partner must call quote API before committing a batch, and after committing a batch, partner must wait for response before sending re-quoting request for that batch. |
| 1103 | Quote Expired | The quote was created more than 60 seconds ago and is no longer valid. | The customer must resubmit a valid quote request. |
| 1104 | Payment Update Not Supported | After a payment has been accepted by Mass Pay, it cannot be updated as that feature is not currently supported. | As long as a batch of payments is not committed, the customer may cancel a payment in that batch, make any necessary changes to the payment, and resubmit the payment as a part of that batch or a different batch. |
| 1105 | Payment Cannot be Cancelled | The requested payment cannot be canceled for one of the following reasons:
|
Payment cannot be cancelled. |
| 1107 | Customer Cannot be Found | The customer is not yet registered for Mass Payments or the provided Customer ID is invalid. | The partner must either register the customer or provide a 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 and each settlement currency can only be settled once via a supported method. | If the customer has a need to use the same settlement currency but different method to fund a batch of payments, they must split the batch such that all payments of each batch are funded via one supported settlement method per settlement currency. |
| 1109 | Payment Settlement Currency Cannot be Determined | The customer does not have a default settlement account assigned or the settlement currency has not been specified in the payment request. | The customer must either be setup with a default settlement currency OR the settlement currency must be provided in the payment request. |
| 1110 | Extra Settlement Currency Provided when Committing a Batch | A settlement currency, that was not specified before as part of a batch of payments, is now being specified in a request to commit that batch. Therefore the request to commit the batch is not accepted. | The customer must ensure that the settlement currencies specified in the request to commit a batch of payments are a part of that batch. |
| 1111 | Error code currently not supported by Mass Payments. | ||
| 1112 | Currency Not Supported | The currency specified in the quote request is not supported by Mass Payments. | The customer can only payout or settle currencies that are supported by Mass Payments. |
| 1113 | Payments Cannot be Added to a Committed Batch | If a customer attempts to add one or more payments to a batch that they previously committed, the payments cannot be added or accepted | The customer has two options:
|
| 1114 | Currency Pair Must be Unique | A quote is being requested for the same currency pair more than once in a single request. | The customer must submit unique currency pairs in a request because the amount of each pair is the aggregate of all corresponding payments, of the same currency pair, within that batch. |
| 1115 | Unsupported Currency and Payment Method Combination | A payment has been submitted with a currency and payment method combination that is not currently supported by Mass Payments. Hence the payment cannot currently be accepted by Mass Payments. For example: even though PHP is a supported currency and ACH is a supported payment method, a payment of PHP via ACH is not currently supported. | The customer must submit a payment with a currency and payment method combination that is currently supported by Mass Payments. |
| 1116 | Payment Method Invalid or Not Supported | The payment method specified during payment submission was invalid or is not currently supported. Hence, the payment cannot be accepted. | The customer must specify a valid and supported payment method when submitting a payment. |
| 1117 | Remittance Type Invalid or Not Supported | The remittance type specified during payment submission was invalid or is not currently supported. Hence, the payment cannot be accepted. | The customer must specify a valid and supported remittance type when submitting a payment. |
| 1118 | Remittance Type Mismatch | >The remittance type specified during payment submission is supported by Mass Payments but the payment cannot be accepted for one or more of the following reasons:
|
Verify the user/partner expectation what remittance types should be used for specific payment case |
| 1120 | Primary webhook cannot be deleted | Primary webhook cannot be deleted when multiple webhooks exist | The customer must delete non-primary webhooks before deleting primary one. |
| 1121-1199 | Error codes currently not supported by Mass Payments. | ||
| 1203, 1204, 1205 | Error codes currently not supported by Mass Payments. | ||
| 1206 | Batch is Empty | The customer is trying to quote or commit an empty batch. | The customer must submit at least one payment in the batch before quoting or committing it. |
| 1207 | Amount is Fixed on a Currency that is Inconsistent with Similar Payments | In a batch, all payments with the same payment and settlement currency combination can only be assigned the same currency (payment or settlement) as the fixed amount. Hence the payment was not accepted. | The customer must resubmit the payment with the amount fixed on the same currency as existing payments with the same currency combination in that batch. |
| 1209 | Total amount of the order exceeds the customers debit limit. | Occurs when booking an order with EDebit settlement method and the total amount exceeds the customers debit account limit. |
|
| 1210 | Customer is not setup to use settlement method. | Occurs when the specified settlement method in the book order request is not setup for customer's use. | Change the settlement method. |
| 1213 | It is not possible to carry a holding balance in this currency. | Occurs when the specified currency during book incoming request is not setup to carry a holding balance. | Change the currency. |
| 1218 | An error occurred on WUBS side when generating payment instructions for bank | Occurs when payment instructions for bank fails. | Contact Mass Payments team for investigation. |
| 1219 | An error occurred when committing the batch | Occurs when batch commit fails. | Contact Mass Payments team for investigation. |