Customer Payment Method Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Error Code | Description |
|---|---|
CREATE_CARD_TYPE_REQUIRES_ONLY_ONE_OF_FIELDS_OR_TOKEN | The request tried to add a payment method to a customer, but both the 'type' and 'token' body parameters are set, or they are both unset. The request was rejected. Corrective action: Set one of the following parameters: 'type' or 'token'. |
ERROR_CREATE_PAYMENT_METHOD | The request attempted an operation that requires specific fields for payment method, but a required field was missing, or an extra, unallowed field was included. Corrective action: Run 'Get Payment Method Required Fields' and check all input fields. |
ERROR_CUSTOMER_PAYMENT_METHOD_NOT_FOUND | The request attempted an operation that requires the default payment method of a customer, but the customer does not have a default payment method. The request was rejected. Corrective action: Use 'Update Customer' to select a default payment method, or use 'Add Payment Method to Customer'. |
ERROR_DELETE_DEFAULT_PAYMENT_METHOD_IN_USE | The request tried to delete a customer's default payment method, but the payment method was in use. The request was rejected. Corrective action: Use 'List Subscriptions', filtered by the customer's ID, then use 'Cancel Subscription' to remove all subscriptions that use the customer's ID or the payment method that you want to delete. |
ERROR_DELETE_PAYMENT_METHOD_FROM_WRONG_CUSTOMER | The request tried to delete a payment method from a customer, but the payment method was not assigned to the customer that was specified in the request. The request was rejected. Corrective action: Indicate a payment method that is on the current list of payment methods for the designated customer. |
ERROR_DELETE_PAYMENT_METHOD_IN_USE | The request tried to delete a customer's payment method, but the payment method was in use. The request was rejected. Corrective action: Use 'List Subscriptions', filtered by the customer's ID, then use 'Cancel Subscription' to remove all subscriptions that use the customer's ID or the payment method that you want to delete. |
ERROR_GET_CUSTOMER_DEFAULT_PAYMENT_METHOD | The request attempted an operation that requires a customer's default payment method, but the default payment method was not found. The request was rejected. Corrective action: Use 'Update Customer' to set the default payment method. |
ERROR_GET_PAYMENT_METHOD_TYPE | The request attempted an operation that requires a payment method, but the payment method type was not recognized or is not available for this merchant. Corrective action: For the 'type' field in the 'payment_method' object or in the 'data' object, use a payment method type that this merchant is authorized to use, or contact Client Support. |
PAYMENT_METHOD_FIELD_NOT_UPDATABLE | The request tried to update a payment method of a customer, but it tried to set a new value for a field that does not exist or is not modifiable. The request was rejected. Corrective action: Do not change the value of the field named at the end of the error code. |
PAYMENT_METHOD_REQUIRES_ONLY_ONE_OF_TYPE_OR_TOKEN | The request tried to add a payment method to a customer, but both the 'type' and 'token' body parameters are set, or they are both unset. The request was rejected. Corrective action: Set one of the following parameters: 'type' or 'token'. |