# Code and Formats source: https://developer.mastercard.com/donations/documentation/code-and-formats/index.md ## Errors Overview {#errors-overview} We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Mastercard-related issues. | Status Code | Response | Description | |-------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------| | **200** | OK | Everything worked as expected. | | **201** | CREATED | A POST method successfully created a resource. | | **202** | ACCEPTED | The server accepted the request and will execute it later. | | **204** | NO CONTACT | The server successfully executed the method but returns no response body. | | **400** | BAD REQUEST | The request was unacceptable, often due to missing a required parameter. | | **401** | UNAUTHORIZED | A client with its clientId does not have access. | | **402** | REQUEST FAILED | The parameters were valid but the request failed. | | **403** | FORBIDDEN | The API key does not have permissions to perform the request. | | **404** | NOT FOUND | The requested resource does not exist. | | **405** | NOT ALLOWED | The server does not implement the requested HTTP method. | | **406** | NOT ACCEPTABLE | The server does not implement the media type that would be acceptable to the client. | | **408** | REQUEST TIMEOUT | The client did not produce a request within the time that the server was prepared to wait. | | **409** | NO CONTACT | The request conflicts with another request (perhaps due to using the same idempotent key). | | **415** | UNSUPPORTED | The server does not support the request payload's media type. | | **422** | UNPROCESSABLE | The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation. | | **429** | TOO MANY REQUESTS | Too many requests hit the API too quickly. | | **500** | SERVER ERRORS | Something went wrong on Mastercard's end. (These are rare) | ## Gateway Error Codes {#gateway-error-codes} For further information about 4xx/5xx response codes and possible resolutions, See [Gateway Error Codes](https://developer.mastercard.com/platform/documentation/gateway-error-codes/) ## Error Structure {#error-structure} To ensure a consistent experience across all Mastercard APIs, the following structure is followed by Donate APIs for every error scenario that can occur. Single Error : ```JSON { "Errors": { "Error": [ { "Source": "", "ReasonCode": "", "Description": "", "Recoverable": true/false, "Details": "" } ] } } ``` Multiple Errors : ```JSON { "Errors": { "Error": [ { "Source": "", "ReasonCode": "", "Description": "", "Recoverable": true/false, "Details": "" },{ "Source": "", "ReasonCode": "", "Description": "", "Recoverable": true/false, "Details": "" } ] } } ``` | Field | Description | |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Source** | The application that generated this error. Every error message that is generated and returned by the gateway will have this field equal to Gateway. When the value of the source field is something else than DONATE_SERVICE, it means that the error was generated at elsewhere than Donate APIs | | **ReasonCode** | A unique constant identifying the error case encountered during Donate API processing. For example, INVALID_SIGNATURE is used when the request signature does not match the expected one | | **Description** | Short description of the ReasonCode field | | **Recoverable** | Indicates whether this error will always be returned for this request, or retrying could change the outcome. For example, if the request contains an invalid signature, retrying will never result in a success. However, if the error is related to some unexpected timeout with the service, retrying the call could result in a successful response | | **Details** | Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors | ## Donate API-Specific Errors {#donate-api-specific-errors} Note: Following error codes are specific to Donate API services, so for all errors in the table, Source is returned as `DONATE_SERVICE`. For any error with source other than `DONATE_SERVICE`, Please refer to [Gateway Error Codes](https://developer.mastercard.com/platform/documentation/gateway-error-codes/) for possible resolutions, Sample of Donate API error object : ```JSON { "Errors": { "Error": [ { "Source": "DONATE_SERVICE", "ReasonCode": "DONOR_ID_INVALID", "Description": "Invalid donorId, it must be a valid UUID.", "Recoverable": false, "Details": null } ] } } ``` For a complete list of Donate API-specific error codes, refer this table. | Reason Code | Description | Tip to resolve | |---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | **CLIENT_ID_NULL** | The `clientId` must not be null. | Provided client ID is null, please provide a valid client ID. | | **DONATION_NULL** | Donation must not be null. | Provided donation request is null, please provide a valid donation request. | | **CHARITY_ID_NULL** | `charityId` must not be null. | Provided charity ID is null, please provide a valid charity ID. | | **AMOUNT_NULL** | The `amount` must not be null. | Provided amount is null, please provide a valid amount. | | **PROGRAM_ID_NULL** | The `programId` must not be null. | Provided program ID is null, please provide a valid program ID. | | **DONATION_TYPE_NULL** | The `donationType` must not be null. | Provided donation type is null, please provide a valid donation type. | | **DONATION_STATUS_NULL** | The `donationStatus` must not be null for the donation type. | Provided donation status is null, please provide a valid donation status. | | **FIRST_NAME_NULL** | The `firstName` must not be null. | Provided first name is null, please provide a valid first name. | | **LAST_NAME_NULL** | The `lastName` must not be null. | Provided family name is null, please provide a valid family name. | | **EMAIL_NULL** | The `email` must not be null. | Provided email is null, please provide a valid email. | | **TNC_ACCEPTED_NULL** | The `tncAccepted` must not be null. | Provided accepted terms and conditions is null, please provide valid accepted terms and conditions. | | **AMOUNT_NOT_IN_RANGE** | The input amount is not in range. | Please provide an amount as per the range stated in the program policy. | | **INVALID_EMAIL** | The `email` should be valid. | Provided email is not valid, please provide a valid email. | | **CARD_NUMBER_INVALID** | Invalid Card Number | Provided card number is not valid, please provide a valid card number. | | **CARD_EXPIRY_MONTH_INVALID** | Invalid month, card expiry month should be within the range of 01 to 12. | Provided card expiry month is not valid, please provide a valid card expiry month. | | **CARD_EXPIRY_YEAR_INVALID** | Invalid year, card expiry year should be of 4 digits. | Provided card expiry year is not valid, please provide a valid card expiry year. | | **INVALID_TNC_ACCEPTED** | The `tncAccepted` field must not be false. | Provided accepted terms and conditions are not valid, please provide accepted terms and conditions. | | **INVALID_PROGRAM_ID** | Invalid `programId`, it must be a valid UUID. | Provided program ID is not valid, please provide valid Program ID. | | **CHARITY_ID_INVALID** | Invalid `charityId`, it must be a valid UUID. | Provided charity ID is not valid, please provide a valid charity ID. | | **DONOR_ID_INVALID** | Invalid `donorId`, it must be a valid UUID. | Provided Donor ID is not valid, please provide a valid donor ID. | | **INVALID_CARD_ID** | Invalid `cardId`, it must be a valid UUID. | Provided card ID is not valid, please provide a valid Program ID. | | **INTERNAL_SERVER_ERROR** | An error occurred on the server. | | | **CLIENT_PROGRAM_NOT_ASSOCIATED** | The client with `clientId` \<\< *input client ID* \>\> is not associated with the program with `programId` \<\< *program id associated with client id*\>\>. | The program is not associated with this client. Please provide a correct program ID. | | **CLIENT_NOT_REGISTERED** | Client with `clientId` \<\<*input client ID*\>\> is not registered. | Client ID is not registered, please provide a registered client ID. | | **PROGRAM_NOT_FOUND** | No program found for `programId` \<\< *program ID associated with client ID*\>\>. | Program is not registered for this id, please provide a valid program id. | | **DONATION_TYPE_NOT_FOUND** | The `donationType` \<\< *input donation type* \>\> is not supported by the program with programId \<\< *program ID associated with client ID* \>\>. | Donation type is not supported, please provide a valid donation type. | | **DONATION_ACCOUNT_NOT_FOUND** | No donation account found for `donorId` \<\< *input donor id* \>\>. | Donation account not found, please provide a valid donor ID. | | **CARD_NOT_FOUND** | No card with `cardId` \<\< *input card id* \>\> found for donation account with `donorId` \<\< *input donor ID*\>\>. | Card not found for \<\<*input card id*\>\>, please provide a valid card id | | **CARD_NOT_FOUND_FOR_PAN** | No card found for this PAN. | Card not found for PAN, please provide a valid PAN. | | **CARD_NOT_FOUND_FOR_DONOR_ID** | No card found for this `donorId`. | Card not found for the provided donor ID, please provide valid card details. | | **CARD_RECORD_NOT_FOUND** | No card record found. | Card record not found, please provide valid card details. | | **CARD_ID_SHOULD_NOT_BE_EMPTY** | The `cardId` should not be empty. | Provided card ID is empty, please provide a valid card ID. | | **INVALID_REQUEST_PARAMETERS** | Invalid request parameters. | Provided request parameters are empty, please provide valid request parameters. | | **PROGRAM_CHARITY_NOT_ASSOCIATED** | Program with `programId` \<\< *input program id* \>\> associated with \<\<*input_client id* \>\> is not associated with charity with `charityId` \<\< *input charity id*\>\>. | Program charity not associated, please provide a valid charity ID. | | **TO_MAIL_ADDRESS_NULL** | The To email address cannot be null or invalid. | Provided to mail address is null, please provide a valid to mail address. | | **TEMPLATE_ID_NULL** | The Template ID cannot be null or empty. | Provided template ID is null, please provide a valid template ID. | | **EMAIL_TEMPLATE_NULL** | Email template cannot be null or empty. | Provided email template is null, please provide a valid email template. | | **CARD_ID_NULL** | The `cardId` must not be null. | Provided card ID is null, please provide a valid card ID. | | **DONOR_ID_NULL** | The `donorId` must not be null. | Provided Donor ID is null, please provide a valid donor ID. | | **PRIMARY_ACCOUNT_NUMBER_NULL** | The primary account number must not be null. | Provided primary account number is null, please provide a valid primary account number. | | **PRIMARY_ACCOUNT_NUMBER_SUFFIX_NOT_FOUND** | No Primary account number suffix found. | Primary account number suffix is not found, please provide valid card details. | | **USER_NULL** | The user must not be null. | Provided user is null, please provide valid user details. | | **CARD_NULL** | The card must not be null. | Provided card details is null, please provide valid card details. | | **SESSION_ID_AND_CARD_DETAILS_BOTH_NULL** | Either `sessionId` or the card details should be present in the request. | Provided Session ID and card details are null, please provide either Session ID or Card ID. | | **EXCEPT_SESSION_ID_CARD_DETAILS_NOT_REQUIRED** | The `sessionId` in the request should not be accompanied by card details. | Please remove card details. | | **USER_CARD_DETAIL_NOT_REQUIRED** | User and card details are not required. | Please remove user and card details. | | **REQUEST_BODY_EMPTY** | Request body for donation request cannot be empty. | Please provide a valid request body. | | **ADD_CARD_REQUEST_BODY_EMPTY** | The request body for the added card request cannot be empty. | Please provide a valid request body. | | **SEARCH_CARD_REQUEST_BODY_EMPTY** | The request body for the search card request cannot be empty. | Please provide a valid request body. | | **CARD_NUMBER_NULL** | The card number must not be null. | Please provide a valid card number. | | **AMOUNT_FORMAT_INVALID** | Invalid amount. It should be a valid numeric value. | Please provide the amount in a valid format. | | **NUMERIC_VALUE_INVALID** | Invalid request body as leading zeroes to the inputs are not allowed. | Numeric values should begin with a non-zero value. | | **DECIMAL_VALUE_INVALID** | Invalid request body as decimal point is not followed by a digit. | Please remove decimal values. | | **CHARITY_NOT_FOUND** | No charity found for `charityId` \<\< *input charity id* \>\>. | Please provide a registered charity ID. | | **CARD_EXPIRY_DETAILS_NULL** | Card expiry details cannot be empty. | Please provide valid card expiry details. | | **CARD_EXPIRY_MONTH_NULL** | Card expiry month must not be null. | Please provide a valid card expiry month. | | **CARD_EXPIRY_YEAR_NULL** | Card expiry year must not be null. | Please provide a valid card expiry year. | | **CARD_EXPIRED** | Card is expired. | Please provide active card details. | | **COUNTRY_CODE_NULL** | The Country Code must not be null. | Please provide a valid country code. | | **COUNTRY_CODE_INVALID** | The Country Code is invalid. | Please provide a valid country code. | | **USER_ID_NULL** | User ID must not be null. | Please provide a valid User ID. | | **CARD_ALIAS_MAX_LENGTH** | The maximum length of Card Alias must be less than or equal to 40. | Please provide a valid card alias with a length less than 40. | | **MULTIPLE_PROGRAM_ID_ASSOCIATED_WITH_CLIENT_ID** | Multiple program IDs associated with client ID. | Please remove multiple program IDs associated with the Client ID. | | **ILLEGAL_CHARACTER** | Invalid request body as you have entered an illegal unquoted character. | Please provide a valid request body | | **CITY_INVALID** | Invalid city, it should contain alphabets and space only. | Please provide a valid city. | | **STATE_INVALID** | Invalid state value. It should contain alphabets only. | Please provide a valid state. | | **POSTAL_CODE_INVALID** | Invalid postal code. It should be a valid numeric value. | Please provide a valid numeric value. | | **MAX_CARDS_FOR_USER_REACHED** | The user has reached the maximum number of cards as per the program policy. | For more details, refer to the consumer policy. | | **MOD10_CHECK_FAILED** | Primary account number did not pass Mod10 validation. | Please provide a valid primary account number. | | **LEADING_DIGIT_VALIDATION_FAILED** | Primary Account Number is not in the valid BIN range. | Please provide a valid primary account number. | | **ADDRESS_LINE1_INVALID** | Billing address line1 should not contain special characters. | Please provide a valid address at line 1. | | **ADDRESS_LINE2_INVALID** | Billing address line2 should not contain special characters. | Please provide a valid address at line 2. | | **ADDRESS_LINE3_INVALID** | Billing address line3 should not contain special characters. | Please provide a valid address at line 3. | | **CARD_ALIAS_INVALID** | The card alias should be alphanumeric only. | Please provide a valid card alias. | | **CARD_HOLDER_NAME_EMPTY** | The cardholder name must not be empty. | Please provide a valid cardholder name. | | **CARD_ALIAS_MAX_CONSECUTIVE_DIGITS** | The card alias should not contain more than 10 consecutive digits. | Please provide a valid card alias. | | **PRIMARY_ACCOUNT_NUMBER_SOURCE_INVALID** | The `primaryAccountNumberSource` should be either CARD_ON_FILE or EXTERNAL_SYSTEM. | Please provide a valid card source. | | **USERNAME_NULL** | The username must not be null. | Please provide a valid username. | | **USER_NAME_NULL** | The name must not be null. | Please provide a valid username. | | **USER_LOCALE_NULL** | The user locale must not be null. | Please provide a valid user locale. | | **USER_EMAILS_NULL** | The user emails must not be null. | Please provide valid user emails. | | **USER_FIRST_NAME_NULL** | The The user first name must not be null. | Please provide a valid user first name. | | **USER_LAST_NAME_NULL** | The user family name must not be null. | Please provide a valid user family name. | | **USER_ACCEPTED_CONSENTS_NULL** | User `acceptedConsents` must not be null. | Please provide valid user accepted consents. | | **USER_CONSENT_TNCVERSION_NULL** | User Consent Terms and Conditions Version must not be null. | Please provide valid user consent terms and conditions version. | | **USER_CONSENT_PRIVACY_NOTICE_NULL** | User Consent privacy notice must not be null. | Please provide a valid user consent privacy notice. | | **USER_CONSENT_EMAILSUB_NULL** | User Consent marketing email-subscribed status must not be null. | Please provide valid user consent email-subscribed status. | | **USER_ADDRESS_TYPE_NULL** | Address type must not be null. | Please provide a valid user address type. | | **USER_STREET_ADDRESS_NULL** | Street address must not be null. | Please provide a valid street address. | | **USER_ADDRESS_CITY_NULL** | City must not be null. | Please provide a valid city in the address. | | **USER_ADDRESS_COUNTRY_NULL** | Country must not be null. | Please provide a valid address country. | | **USER_PHONE_NUMBER_INVALID** | The user phone number is invalid. | Please provide a valid user phone number. | | **USER_LOCALE_INVALID** | User Locale is invalid. | Please provide a valid user locale. | | **USER_TIMEZONE_INVALID** | User timezone is invalid. | Please provide a valid user timezone. | | **USER_TYPE_INVALID** | User type is invalid. | Please provide a valid user type. | | **USER_LOCALE_NOT_SUPPORTED** | User locale is not supported by the program. | Please provide a valid user locale. | | **USER_PHONE_NUMBER_TYPE_NULL** | The phone number type must not be null. | Please provide a valid user phone number type. | | **USER_PHONE_NUMBER_VALUE_NULL** | The phone number value must not be null. | Please provide a valid user phone number value. | | **USER_CONSENT_TNCVERSION_INVALID** | User Consent `tncVersion` is invalid. | Please provide a valid version of the user consent terms and conditions. | | **USER_CONSENT_PRIVACY_NOTICE_INVALID** | User Consent `privacyNoticeVersion` is invalid. | Please provide a valid user consent privacy notice. | | **USER_CONSENT_EMAILSUB_INVALID** | User Consent `marketingEmailSubscribed` is invalid. | Please provide a valid user consent email-subscribed status. | | **ADD_UPDATE_USER_REQUEST_BODY_EMPTY** | The request body for add or update user request cannot be empty. | Please provide a valid request body. | | **USER_EMAIL_TYPE_NULL** | User email type must not be null. | Please provide a valid user email type. | | **USERNAME_INVALID** | Invalid username, username should be email. | Please provide a valid username. | | **USER_LAST_NAME_INVALID** | User family name is invalid. | Please provide a valid user family name. | | **USER_LAST_NAME_SIZE_INVALID** | The maximum length of user family name must be less than or equal to 40. | Please provide a valid user family name. | | **USER_FIRST_NAME_INVALID** | User first name is invalid. | Please provide a valid user first name. | | **USER_FIRST_NAME_SIZE_INVALID** | The maximum length of user first name must be less than or equal to 40. | Please provide a valid user first name. | | **USER_NAME_HONORIC_PREFIX_INVALID** | User name `honoricPrefix` is invalid. | Please provide a valid user name honorific prefix. | | **USER_NAME_HONORIC_SUFFIX_INVALID** | User name `honoricSuffix` is invalid. | Please provide a valid user name honorific suffix. | | **USER_TITLE_INVALID** | The user title is invalid. | Please provide a valid user title. | | **USER_POSTAL_CODE_INVALID** | The user postal code is invalid. | Please provide a valid postal code. | | **USER_ALREADY_PRESENT** | The username already exists. | Please provide a different valid username. | | **USER_DETAIL_NOT_REQUIRED** | User details are not required. | Please remove user details. | | **USER_NOT_FOUND** | User not found. | Please provide valid user details. | | **DONATION_ACCOUNT_NOT_FOUND_FOR_USER** | Donation account not found for user. | Please provide a valid donor ID. | | **CARD_DETAIL_NOT_REQUIRED** | Card details are not required. | Please remove card details. | | **CVC_FORMAT_INVALID** | CVC format invalid. It should be a valid numeric value with size \<\< *required CVC size according to card brand*\>\>. | Please provide a valid CVC. | | **ONE_TIME_PAYMENT_REQUEST_BODY_EMPTY** | The request body for a one-time payment request cannot be empty. | Please provide a valid request body. | | **INPUT_VALUE_INVALID** | The user has entered an invalid input value. | Please provide a valid input value. | | **INPUT_INVALID** | Input is invalid. | Please provide a valid input. | | **UPDATE_CARD_REQUEST_BODY_EMPTY** | The request body for update card request cannot be empty. | Please provide a valid request body. | | **SETUP_DONATION_AMOUNT_NULL** | Donation Setup Amount must not be null. | Please provide a valid donation setup amount. | | **DONATION_TYPE_INVALID** | Donation type is invalid. | Please provide a valid donation type. | | **SETUP_DONATION_MAXCAP_FORMAT_INVALID** | Invalid maximum cap. It should be a valid numeric value. | Please provide a valid numeric value. | | **SETUP_DONATION_AMOUNT_GREATER_THAN_MAX_CAP** | Donation amount should not be greater than the maximum cap. | Please provide an amount less than the maximum capping amount. | | **NO_PROGRAM_FOR_CLIENT_ID** | No program is associated with client ID \<\< *program id associated with client id* \>\>. | Please register for the program with the charity ID. | | **SETUP_DONATION_MAX_CAP_NULL** | The maximum cap must not be null for micro donation. | Please provide a valid maximum capping value. | | **ONE_TIME_PAYMENT_FAILURE** | Error while processing first real-time payment. | | | **SETUP_DONATION_REQUEST_BODY_EMPTY** | The request body for setup donation cannot be empty. | Please provide a valid request body. | | **SETUP_DONATION_STATUS_ACTIVE** | Donation setup status is active for donor id \<\< *input donor id* \>\>, card id \<\< *input card id* \>\> and program id \<\< *program id associated with client id* \>\>. | Please delete donation setup. | | **GUEST_DONATION_REQUEST_BODY_EMPTY** | The request body for guest donation request cannot be empty. | Please provide a valid request body. | | **DONATION_TYPE_INCORRECT_ENDPOINT** | Donation type \<\< *input donation type* \>\> is not supported. | Please provide a valid donation type. | | **CVC_NULL** | CVC must not be null. | Please provide a valid CVC. | | **SETUP_DONATION_ALREADY_PRESENT** | Donation setup already exists with `donationSetupId` \<\< *input donation setup id* \>\>. | Please provide a different setup ID. | | **DONATION_SETUP_CANNOT_BE_UPDATED** | Donation setup for given `donorId`, `cardId`, `charityId`, `donationType` exists. Kindly use the **Update Donation Setup API** if you wish to update the setup. | Kindly use the **Update Donation Setup API** if you wish to update the setup. | | **SETUP_DONATION_AMOUNT_NOT_IN_RANGE** | The `amount` \<\< *input amount* \>\> is not in range. | Refer to the program policy for the allowed range. | | **SETUP_DONATION_AMOUNT_FORMAT_INVALID** | Invalid amount. It should be a valid numeric value. | Please provide a valid numeric value. | | **DONATION_SETUP_ID_NULL** | The `donationSetupId` must not be null. | Please provide a valid setup ID. | | **DONATION_SETUP_ID_INVALID** | The `donationSetupId` is invalid. | Please provide a valid Donation Setup ID. | | **DONATION_SETUP_ID_NOT_FOUND** | The `donationSetupId` not Found. | Please provide a valid Donation Setup ID. | | **DONATION_TYPE_MISMATCH** | The `donationType` mismatched with saved type. | Please provide a valid donation type. | | **DONATION_ID_CLIENT_ID_MISMATCH** | The `donationSetupId` \<\< *input donation setup id* \>\> is either not associated with or not available for Program with `programId` \<\< *program id associated with client id* \>\> | Please provide a valid program ID. | | **USER_ACTION_INVALID** | The action type requires a Donation Setup ID. | Please provide a valid Donation Setup ID. | | **PAN_CANNOT_BE_UPDATED** | The Primary account number cannot be updated. | Please remove PAN details. | | **DONOR_ID_NOT_EXIST** | Donor does not exist for the `clientId` \<\< *input client id* \>\>. | Please provide a valid donor ID. | | **DONOR_ID_NOT_EXIST_FOR_ANY_CLIENT** | Donor does not exist for any client. | Please provide a registered donor ID. | | **DELETE_USER_VALIDATION_FAILED** | Operation denied! Please remove the cards and the associated donation setups, if any, before retrying. | Please remove cards associated with the Donor ID. | | **NO_MAPPING_FOUND_FOR_URI** | No mapping found for the requested URI. | | | **HTTP_REQUEST_METHOD_NOT_SUPPORTED** | Http request method is not supported. | | | **FROM_DATE_NULL** | The date must not be null. | Please provide a valid date. | | **TO_DATE_NULL** | The date must not be null. | Please provide a valid date. | | **SETUP_DONATION_MAXIMUM_CAP_NOT_IN_RANGE** | Maximum cap \<\< *input maximum cap amount* \>\> not in range. | Refer to the program policy for the amount range. | | **UPDATE_USER_FIELD_VALIDATIONS** | Invalid Operation! username, usertype and home email(s) fields cannot be changed. | Please provide a registered username, user type and home email. | | **FROM_DATE_GREATER_THEN_TO_DATE** | 'From Date' should be less than the 'To Date'. | Please provide a valid From Date. | | **USERNAME_HOME_EMAIL_SHOULD_BE_SAME** | Username should be the same as email type 'home'. | Please provide a username same as home email. | | **USER_TYPE_NULL** | The user type must not be null. | Please provide a valid user type. | | **DATE_FORMAT_INVALID** | Date format is invalid, please provide a valid date. | Please provide a valid date. | | **USER_DUPLICATE_EMAIL_TYPE_NOT_ALLOWED** | Duplicate email type is not allowed. | Please provide a different email type. | | **USER_EMAIL_TYPE_HOME_MANDATORY** | Email type 'home' is mandatory. | Please provide a valid home email. | | **USER_DUPLICATE_PHONE_NUMBER_TYPE_NOT_ALLOWED** | Duplicate phone number type is not allowed. | Please provide a different phone number type. | | **USER_HOME_EMAIL_VALUE_CANNOT_BE_NULL** | Email type 'home' value must not be null. | Please provide a valid home email ID. | | **OFFSET_INVALID** | Offset is invalid. | Please provide a valid offset value. | | **LIMIT_INVALID** | Limit is invalid. | Please provide a valid limit value. | | **NUMBER_FORMAT_INVALID** | One or more fields do not have a valid numeric value. | Please provide a valid numeric value. | | **CARDDETAILS_OR_CARDID_NULL** | Either `sessionId` or `cardId` must be passed. | Please provide either a Session ID or Card ID. | | **USERDETAILS_OR_DONORID_NULL** | Either user details or `donorId` must be passed. | Please provide user details or donor ID. | | **CARDDETAILS_AND_OR_CARDID_NULL** | Card details and/or `cardId` must not be null. | Please provide either card details and/or card ID. | | **CONSUMER_ID_NULL** | Consumer ID must not be null. | Please provide a valid Customer ID. | | **CONSUMER_ID_NOT_FOUND** | Consumer ID not found \<\< *input customer id*\>\>. | Please provide a registered Customer ID. | | **SETUP_CARD_NOT_SUPPORTED_MONTHLY** | Card not supported. Only Mastercard and VISA card with a 16-digit PAN is accepted for monthly donations. | Please provide valid card details. | | **SETUP_CARD_NOT_SUPPORTED** | Card not supported. Only Mastercard branded cards are accepted for \<\< *input donation type\>*\> donations. | Please provide valid card details. | | **SESSION_ID_NULL** | The `sessionId` must not be null. | Please provide a valid session ID. | | **STORE_MY_CARD_NULL** | My card must not be null. | Please provide a valid store my card value. | | **STORE_MY_CARD_INVALID** | 'Store my card' consent value is invalid. | Please provide a valid store my card value. | | **DONATION_SETUP_CANNOT_BE_ADDED** | Donation setup for type \<\< *input donation type* \>\> cannot be created. Setup for the given `donorId`, `cardId`, `charityId` already exists for type \<\< *input donation type* \>\>. | Please provide a different donation type. | | **FILE_SHOULD_NOT_BE_EMPTY** | File should not be empty. | Please provide a valid file. | | **TRANSACTION_STATUS_INVALID** | Transaction status is invalid. | Please provide a valid transaction status. | | **INVALID_LIMIT** | The limit should be less than 2000. | Please provide a valid limit value. | For a complete list of External Donations API-specific error codes, refer this table. | Reason Code | Description | Tip to resolve | |----------------------------------------|-----------------------------------------------------------|-------------------------------------------------------------------------------------------| | **DONATION_REPORT_REQUEST_BODY_EMPTY** | Request body for donation report request cannot be empty. | Provided donation report request is null, please provide a valid donation report request. | | **PARTNER_NAME_NULL** | The partner name must not be null. | Provided partner name is null, please provide a valid partner name. | | **TRANSACTION_DATE_NULL** | The transaction date must not be null. | Provided transaction date is null, please provide a valid transaction date. | | **CURRENCY_NULL** | Currency must not be null. | Provided currency is null, please provide valid currency. | | **AMOUNT_NULL** | The amount must not be null. | Provided amount is null, please provide a valid amount. | | **CARD_SCHEME_NULL** | The card scheme must not be null. | Provided card scheme is null, please provide a valid card scheme. | | **AMOUNT_FORMAT_INVALID** | Invalid amount. It should be a valid numeric value. | Please provide the amount in valid format. | | **CHARITY_NAME_NULL** | Charity name must not be null. | Provided charity name is null, please provide a valid charity name. | | **TRANSACTIONID_NULL** | Transaction id must not be null. | Provided transaction id is null, please provide valid transaction id. | | **DUPLICATE_RECORD_FOUND** | Record already exists. | Provided record already exists, please provide a valid record. | | **INTERNAL_SERVER_ERROR** | An error occurred on the server. | | Donation Transaction Status API-specific error codes. | Reason Code | Description | Tip to resolve | |-----------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **INVALID_TXN_OR_CORRELATION_ID** | Invalid Transaction ID or Correlation ID. | No record found in DB for provided `transactionId` or `correlationID`. Please verify Client ID, Transaction ID, Correlation ID passed in the request and re-try. | | **TXN_ID_OR_CORRELATION_ID_NULL** | Transaction ID or Correlation ID must not be null. | Either Transaction ID or Correlation ID must be passed in the URI. | | **CLIENT_ID_NULL** | The `clientId` must not be null. | Client ID must not be null in request body. | | **INTERNAL_SERVER_ERROR** | An error occurred on the server. | | 3DS specific error codes. | Reason Code | Description | Tip to resolve | |-----------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | **AUTHENTICATION_DETAILS_NULL** | Authentication details cannot be empty. | Please provide a valid request body. | | **AUTHENTICATION_DETAILS_3DS_NULL** | 3DS details in authentication cannot be empty. | Please provide a valid request body. | | **3DS_ACS_ECI_INVALID** | Invalid 3DS acsEci. It must be a numeric value. | Please provide a valid 3DS authentication ASC ECI. | | **3DS_ACS_ECI_LENGTH_INVALID** | Invalid 3DS acsEci length. must not be greater than 3. | Please provide a valid 3DS authentication ASC ECI length. | | **3DS_AUTHENTICATION_TOKEN_NULL** | 3DS Authentication Token must not be null or empty. | Provided 3DS authentication token is null, please provide a valid token. | | **3DS_TRANSACTION_ID_NULL** | 3DS Authentication Transaction ID must not be null or empty. | Provided 3DS authentication transactionId is null, please provide a valid transaction ID. | | **3DS_TRANSACTION_ID_INVALID** | Invalid 3DS authentication transaction ID, it must be a valid UUID. | Provided 3DS authentication transaction ID is not a UUID, please provide a valid transaction ID. | | **AUTHENTICATION_DETAILS_3DS2_NULL** | 3DS2 details in authentication cannot be empty. | Please provide valid 3DS2 authentication transaction status. | | **3DS2_TRANSACTION_STATUS_NULL** | 3DS2 authentication transaction status must not be null or empty. | Please provide a valid 3DS2 authentication transaction status. | | **3DS2_PROTOCOL_VERSION_INVALID** | Invalid 3DS2 authentication protocol version, it must be in the format of #.#.# where # is a numeric. | Please provide a valid 3DS2 authentication protocol version. | | **3DS2_PROTOCOL_VERSION_LENGTH_INVALID** | Invalid 3DS2 authentication protocol version length must not be greater than 20. | Please provide a valid 3DS2 authentication protocol version. | | **3DS_AUTHENTICATION_VERSION_NULL** | 3DS Authentication version must not be null or empty. | Provided 3DS authentication version is null, please provide a valid version. | | **3DS_AUTHENTICATION_ASC_ECI_NULL** | 3DS Authentication ASC ECI must not be null or empty. | Provided 3DS authentication ASC ECI is null, please provide a valid ASC ECI. | | **3DS_AUTHENTICATION_TRANSACTION_ID_NULL** | 3DS Authentication Transaction ID must not be null or empty. | Provided 3DS authentication transaction ID is null, please provide a valid transaction ID. | | **3DS_AUTHENTICATION_VERSION_INVALID** | Invalid 3DS version. It must be in the format of #.#.# where # is a numeric. | Please provide a valid 3DS authentication version. | | **3DS_AUTHENTICATION_ACS_ECI_INVALID** | Invalid 3DS acsEci. It must be a numeric value. | Please provide a valid 3DS authentication ASC ECI. | | **3DS_AUTHENTICATION_ACS_ECI_LENGTH_INVALID** | Invalid 3DS acsEci length must not be greater than 3. | Please provide a valid 3DS authentication ASC ECI length. | | **3DS_AUTHENTICATION_VERSION_LENGTH_INVALID** | Invalid 3DS authentication version length must not be greater than 20. | Please provide a valid 3DS authentication version. | ## Payment Gateway Donate Specific Error Codes {#payment-gateway-donate-specific-error-codes} These are the donate specific error codes. If any transaction is declined, it will be assigned with any of these error code and messages which explains the reason for the failure. The reason code determines whether donation setups are active or revoked, as mentioned in this table: | Donate Code | Reason Code | Reason Message | Retry in the next month cycle (Y/N/NA) | Inactivate Directly | Inactivate After 2 Additional Trials | |-------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|---------------------|--------------------------------------| | 001 | **INCORRECT_NUMBER** | The card number is incorrect. Please check the card's number and try again using a different card. | NO | YES | NA | | 002 | **TRANSACTION_NOT_ALLOWED** | Your payment was declined. Please use a different card or contact your bank for more information. | NO | YES | NA | | 003 | **INVALID_EXPIRY_YEAR** | The expiration year is invalid. Please check the card's expiration year and try again or use a different card. | NO | NO | NA | | 004 | **DO_NOT_HONOR** | Your card was declined. Please try again using a different card or contact your bank for more information. | YES | NO | YES | | 005 | **INSUFFICIENT_FUNDS** | The card has insufficient funds to complete the purchase. Please use a different card. | YES | NO | YES | | 006 | **PICKUP_CARD** | Your card was declined. Please try again using a different card or contact your bank for more information. | NO | YES | NA | | 007 | **DECLINE** | Your payment was declined. Please use a different card or contact your bank for more information. | YES | NO | NA | | 008 | **FRAUDULENT** | Your payment was declined. Please use a different card or contact your bank for more information. | NO | YES | NA | | 009 | **TEST_MODE_DECLINED** | This test card cannot be used. Please try again using a genuine card. | NO | YES | NA | | 010 | **INVALID_EXPIRY_MONTH** | The expiration month is invalid. Please check the card's expiration month and try again or use a different card. | NO | NO | YES | | 011 | **LOST_CARD** | Your donation was declined. Please try again using a different card or contact your bank for more information. | NO | YES | NA | | 012 | **TRY_AGAIN_LATER** | Your card was declined. Please try again using a different card or contact your bank for more information. | YES | NO | YES | | 013 | **WITHDRAWAL_COUNT_LIMIT_EXCEEDED** | Your card has exceeded the balance or credit limit available. Please try again with a different card. | YES | NO | YES | | 014 | **EXPIRED_CARD** | Your card has expired. Please check the expiration date and try again or use a different card. | NO | YES | NA | | 015 | **AUTHENTICATION_FAILURE** | Your card was declined. Please try again using a different card or contact your bank for more information. | YES | NO | YES | | 016 | **TEST_MODE_CHARGES** | This test card cannot be used. Please try again using a genuine card. | NO | YES | NA | | 017 | **AMOUNT_TOO_SMALL** | The specified amount is less than the minimum amount allowed. Please use a higher amount and try again. | NO | NO | YES | | 018 | **INVALID_PIN** | The card pin is invalid. Please check the card's PIN and try again or use a different card. | NO | YES | NA | | 019 | **STOLEN_CARD** | Your card was declined. Please try again using a different card or contact your bank for more information. | NO | YES | NA | | 020 | **INVALID_ACCOUNT** | The card or account the card is connected to, is invalid. Please use a different card or contact your bank for more information. | NO | YES | NA | | 021 | **INVALID_CVC** | The CVC number is invalid. Please check the card's CVC and try again or use a different card. | NO | YES | NA | | 022 | **PROCESSING_ERROR** | An error occurred while processing your card. Please try again or use a different card. | YES | NO | YES | | 023 | **INCORRECT_CVC** | The card's security code is incorrect. Please check the card's security code and try again or use a different card. | NO | YES | NA | | 024 | **CARD_NOT_SUPPORTED** | Your card does not support this type of purchase. Please use a different card or contact your Bank for more information. | NO | YES | YES | | 025 | **AUTHENTICATION_REQUIRED** | Your card was declined as the transaction requires authentication. Please try again or use a different card. | YES | NO | YES | | 026 | **TIMED_OUT** | We encountered an unexpected issue, please try again to complete your donation. | YES | NO | YES | | 027 | **SYSTEM_ERROR** | We encountered an unexpected issue, please try again to complete your donation. | YES | NO | YES | | 028 | **CALL_ISSUER** | Your card was declined. Please try again using a different card or contact your bank for more information. | NO | NO | YES | | 029 | **SERVICE_NOT_ALLOWED** | Your card was declined. Please try again using a different card or contact your bank for more information. | YES | NO | YES | | 030 | **INVALID_CREDENTIALS** | The card credential is incorrect. Please check the card's credential and try again using a different card. | NO | YES | NA | | 031 | **INVALID_CARD** | The card number is incorrect. Please try again using the correct card number or use a different card. | NO | YES | NA | | 032 | **INVALID_AMOUNT** | The payment amount is invalid or exceeds the amount that is allowed. Please use a different card. | YES | NO | YES | | 033 | **OVER_FREQUENCY_LIMIT** | You have exceeded the frequency limit on your card. Please use a different card or contact your bank for more information. | YES | NO | YES | | 034 | **RESTRICTED_CARD** | Your card was declined. Please try again using a different card or contact your card bank for more information. | YES | NO | YES | | 035 | **TRANSACTION_DECLINED** | Your payment was declined. Please use a different card or contact your bank for more information. | | | | | 036 | **STOP PAYMENT ORDER** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 037 | **SECURITY VIOLATION** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 038 | **REVOCATION OF AUTHORIZATION** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 039 | **REVOCATION OF ALL AUTHORIZATIONS** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 040 | **REENTER TRANSACTION** | YOUR PAYMENT COULD NOT BE PROCESSED BY THE BANK FOR AN UNKNOWN REASON. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | YES | NO | YES | | 041 | **NOT PERMITTED** | YOUR PAYMENT IS NOT PERMITTED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR BANK FOR MORE INFORMATION. | NO | YES | NA | | 042 | **NO ACTION TAKEN** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 043 | **NEW ACCOUNT INFORMATION AVAILABLE** | THE CARD OR THE ACCOUNT THE CARD IS CONNECTED TO, IS INVALID. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR BANK FOR MORE INFORMATION. | NO | YES | NA | | 044 | **MERCHANT BLACKLIST** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | NO | YES | NA | | 045 | **ISSUER NOT AVAILABLE** | THE CARD ISSUER COULDN'T BE REACHED, SO THE PAYMENT COULDN'T BE AUTHORIZED. PLEASE TRY AGAIN OR USE A DIFFERENT CARD OR CONTACT YOUR BANK FOR MORE INFORMATION. | YES | NO | YES | | 046 | **DUPLICATE TRANSACTION** | A TRANSACTION WITH IDENTICAL AMOUNT AND CREDIT CARD INFORMATION WAS SUBMITTED VERY RECENTLY. PLEASE USE A DIFFERENT CARD AND CHECK TO SEE IF A RECENT PAYMENT ALREADY EXISTS. | YES | NO | YES | | 047 | **CURRENCY NOT SUPPORTED** | YOUR CARD DOES NOT SUPPORT THE SPECIFIED CURRENCY. PLEASE USE A DIFFERENT CARD OR CONTACT YOUR BANK FOR MORE INFORMATION. | YES | NO | YES | | 048 | **CARD VELOCITY EXCEEDED** | YOU HAVE EXCEEDED THE BALANCE OR CREDIT LIMIT ON YOUR CARD. PLEASE USE A DIFFERENT CARD OR CONTACT YOUR BANK FOR MORE INFORMATION. | NO | YES | NA | | 049 | **APPROVE WITH ID** | YOUR PAYMENT CAN'T BE AUTHORIZED. PLEASE TRY AGAIN OR USE A DIFFERENT CARD. | YES | NO | YES | | 050 | **DO NOT TRY AGAIN** | YOUR CARD WAS DECLINED. PLEASE TRY AGAIN USING A DIFFERENT CARD OR CONTACT YOUR CARD BANK FOR MORE INFORMATION. | YES | NO | YES |