Payen
Response Codes
Validation Response codes
If a request to the Payen Platform fails validation checks, the response will contain one or more validation codes in the element of the response.
The codes take the form V{A|B|C}nn where:
- A = Missing value
- B = Invalid value
- C = Invalid format
- nn = Indicates the element that has failed validation. see Validation Elements
For example, a validation code of VA22 indicates the expiryDate is missing
The following response shows that three fields failed validation
- JSON
- XML
Validation Failure Response
{
"version": 2,
"merchant": {
"merchantId": 1000002,
"accountId": 2000053
},
"transaction": {
"merchantRef": "9FmdK1a3clgRIRQFX3KM"
},
"status": {
"code": "REJECTED",
"message": "Validation failed",
"reasons": [
"VA22",
"VB8",
"VC20"
],
"timestamp": "2021-10-27T11:45:33.000Z"
}
}
Validation Failure Response
<?xml version="1.0" encoding="UTF-8"?>
<paymentResponse>
<version>2</version>
<merchant>
<merchantId>1000002</merchantId>
<accountId>2000053</accountId>
</merchant>
<transaction>
<merchantRef>9FmdK1a3clgRIRQFX3KM</merchantRef>
</transaction>
<status>
<code>REJECTED</code>
<message>Validation failed</message>
<reasons>
<reason>VA22</reason>
<reason>VB8</reason>
<reason>VC20</reason>
</reasons>
<timestamp>2021-10-27T11:45:33.000Z</timestamp>
</status>
</paymentResponse>
In the above example three fields failed validation:
- VA22 - expiryDate is missing
- VB8 - dateOfBirth contains an invalid value.
- VC20 - securityCode has invalid format
Validation Elements
| Validation Code | Element | Missing Value Code | Invalid Value Code | Invalid Format Code |
|---|---|---|---|---|
| 1 | responseKey | VA1 | VB1 | VC1 |
| 2 | type | VA2 | VB2 | VC2 |
| 3 | merchantId | VA3 | VB3 | VC3 |
| 4 | accountId | VA4 | VB4 | VC4 |
| 5 | customerId | VA5 | VB5 | VC5 |
| 6 | VA6 | VB6 | VC6 | |
| 8 | dateOfBirth | VA8 | VB8 | VC8 |
| 9 | mobileNumber | VA9 | VB9 | VC9 |
| 10 | addressLine1 | VA10 | VB10 | VC10 |
| 11 | addressLine2 | VA11 | VB11 | VC11 |
| 12 | city | VA12 | VB12 | VC12 |
| 13 | province | VA13 | VB13 | VC13 |
| 14 | postcode | VA14 | VB14 | VC14 |
| 15 | country | VA15 | VB15 | VC15 |
| 16 | cardNumber | VA16 | VB16 | VC16 |
| 20 | securityCode | VA20 | VB20 | VC20 |
| 21 | startDate | VA21 | VB21 | VC21 |
| 22 | expiryDate | VA22 | VB22 | VC22 |
| 23 | issueNumber | VA23 | VB23 | VC23 |
| 24 | amount | VA24 | VB24 | VC24 |
| 25 | currency | VA25 | VB25 | VC25 |
| 26 | description | VA26 | VB26 | VC26 |
| 27 | merchantRef | VA27 | VB27 | VC27 |
| 28 | transactionType | VA28 | VB28 | VC28 |
| 30 | countryOfOrigin | VA30 | VB30 | VC30 |
| 44 | responseUrl | VA44 | VB44 | VC44 |
| 47 | notificationUrl | VA47 | VB47 | VC47 |
| 48 | digest | VA48 | VB48 | VC48 |
| 49 | message is invalid | VA49 | VB49 | VC49 |
| 50 | title | VA50 | VB50 | VC50 |
| 51 | firstName | VA51 | VB51 | VC51 |
| 52 | surname | VA52 | VB52 | VC52 |
| 53 | houseNameNumber | VA53 | VB53 | VC53 |
| 54 | addressLine3 | VA54 | VB54 | VC54 |
| 55 | limit.paymentMethodType | VA55 | VB55 | VC55 |
| 56 | limitType | VA56 | VB56 | VC56 |
| 57 | limitCurrency | VA57 | VB57 | VC57 |
| 58 | limitAmount | VA58 | VB58 | VC58 |
| 59 | paymentInfoCountry | VA59 | VB59 | VC59 |
| 60 | paymentMethodType | VA60 | VB60 | VC60 |
| 61 | thirdPartySuccessUrl | VA61 | VB61 | VC61 |
| 62 | thirdPartyCancelUrl | VA62 | VB62 | VC62 |
| 63 | token | VA63 | VB63 | VC63 |
| 64 | threeDSecureOverride | VA64 | VB64 | VC64 |
| 65 | md | VA65 | VB65 | VC65 |
| 66 | paRes | VA66 | VB66 | VC66 |
| 67 | accountName | VA67 | VB67 | VC67 |
| 68 | accountNumber | VA68 | VB68 | VC68 |
| 69 | accountSortCode | VA69 | VB69 | VC69 |
| 70 | reference | VA70 | VB70 | VC70 |
| 71 | disableNewPaymentMethods | VA71 | VB71 | VC71 |
| 72 | periodStartDate | VA72 | VB72 | VC72 |
| 73 | periodEndDate | VA73 | VB73 | VC73 |
| 74 | reportFormat | VA74 | VB74 | VC74 |
| 75 | locale | VA75 | VB75 | VC75 |
| 76 | merchCssUrl | VA76 | VB76 | VC76 |
| 77 | Duplicate element | VA77 | VB77 | VC77 |
| 78 | ipAddress | VA78 | VB78 | VC78 |
| 79 | externalFraudReference | VA79 | VB79 | VC79 |
| 80 | acceptHeader | VA80 | VB80 | VC80 |
| 81 | javaScriptEnabled | VA81 | VB81 | VC81 |
| 82 | javaEnabled | VA82 | VB82 | VC82 |
| 83 | Language | VA83 | VB83 | VC83 |
| 84 | screenHeight | VA84 | VB84 | VC84 |
| 85 | screenWidth | VA85 | VB85 | VC85 |
| 86 | timeDifference | VA86 | VB86 | VC86 |
| 87 | userAgent | VA87 | VB87 | VC87 |
| 88 | colorDepth | VA88 | VB88 | VC88 |
| 89 | challengeWindowSize | VA89 | VB89 | VC89 |
| 90 | parentRef | VA90 | VB90 | VC90 |
| 91 | parentRef | VA91 | VB91 | VC91 |
| 92 | eci | VA92 | VB92 | VC92 |
| 93 | version | VA93 | VB93 | VC93 |
| 94 | authenticationValue | VA94 | VB94 | VC94 |
| 95 | dsTransID | VA95 | VB95 | VC95 |
| 96 | threeDSServerTransID | VA96 | VB96 | VC96 |
| 97 | dpan | VA97 | VB97 | VC97 |
| 98 | eciIndicator | VA98 | VB98 | VC98 |
| 99 | cryptogram | VA99 | VB99 | VC99 |
| 100 | applicationExpirationDate | VA100 | VB100 | VC100 |
| 101 | cardHolderName | VA101 | VB101 | VC101 |
| 102 | token | VA102 | VB102 | VC102 |
Transaction Response Codes
| Response Code | Description | Action |
|---|---|---|
| 0 | Success - The transaction or operation was successful. | N/A |
| 1 | Declined - The transaction or operation was declined. | N/A |
| 2 | Declined – CVV2 Check Failed The CVV2 check performed by the issuer / acquirer has failed the checking strategy applied to the merchant configuration. | N/A |
| 3 | Declined - 3D Secure Failure The transaction has failed 3D secure verification. | N/A |
| 4 | Access Denied - Access to the particular Request Type has not been configured for access to the merchant. | Contact Support if the feature in question is required. |
| 5 | Declined – AVS Address Check Failed The AVS check for address line performed by the issuer/acquirer has failed the checking strategy applied to the merchant configuration. | N/A |
| 6 | Declined – AVS Post Code Check Failed The AVS check for post code performed by the issuer/acquirer has failed the checking strategy applied to the merchant configuration. | N/A |
| 7 | Pending Auth The payment has been submitted for authorisation. | N/A |
| 8 | Pending Settlement - The payment has been authorised and is pending settlement | N/A |
| 9 | 3D Secure Required - 3D Secure authentication is required. | N/A |
| 10 | Partial Payment - A partial payment has been received. | N/A |
| 11 | Overpayment - An overpayment has been received. | N/A |
| 12 | Declined - Soft Decline - Strong Customer Authentication required. | N/A |
| 13 | Declined - Not Enrolled - Declined because card is not enrolled for 3DS. | N/A |
| 550 | Rejected - Rejected because the token is blocked. | N/A |
Request Validation Response Codes
| Response Code | Description | Action |
|---|---|---|
| 100 | Request failed validation The incoming request did not conform to the expected format. | Check the validationErrors field in the response for specific failures. Please refer to the validation errors section for more detail. |
| 101 | Invalid Merchant Credentials The digest check of the incoming message failed. | Please refer to the implementation guide for correct digest calculation procedures. |
| 102 | Duplicate Merchant Ref The Merchant ref field supplied in the incoming request was not unique. | Ensure unique references are used for each transaction. |
| 103 | Invalid Currency An attempt to send a CAPTURE, REVERSAL or REFUND request failed as the currency supplied does not match the currency of the original transaction. | Ensure the currency used for secondary operations matches that of the original operation. |
| 104 | No Matching Transaction An attempt to send a CAPTURE, REVERSAL or REFUND request failed as the reference supplied did not match an existing transaction or matched a transaction that is not of the correct type. | Ensure the correct merchant transaction reference is used. |
| 105 | Transaction Not Authorised An attempt to send a CAPTURE, REVERSAL or REFUND request failed as the original transaction was not authorised. | Ensure the correct merchant transaction reference is used. |
| 106 | Transaction Already Reversed An attempt to send a REVERSAL request failed as the transaction has already been voided/reversed. | Ensure the correct merchant transaction reference is used. |
| 107 | Transaction Already Refunded An attempt to REFUND a transaction has failed as the original transaction has already been refunded. | Ensure the correct merchant transaction reference is used. |
| 108 | Cannot CAPTURE An attempt to CAPTURE a transaction has failed as the original transaction was not of type AUTH. | Ensure the correct merchant transaction reference is used. |
| 109 | Cannot REVERSE/VOID An attempt to send a REVERSAL request failed as the original transaction was not of a reversible type. | Ensure the correct merchant transaction reference is used. |
| 110 | Transaction Already Settled An attempt to send a REVERSAL request failed as the transaction has already been processed for settlement. | Ensure the correct transaction reference is used. If reference is correct and the transaction has been settled then a REFUND is required. |
| 111 | Transaction Not Captured An attempt to REFUND a transaction has failed as the original transaction has not been captured. | Ensure the correct transaction reference is used, send a REVERSAL request or CAPTURE the transaction before attempting a REFUND. |
| 112 | Transaction Already Captured An attempt to CAPTURE a transaction has failed as the original transaction has already been captured. | Ensure the correct transaction reference is used. |
| 113 | No Transaction Type Supplied No transaction type has been supplied in the incoming request and no default has been configured. | Supply the required Transaction Type. |
| 114 | Invalid Transaction Type. A Transaction Type of CNP_ECOMMERCE must be used for web payment page transactions | Supply the correct Transaction Type according to the operation being performed. |
| 115 | Maestro Transaction Not Allowed Maestro transactions are only permitted on 3D Secure ecommerce transactions | Please contact Support about options for processing Maestro Cards. |
| 116 | Transaction already charged back The transaction has already been charged back. | N/A |
| 117 | Operation already in progress for this merchant There is an operation that is currently being processed for this transaction and the platform only allows one operation at a time per transaction. For example | you cannot process a CAPTURE and a REVERSAL at the same time. Ensure that there cannot be more than one operation on the transaction in progress at the same time. |
| 118 | The supplied card token does not exist There card token supplied in the request does not exist. | Ensure that the card token provided is valid and has been received from a previous transaction. |
| 119 | The supplied customer email address already exists against another customer id If configured for the Merchant | any customer email address that been previously used before against a different customer id will be rejected. There can only be one usage of an email address across customers. Ensure that the supplied email address has not been previously used by another customer. |
| 120 | Transaction NOT refundable The previous payment attempt is not refundable via the Direct API. | Ensure the correct merchant transaction reference is used. Otherwise the previous payment attempt may have been performed using a payment method that is not refundable via the Direct API. |
| 121 | Invalid Funding Method The passed payment method token either does not exist or does not belong to the customer. | Ensure the token along with payment method type are correct. |
| 121 | Duplicate Card. Attempting to perform an action using a new card where a previous customer has already used that card. For fraud purposes a card can only be registered to one customer. | N/A |
| 123 | Original Not Pending An attempted follow up request has been made on a transaction where the status of the transaction is not PENDING and must be to perform the current request. | Ensure that the original transaction responded with the expected PENDING code. |
| 124 | Already Fully Refunded Transaction has already been fully refunded | No more refunds can be made against the transaction. |
| 125 | Refund Amount Exceeds Original Refund amount would exceed the original authorisation amount | Refunds for a transaction must not total more than the original authorised amount. |
| 126 | Original Can Not Be Credited The original transaction is not eligible to be credited | The original transaction must be a successful authorisation. |
| 128 | The request functionality is currently unavailable Operation type has not been configured for this account | Ensure that correct operation type is in use. |
| 131 | Card type not permitted Card type has not been configured or is not permitted | Ensure Card Type is permitted on account. |
| 132 | There must be a previous sale (authorisation and capture) to carry out this type of transaction | Ensure there is a previous successful authorisation and capture |
| 133 | This type of operation is not supported for this merchant | Please contact Support about options for processing the operation type. |
| 134 | Acquirer received invalid data | could not complete processing of this transaction. Please contact support |
| 135 | 3D Secure is mandatory in card issuing country | Use a 3DS configured account to process transactions for cards issued from mandatory 3DS countries. See :ref:Mandatory 3DS Countries |
| 136 | Province format is invalid. | Format - Any UTF-8 characters 0-200 Chars. For Canadian addresses this must be in the ISO 3166-2 Format <https://www.iso.org/obp/ui/#iso:code:3166:CA>_ |
| 137 | Not permitted province for the request to process. | N/A |
| 138 | The parent transaction is not in the required state. | Please make sure the parent transaction satisfies the requirements. |
| 139 | The Province is missing. | Supply the required Province. |
| 140 | The City is missing. | Supply the required City. |
| 141 | Invalid payment token. The ApplePay or GooglePay token failed to be decrypted | Contact support. |
| 142 | Reversal amount does not match original transaction | Partial voids/reversals are not supported. Ensure the requested amount matches the original transaction amount. |
| 143 | The Apple Pay token has expired. Typically the token must be submitted within 5 minutes of creation. | |
| 144 | The Apple Pay token is invalid. The token failed verification against hte latest Apple Pay nad Merchant certificates. | |
| 145 | Unable to verify the Apple Pay token. The token could not be processed | possibly corrupted. |
Limit Checking Response Codes
| Response Code | Description | Action |
|---|---|---|
| 200 | Merchant Authorisation Amount Limit Returned when a merchant authorised amount limit has been reached. When active, this limitation ensures that there is a limit on the total value of authorised transactions for a configured period. | Limits are configurable. If you wish to change limits please contact Support. |
| 201 | Merchant Authorisation Count Limit Returned when a merchant authorised transaction count limit has been reached. When active, this limitation ensures that there is a limit on the total number of successfully authorised transactions for a configured period. This limit takes into account all transactions for that merchant. | Limits are configurable. If you wish to change limits please contact Support. |
| 202 | Customer Authorisation Amount Limit Returned when a customer authorised amount limit has been reached. When active, this limitation ensures that there is a limit on the total value of authorised transactions for a configured period per customer. | Limits are configurable. If you wish to change limits please contact Support. |
| 203 | Customer Authorisation Count Limit Returned when a customer authorised transaction count limit has been reached. When active, this limitation ensures that there is a limit on the total number of successfully authorised transactions for a configured period per customer. | Limits are configurable. If you wish to change limits please contact Support. |
| 204 | Transaction Amount Limit This limit ensures a hard limit on the transaction amount for all transactions made through this merchant. Any transactions that exceed this amount limit will be rejected. | Limits are configurable. If you wish to change limits please contact Support. |
| 205 | Credit Success Sum Limit Returned when a limit on the sum of spending or account loading has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 206 | Credit Success Count Limit Returned when a limit on the number of successful transactions has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 207 | Credit Decline Sum Limit Returned when a limit on the sum of declined transactions or account loading has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 208 | Credit Decline Count Limit Returned when a limit on the number of declined transactions or account loading has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 209 | Debit Success Sum Limit Returned when a limit on the sum of refunding or account withdrawal has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 210 | Debit Success Count Limit Returned when a limit on the number of refunds or account withdrawals has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 211 | Debit Decline Sum Limit Returned when a limit on the sum of declined refunds or account withdrawals has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 212 | Debit Decline Sum Count Returned when a limit on the number of declined refunds or account withdrawals has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 213 | MerchantTransactionLimit Returned when a merchant limit has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 214 | Transaction Minimum Amount Limit Returned when a transaction amount lower than the configured minimum is attempted. | Limits are configurable. If you wish to change limits please contact Support. |
| 215 | Card Use Count Limit Returned when the number of transactions using the same card has been reached. | Limits are configurable. If you wish to change limits please contact Support. |
| 216 | Card Use Sum Limit Returned when the number of transactions using the same card has been reached | Limits are configurable. If you wish to change limits please contact Support. |
Communication Response Codes
| Response Code | Description | Action |
|---|---|---|
| 701 | Acquirer Exception There was an exception communicating with the acquirer | A void request will automatically be attempted for this transaction. Please re-submit |
| 702 | Acquirer Timeout A timeout has occurred communicating with the acquirer | A void request will automatically be attempted for this transaction. Please re-submit |
| 703 | Acquirer not responding A request has been sent to the acquirer, but no response has been received | A void request will automatically be attempted for this transaction. Please re-submit |
| 704 | No TIDs available There are no terminal IDs available to service online authorisation requests | You may require additional terminal ids. Please contact Support |
| 705 | Acquirer Refused The request has been refused by the acquirer | Please contact Support |
Internal Processing Response Codes
| Response Code | Description | Action |
|---|---|---|
| 900 | Timeout If a 3D secure complete request then if the request is received greater than 30 minutes after the initial payment authorisation request then the request will be rejected with a reason of timeout. Otherwise an internal platform timeout has occurred. | If not a 3D secure complete request then please contact Support |
| 901 | Account Routing Failed Internal routing failed. | Please contact Support |
| 902 | No 3D Secure Configuration Found Configuration required to perform 3D Secure transactions could not be located. | Please contact Support |
| 903 | Acquirer Response Code Not Recognised The response code from the acquirer has not been recognised. | Please contact Support |
| 999 | System Error An internal platform system error has occurred. | Please contact Support |
Fraud Response Codes
| Response Code | Description | Action |
|---|---|---|
| 1001 | IIN Blocked An internal black list has blocked the card. | Please contact Support |
| 1002 | BIN ISSUE COUNTRY BLOCKED The issuing country of the card BIN is blocked. | Please contact Support |
| 1003 | COUNTRY OF ORIGIN BLOCKED The country from which the transaction originated is blocked | Please contact Support |
| 1004 | BILLING ADDRESS COUNTRY BLOCKED The billing address country is blocked | Please contact Support |