valueLinkDeactivationTransactions
POST
Gift Card Additional
Use this method for ValueLink® gift card transactions. Supported transactions: Balance Inquiry.
https://api-cert.payeezy.com/v1 /transactions
-
NameValueDescription
-
apikey
(required)This is used to identify the app. -
token
(required)This is used to identify the merchant -
Content-type
(required)content type the payload requires -
Authorization
(required)HMAC of payload signed using api secret
Create HMAC
API Secret
Dear Developer,
Please be aware that HMAC Signature is valid upto 5 min for Authorization purpose.
Generate HMAC
Construct the data param by appending the parameters below in the same order as shown.
a. apikey - API key of the developer.
b. nonce - secure random number.
c. timestamp - epoch timestamp in milliseconds.
d. token - Merchant Token.
e. payload - Actual body content passed as post request.
Compute HMAC SHA256 hash on the above data param using the key below
f. apiSecret - Consumer Secret token for the given api key
Calculate the base64 of the hash which would be our required Authorization header value.
// import required header files
#import <CommonCrypto/CommonDigest.h>;
#import <CommonCrypto/CommonHMAC.h>;
NSString* apiKey = @"<your api key>";
NSString* apiSecret = @"<your consumer secret>";
NSString* token = @"<Merchant Token>";
NSString* payload = @"<For POST - Request body / For GET - empty string>";
NSString* nonce = @"<Crypographically strong random number>";
NSString* timestamp = @"<Epoch timestamp in milli seconds>";
NSString *hmacData =
[NSString stringWithFormat:@"%@%@%@%@%@",apiKey,nonce,timestamp,token,payload];
// Make sure the HMAC hash is in hex
unsigned char outputHMAC[CC_SHA256_DIGEST_LENGTH];
const char* keyChar = [apiSecret cStringUsingEncoding:NSUTF8StringEncoding];
const char* dataChar = [hmacData cStringUsingEncoding:NSUTF8StringEncoding];
CCHmac(kCCHmacAlgSHA256, keyChar, strlen(keyChar), dataChar, strlen(dataChar), outputHMAC);
NSData* hmacHash =
[[NSData alloc] initWithBytes:outputHMAC length:sizeof(outputHMAC)];
// The conversion (NSData to HexString) shown below is just an example.
Please use other appropriate methods to do the conversion.
NSString* hmacHashHexString =
[[hmacHash description] stringByReplacingOccurrencesOfString:@" " withString:@""];
// Authorization : base64 of hmac hash -->
NSString* authorization =
[[hmacHashHexString dataUsingEncoding:NSUTF8StringEncoding] base64EncodedStringWithOptions:0];
NSLog(@"Authorization Generated: %@",authorization);
<?php
$apiKey = "<your api key>";
$apiSecret = "<your consumer secret>";
$nonce = "<Crypographically strong random number>";
$timestamp = "<Epoch timestamp in milli seconds>";
$token = "<Merchant Token>";
$payload = "<For POST - Request body / For GET - empty string>";
$data = $apiKey + $nonce + $timestamp + $token + $payload;
$hashAlgorithm = "sha256";
<!-- Make sure the HMAC hash is in hex -->
$hmac = hash_hmac ( $hashAlgorithm , $data , $apiSecret, false );
<!-- Authorization : base64 of hmac hash -->
$authorization = base64_encode($hmac);
ehco $authorization;
?>
#import required libs to generate HMAC
import os,hashlib,hmac,time,base64
apiKey = "<your api key>"
apiSecret = "<your consumer secret>"
token = "<Merchant Token>"
payload = "<For POST - Request body / For GET - empty string>"
# Crypographically strong random number
nonce = str(int(os.urandom(16).encode('hex'),16))
# Epoch timestamp in milli seconds
timestamp = str(int(round(time.time() * 1000)))
data = apiKey + nonce + timestamp + token + payload
# Make sure the HMAC hash is in hex
hmac = hmac.new(apiSecret, msg=data, digestmod=hashlib.sha256).hexdigest()
# Authorization : base64 of hmac hash
authorization = base64.b64encode(hmac);
print authorization
Resource Summary
| Category | Gift Card Transactions |
This is the place where request body description lies.
This is the place where response body description lies.
This is the place where EventTypes description lies.
Sample Error Messages & Error Codes.
This is where error messages sample and description lies.
This is the place where HTTP Status Codes.
This is the place where API Error Codes.
Expiry Date:
Any future date.
Cvv: Any 3 digit number for Visa, Mastercard & Discover and 4 digit number for American Express
Cvv: Any 3 digit number for Visa, Mastercard & Discover and 4 digit number for American Express
| Type | Card Number |
|---|---|
| Visa | 4012 0000 3333 0026 |
| 4005 5192 0000 0004 | |
| MasterCard | 5424 1802 7979 1732 |
| 5526 3990 0064 8568 | |
| 5405 0101 0000 0016 | |
| American Express | 3739 5319 2351 004 |
| 3411 1159 7241 002 | |
| Discover | 6510 0000 0000 1248 |
Working...
Request valueLinkDeactivationTransactions permissions
Making valueLinkDeactivationTransactions API requests requires you to grant access to this app.
You will be directed to valueLinkDeactivationTransactions to approve the use of your credentials and then returned to this page.
You can revoke these permissions at any time.
Gateway Response
Payeezy Gateway Response Codes
Payeezy gateway Response code indicates the status of a transaction as it is sent to the financial institution and returned to the client.
Ex: The Response Code "00" (Transaction Normal) indicates that the transaction was processed normally. Any response other than "00" indicates that it was not normal.
| Code | Description |
|---|---|
| This response code indicates that the transaction was processed normally. Please refer to the bank and approval response information for bank approval Status. | |
| 00 | Transaction Normal |
| The following response codes indicate invalid data in the transaction. In these cases, the data should be changed before attempting to resend the transaction. These response codes are generated by the remote Plug-In. | |
| 08 | CVV2/CID/CVC2 Data not verified |
| 22 | Invalid Credit Card Number |
| 25 | Invalid Expiry Date |
| 26 | Invalid Amount |
| 27 | Invalid Card Holder |
| 28 | Invalid Authorization No |
| 31 | Invalid Verification String |
| 32 | Invalid Transaction Code |
| 57 | Invalid Reference No |
| 58 | Invalid AVS String, The length of the AVS String has exceeded the max. 40 characters |
| 60 | Invalid Customer Reference Number |
| 63 | Invalid Duplicate |
| 64 | Invalid Refund |
| 68 | Restricted Card Number |
| 69 | Inavlid Transaction Tag |
| 72 | Data within the transaction is incorrect |
| 93 | Invalid authorization number entered on a pre-auth completion |
| The following response codes indicate a problem with the merchant configuration at the financial institution. Please contact Payeezy for further investigation. | |
| 11 | Invalid Sequence No |
| 12 | Message Timed-out at Host |
| 21 | BCE Function Error |
| 23 | Invalid Response from Payeezy |
| 30 | Invalid Date From Host |
| The following response codes indicate a problem with the Global Gateway e4℠ host or an error in the merchant configuration. Please contact Payeezy for further investigation. | |
| 10 | Invalid Transaction Description |
| 14 | Invalid Gateway ID |
| 15 | Invalid Transaction Number |
| 16 | Connection Inactive |
| 17 | Unmatched Transaction |
| 18 | Invalid Reversal Response |
| 19 | Unable to Send Socket Transaction |
| 20 | Unable to Write Transaction to File |
| 24 | Unable to Void Transaction |
| 37 | Payment Type Not Supported By Merchant |
| 40 | Unable to Connect |
| 41 | Unable to Send Logon |
| 42 | Unable to Send Trans |
| 43 | Invalid Logon |
| 52 | Terminal not Activated |
| 53 | Terminal/Gateway Mismatch |
| 54 | Invalid Processing Center |
| 55 | No Processors Available |
| 56 | Database Unavailable |
| 61 | Socket Error |
| 62 | Host not Ready |
| The following response codes indicate the final state of a transaction. In the event of one of these codes being returned, please contact Payeezy for further investigation. | |
| 44 | Address not Verified |
| 70 | Transaction Placed in Queue |
| 73 | Transaction Received from Bank |
| 76 | Reversal Pending |
| 77 | Reversal Complete |
| 79 | Reversal Sent to Bank |
| The following response codes indicate the final state of a transaction due to custom Fraud Filters created by the Merchant. | |
| F1 | Address check failed - Fraud suspected |
| F2 | Card/Check Number check failed - Fraud suspected |
| F3 | Country Check Failed - Fraud Suspected |
| F4 | Customer Reference Check Failed - Fraud Suspected |
| F5 | Email Address check failed - Fraud suspected |
| F6 | IP Address check failed - Fraud suspected |
| 17000 | Function performed error-free |
| 17002 | Refer to card issuer |
| 17003 | Invalid merchant |
| 17004 | Do not honour |
| 17005 | Do not honour |
| 17006 | Invalid Transaction for Terminal |
| 17007 | Honour with ID |
| 17008 | Time-Out |
| 17002 | No Original |
| 17010 | Unable to Reverse |
| 17011 | Partial Approval |
| 17012 | Invalid transaction card / issuer / acquirer |
| 17013 | Invalid amount |
| 17014 | Invalid card number |
| 17017 | Invalid Capture date (terminal business date) |
| 17019 | System Error Re-enter transaction |
| 17020 | No From Account |
| 17021 | No To Account |
| 17022 | No Checking Account |
| 17023 | No Saving Account |
| 17024 | No Credit Account |
| 17030 | Format error |
| 17034 | Implausible card data |
| 17039 | Transaction Not Allowed |
| 17041 | Lost Card |
| 17042 | Special Pickup |
| 17043 | Hot Card |
| 17044 | Pickup Card |
| 17051 | Not sufficient funds |
| 17054 | Expired card |
| 17055 | Incorrect PIN Re-enter |
| 17057 | Transaction not permitted on card |
| 17058 | Txn Not Permitted On Term |
| 17059 | Suspected Fraud |
| 17061 | Exceeds amount limit |
| 17062 | Restricted card |
| 17063 | MAC Key Error |
| 17065 | Exceeds frequency limit |
| 17066 | Exceeds Acquirer Limit |
| 17067 | Retain Card no reason specified |
| 17068 | Used to indicate the reason for sending a reversal – an authorisation response was not returned within the time limit Response received too late |
| 17075 | Exceeds PIN Retry |
| 17076 | Invalid Account |
| 17077 | Issuer Does Not Participate In The Service |
| 17078 | Function Not Available |
| 17079 | Key Validation Error |
| 17080 | Approval for Purchase Amount Only |
| 17081 | Unable to Verify PIN |
| 17082 | Invalid Card Verification Value |
| 17083 | Not declined (Valid for all zero amount transactions) |
| 17084 | Invalid Life Cycle of transaction |
| 17085 | No Keys To Use |
| 17086 | K M E Sync Error |
| 17087 | PIN Key Error |
| 17088 | MAC sync Error |
| 17089 | Security Violation |
| 17091 | Issuer not available |
| 17092 | Invalid Issuer |
| 17093 | Transaction cannot be completed |
| 17094 | Invalid originator |
| 17095 | Contact Acquirer |
| 17096 | System malfunction |
| 17097 | No Funds Transfer |
| 17098 | Duplicate Reversal |
| 17099 | Duplicate Transaction |
| 17243 | Cash Service Not Available |
| 17244 | Cash Back Request Exceeds Issuer Limit |
| 17280 | Stop Payment Order |
| 17281 | Revocation of Authorisation Order |
| 17283 | Revocation of all Authorisations Order |
| 05 | Declined by card issuing bank |
| -5101 | 3D Secure authentication failed |
| -5103 | Cardholder did not return from ACS |
| 62 | Card locked |
| 05 | DECLINED |
| 05 | INSUFF FUNDS |
| -5005 | FRAUD - Duplicate lockout |
| -5993 | Cancelled by user |
| -2304 | Invalid or expired card expiry date |
| 05 | NOT AUTHORISED |
| -5003 | The order already exists in the database. |
| -10501 | PostAuth already performed |
| -5104 | Cardholder did not return from PayPal |
| -5005 | FRAUD - Card temporarily blocked (Autolockout) |
| 04 | Card used is not permitted |
| -5106 | Cardholder did not return from SOFORT |
| 92 | Card Issuer not found |
| 34 | Suspicion of manipulation |
| -P00001 | Cancelled by user. |
| 56 | Card not in authoriser's database |
| 33 | Card expiry date exceeded |
| -5105 | Cardholder did not return from direkt |
| 12 | Authorisation declined (e. g. wrong expiry date or currency) |
| 1940 | invalid BIC in Senderaccount CMCIDEDD |
| -5019 | Transaction not voidable |
| 100 | do not honour |
| -8018 | Transaction not found, probably cancelled by user |
| -1 | Invalid account data |
| -5102 | ECI 7 |
| 05 | Do not honour |
| 14 | Card invalid |
| -5002 | brand not supported |
| 10486 | This transaction couldn't be completed. Please redirect your customer to PayPal. |
| -5003 | The order already exists in the database. |
| 51 | Not sufficient funds |
| 05 | DECL PICKUP CARD |
| 3100 | Transaction cancelled by user |
| -5100 | Invalid 3D Secure values |
| 54 | Expired card |
| -5994 | The selected brand does not match the card number. |
| -2303 | Invalid credit card number |
| -30031 | No terminal setup |
| 96 | Scheme or Issuer currently cannot authorize |
| 05 | CARD EXPIRED |
| 05 | REFERRAL A |
| -12000 | Card security code is mandatory |
| 2000 | Timeout while entering PIN / TAN |
| -30057 | Communication Error |
| -5995 | order too old to be referenced |
| 02 | Payment rejected, refer to Card Issuer |
| -10503 | Invalid amount or currency |
| 10422 | The customer must return to PayPal to select new funding sources. |
| -5010 | Hosted data was not found |
| 13 | INVALID AMOUNT |
| 43 | Stolen card |
| -5004 | No authorized preauth found |
| -5005 | FRAUD - Card's BIN blocked |
| None | Authorization has expired. |
| 05 | C-H CANCELLED RT |
| -10424 | No further PostAuth possible for this Order ID |
| 3100 | Cancelled by user |
| 10009 | You are over the time limit to perform a refund on this transaction |
| -10601 | Total amount passed is more than the Return/Void amount. |
| 12 | INVALID TXN |
| 14 | INVALID CARD |
| -30031 | No terminal found |
| -30060 | Internal Error |
| 4900 | Transaction not authorized |
| -5005 | FRAUD - Purchase limit exceeded |
| 86 | Unknown master data |
| 955 | GIROPAY FIDUCIA |
| None | Transaction rejected, please contact the buyer. |
| 01 | Unknown Processor Response Code |
| 02 | REFERRAL B |
| 05 | AUTH PROHIBITED |
| 05 | DO NOT TRY AGAIN |
| 05 | RESTRICTED CARD |
| 05 | UNABLE TO AUTH |
| 10009 | You can not refund this type of transaction |
| 12 | DECLINED |
| 13 | Available amount exceeded |
| -30063 | Transaction type not supported for this endpoint |
| 31 | Card issuer not permitted |
| 3900 | Bank went offline |
| 4900 | Declined |
| 55 | Incorrect personal identification number |
| -5992 | Connect extended hash already used |
| 902 | invalid transaction |
| 92 | Invalid Issuer |
| -5991 | Invalid direct debit track data, track three is missing |
| The following response codes indicate a problem with Payeezy℠ Gateway or an error in the merchant configuration. Please contact Payeezy for further investigation. | |
Additional PayPal Transaction
Resource URL: https://api-cert.payeezy.com/v1/transactions/{id}
PayPal Tagged Void
“transaction tag” parameter is based on a PayPal Primary Order, Authorize or Purchase Transaction.
| Request Payload | Response Payload |
|---|---|
|  { "merchant_ref": "{string}", "transaction_type": "void", "transaction_tag": "{string}", "amount": "{string}", "currency_code": "USD" } | { "amount": "{string}", "currency": "{string}", "transaction_status": "{string}", "validation_status": "{string}", "transaction_type": "void", "transaction_id": "{string}", "transaction_tag": "{string}", "bank_resp_code": "{string}", "bank_message": "{string}", "gateway_resp_code": "{string}", "gateway_message": "{string}", "correlation_id": "{string}" } |
PayPal Tagged Refund
“transaction tag” parameter is based on a PayPal Order, Capture, or Purchase Transaction.
| Request Payload | Response Payload |
|---|---|
| { "merchant_ref": "{string}", "transaction_type": "refund", "transaction_tag": "{string}", "amount": "{string}", "currency_code": "USD" } | { "amount": "{string}", "currency": "{string}", "transaction_status": "{string}", "validation_status": "{string}", "transaction_type": "refund", "transaction_id": "{string}", "transaction_tag": "{string}", "bank_resp_code": "{string}", "bank_message": "{string}", "gateway_resp_code": "{string}", "gateway_message": "{string}", "correlation_id": "{string}" } |
Ta_Token
This is the Transarmor Token. This value can be obtained from the Payeezy gateway merchant portal as shown below.Note: This is required for US merchants only.
- Step 1: Please log into your Virtual Terminal ( https://globalgatewaye4.firstdata.com)
- Step 2: Navigate to Terminals tab and Select your terminal.
- Step 3: As shown below, retrieve the transarmor token value. This is your ta_token parameter.
- For SANDBOX (CERT) test merchant account, please set ta_token=123.
- For LIVE merchant account, capture tatoken value as shown below.
Additional Reverse Gift Card Transaction
Resource URL: https://api-cert.payeezy.com/v1/transactions/{id}
Gift Card Tagged Void
Please Note: “transaction tag” parameter is based on a ValueLink Primary Purchase Transaction.
| Request Payload | Response Payload |
|---|---|
|  { "amount": "{string}", "transaction_type": "void", "transaction_tag": "{string}", "method": "valuelink", "currency_code": "USD", "valuelink": { "cardholder_name": "{string}", "cc_number": "{string}", "credit_card_type": "Gift" } } | { "method": "valuelink", "amount": "{string}", "currency": "{string}", "valuelink": { "cardholder_name": "{string}", "cc_number": "{string}", "credit_card_type": "Gift", "previous_balance": "{string}", "current_balance": "{string}" } "transaction_status": "{string}", "validation_status": "{string}", "transaction_type": "void", "transaction_id": "{string}", "transaction_tag": "{string}", "bank_resp_code": "{string}", "bank_message": "{string}", "gateway_resp_code": "{string}", "gateway_message": "{string}", "correlation_id": "{string}" } |
Gift Card Tagged Refund
Please Note: “transaction tag” parameter is based on a ValueLink Primary Purchase Transaction.
| Request Payload | Response Payload |
|---|---|
| { "amount": "{string}", "transaction_type": "refund", "transaction_tag": "{string}", "method": "valuelink", "currency_code": "USD", "valuelink": { "cardholder_name": "{string}", "cc_number": "{string}", "credit_card_type": "Gift" } } | { "amount": "{string}", "currency": "{string}", "transaction_status": "{string}", "validation_status": "{string}", "transaction_type": "refund", "transaction_id": "{string}", "transaction_tag": "{string}", "bank_resp_code": "{string}", "bank_message": "{string}", "gateway_resp_code": "{string}", "gateway_message": "{string}", "correlation_id": "{string}" } |
Payeezy-Paypal Integration
Paypal Registration
Before submitting Paypal transactions (ORDER, AUTHORIZE, PURCHASE) to Payeezy, merchant has to obtain Paypal business account and obtain API credentials (user name, password and signature).
"Click here" for obtaining the credentials.
Payeezy - E4 Registration
Merchant needs to provide his Paypal API user, password and signature to be registered with his E4 terminal. The image below shows the same.
Paypal Express Checkout API integration
Merchant has to integrate with Paypal Express Checkout API. "Click here" for details.
Note: Note: The way Paypal works is that manual approval of transaction has to be done by customer in the Paypal GUI before you could process that transaction with Payeezy. The image below shows the same.
Once Paypal Express Checkout transaction competes, you get the output such as below:
{
TRANSACTIONID = O - 1 XW865551D308884E, METHOD = GetTransactionDetails
};
nvpResponse - {
TRANSACTIONID=O-1XW865551D308884E,
AMT=0.07,
CORRELATIONID=c9e47ba37b784,
HANDLINGAMT=0.00,
L_AMT0=0.05,
L_CURRENCYCODE0=USD,
TAXAMT=0.00,
L_AMT1=0.02,
SHIPTOCITY=randolph,
SHIPTOCOUNTRYCODE=US,
FIRSTNAME=User,
PENDINGREASON=order,
VERSION=61.0,
SHIPTONAME=UserName,
L_SHIPPINGAMT1=0.00,
L_SHIPPINGAMT0=0.00,
ACK=Success,
EMAIL=user@yahoo.com,
PAYERSTATUS=verified,
TRANSACTIONTYPE=cart,
SHIPTOZIP=07869,
ADDRESSSTATUS=Confirmed,
BUILD=13443904,
L_TAXAMT0=0.00,
L_TAXAMT1=0.00,
L_QTY0=1,
ORDERTIME=2014-11-05T21: 05: 52Z,
SHIPTOCOUNTRYNAME=UnitedStates,
SHIPPINGAMT=0.00,
L_QTY1=1,
PAYMENTSTATUS=Pending,
PAYERID=SA4SLFX48Y6DL,
COUNTRYCODE=US,
REASONCODE=None,
L_CURRENCYCODE1=USD,
ADDRESSOWNER=PayPal,
SALESTAX=0.00,
L_HANDLINGAMT1=0.00,
L_HANDLINGAMT0=0.00,
SHIPTOSTREET=53calaisrd,
RECEIVEREMAIL=username@payeezy.com,
SHIPTOSTATE=NJ,
TIMESTAMP=2014-11-05T21: 05: 53Z,
CURRENCYCODE=USD,
LASTNAME=Name,
RECEIVERID=HQETFY2WADPEC
}
Next step is to call Payeezy API to register Paypal transaction (ORDER, AUTHORIZE, or PURCHASE) (note that Purchase is called SALE in Paypal Express checkout API)
AVS & CVV2 Response Codes
CVV2 Response Code
The following CVV2 response Codes may be generated by First Data to indicate the status of a transaction based on your processing parameters.
| Code | Description |
|---|---|
| M | CVV2/CVC2 Match - Indicates that the card is authentic. Complete the transaction if the authorization request was approved. |
| N | CVV2 / CVC2 No Match – May indicate a problem with the card. Contact the cardholder to verify the CVV2 code before completing the transaction, even if the authorization request was approved. |
| P | Not Processed - Indicates that the expiration date was not provided with the request, or that the card does not have a valid CVV2 code. If the expiration date was not included with the request, resubmit the request with the expiration date. |
| S | Merchant Has Indicated that CVV2 / CVC2 is not present on card - May indicate a problem with the card. Contact the cardholder to verify the CVV2 code before completing the transaction. |
| U | Issuer is not certified and/or has not provided visa encryption keys |
| I | CVV2 code is invalid or empty |
AVS Response Code
The AVS result is a one-character response that indicates the degree of match for the provided address. Currently supported AVS responses are below.
| Code | Description |
|---|---|
| North American Response Codes | |
| X | Exact match, 9 digit zip - Street Address, and 9 digit ZIP Code match |
| Y | Exact match, 5 digit zip - Street Address, and 5 digit ZIP Code match |
| A | Partial match - Street Address matches, ZIP Code does not |
| W | Partial match - ZIP Code matches, Street Address does not |
| Z | Partial match - 5 digit ZIP Code match only |
| N | No match - No Address or ZIP Code match |
| U | Unavailable - Address information is unavailable for that account number, or the card issuer does not support |
| G | Service Not supported, non-US Issuer does not participate |
| R | Retry - Issuer system unavailable, retry later |
| E | Not a mail or phone order |
| S | Service not supported |
| Q | Bill to address did not pass edit checks/Card Association can't verify the authentication of an address |
| D | International street address and postal code match |
| B | International street address match, postal code not verified due to incompatable formats |
| C | International street address and postal code not verified due to incompatable formats |
| P | International postal code match, street address not verified due to incompatable format |
| 1 | Cardholder name matches |
| 2 | Cardholder name, billing address, and postal code match |
| 3 | Cardholder name and billing postal code match |
| 4 | Cardholder name and billing address match |
| 5 | Cardholder name incorrect, billing address and postal code match |
| 6 | Cardholder name incorrect, billing postal code matches |
| 7 | Cardholder name incorrect, billing address matches |
| 8 | Cardholder name, billing address, and postal code are all incorrect |
| International Response Codes | |
| G | Global non-AVS participant |
| B | Address matches only |
| C | Address and Postal Code do not match |
| D | Address and Postal Code match |
| F | Address and Postal Code match (UK only) |
| I | Address information not verified for international transaction |
| M | Address and Postal Code match |
| P | Postal Code matches only |
Optional AVS, Soft Descriptors, Level2 & Level3 Properties
Address object for AVS Check
For merchants who have turned on AVS check, would require to provide "billing_address" object in the request payload.
Below is the object format with all the required and optional fields.
"billing_address": {
"name": "{string}",
"street": "{string}",
"city": "{string}",
"state_province": "{string}",
"country": "{string}",
"zip_postal_code": "{string}",
"email": "{string}",
"phone": {
"type": "{string}",
"number": "{string}"
}
}
| Property name | Type | Description |
|---|---|---|
|
billing_address
(optional) |
object | This optional customer billing address object is used for AVS (Address Verification System) check purpose. |
|
billing_address.
street (optional) |
string | Standard US address format - "Number, Street Name" |
|
billing_address.
city (optional) |
string | Nearest city/town/village to the street name provided. |
|
billing_address.
state_province (optional) |
string | 2-letter state code |
|
billing_address.
country (optional) |
string | 2-letter country code. |
|
billing_address.
zip_postal_code (optional) |
string | 5-digit zip code |
|
billing_address.
(optional) |
string | customer email address. |
|
billing_address.
phone (optional) |
object | This JSON object holds phone contact details of the customer. |
|
billing_address.phone.
type (optional) |
string | Type is required when the PhoneNumber field is populated in a
transaction request. Otherwise, it is optional.
Only the following values are accepted: H = Home W = Work D = Day N = Night |
|
billing_address.phone
number (optional) |
object | Customer phone number field is required is phone object is populated. Phone number length is restricted to 14 and non digits will be removed before processing. |
Soft Descriptors
A descriptor is a piece of identifying information about a merchant, e.g. business name, phone number, city and/or state, which appears on buyers’ credit/debit card statements. These descriptors remind cardholders of the details of the purchase and give them a way to contact the merchant. The standard descriptor information that gets passed through to the cardholder’s statement is the DBA name and customer service phone number that you provide with your merchant account application.
While it is the card issuer’s discretion as to how many characters will show up in each field, if you keep the DBA Name field to fewer than 22 characters and the city field to fewer than 11 characters they should all show up on the cardholder’s statement. Visa requires MOTO merchants to put a phone number in the City field. Ecommerce merchants may use the City field for a URL, email address or phone number. There are additional fields that can be used; however, the majority of those will not appear on a statement.
Ex:Soft Descriptor: ABCMovies.com Caddyshack 8885551212
Note:
In this example, ABCMovies.com and Caddyshack are entered in the DBA Name field. Phone numbers should always be entered with numeric characters only.
"soft_descriptors": {
"dba_name": "{string}",
"street": "{string}",
"city": "{string}",
"region": "{string}",
"mid": "{string}",
"mcc": "{string}",
"postal_code": "{string}",
"country_code": "{string}",
"merchant_contact_info": "{string}"
}
| Property name | Type | Description |
|---|---|---|
|
soft_descriptors
(optional) |
object | JSON object that holds the soft descriptor fields that would be required if this object is populated. |
|
soft_descriptors.
dba_name (optional) |
string | Business name, required Character Format is ASCII. |
|
soft_descriptors.
street (optional) |
string | Business address. |
|
soft_descriptors.
city (optional) |
string | Business city |
|
soft_descriptors.
region (optional) |
string | Business region.
Ex: North East |
|
soft_descriptors.
mid (optional) |
string | Merchant ID |
|
soft_descriptors.
mcc (optional) |
string | Enter your Merchant Category Code.
Ex: 8812 |
|
soft_descriptors.
postal_code (optional) |
string | Business postal/zip code |
|
soft_descriptors.
country_code (optional) |
string | 2 digit country code. |
|
soft_descriptors.
country_code (optional) |
string | 2 digit country code. |
|
soft_descriptors.
merchant_contact_info (optional) |
string | Merchant contact information.
Ex:101 Main Street |
Level II
Level 2 data fields such as Freight, Duty, etc. - values are for informational purposes only and are not directly reflected in the Total Amount field for the transaction when processed. It is up to the Merchant to ensure that the Total Amount of the transaction reflects the desired Level 2 and 3 amounts.
The Discount Amount in line items defaults to 0.00 if nothing is entered
Card Types Supported:
- Visa
- Mastercard
"level2": {
"tax1_amount": {number},
"tax1_number": {string},
"tax2_amount": {number},
"tax2_number": {string},
"customer_ref": {string}
}
| Property | Type | Description |
|---|---|---|
|
level2
(optional) |
object | JSON object that holds the level2 transaction fields that would be required if this object is populated. |
|
level2.
tax1_amount (optional) |
number | Tax value included in total amount, only applicable to merchants passing level 2 (Corporate Credit Card - Level II) data.
For Canadian merchants this field is the PST amount. |
|
level2.
tax1_number (optional) |
string | Registered number associated with the tax value. Used for reference or government claims purposes and only applicable to merchants passing level 2 (Corporate Credit Card - Level II) data.
For Canadian merchants this field is the PST number |
|
level2.
tax2_amount (optional) |
number | Tax value included in total amount, only applicable to merchants passing level 2 (Corporate Credit Card - Level II) data.
For Canadian merchants this field is the GST amount. |
|
level2.
tax2_number (optional) |
string | Registered number associated with the tax value. Used for reference or government claims purposes and only applicable to merchants passing level 2 (Corporate Credit Card - Level II) data.
For Canadian merchants this field is the GST number. |
|
level2.
customer_ref (optional) |
string | Merchant defined value that can be used to internally identify the transaction |
Level III
The following properties are used to populate additional information about the transaction, including shipping details and line item information.
- Visa
- Mastercard
"level3": {
" alt_tax_amount": "{number}",
"alt_tax_id": "{string}",
"discount_amount": "{number}",
"duty_amount": "{number}",
"freight_amount": "{number}",
"ship_from_zip": "{string}",
"ship_to_address": {
"city": "{string}",
"state": "{string}",
"zip": "{string}",
"country": "{string}",
"email": "{string}",
"name": "{string}",
"phone": "{string}",
"address_1": "{string}",
"customer_number": "{string}"
},
"line_items": [{
"description": "{string}",
"quantity": "{string}",
"commodity_code": "{string}",
"discount_amount": "{number}",
"discount_indicator": "{string}",
"gross_net_indicator": "{string}",
"line_item_total": "{number}",
"product_code": "{string}",
"tax_amount": "{number}",
"tax_rate": "{number}",
"tax_type": "{string}",
"unit_cost": "{number}",
"unit_of_measure": "{string}"
}]
}
| Property name | Type | Description |
|---|---|---|
|
level3
(optional) |
object | JSON object that holds the level3 transaction fields that would be required if this object is populated. |
|
level3.
alt_tax_amount (optional) |
string | Total amount of alternate tax associated with this transaction. |
|
level3.
alt_tax_id (optional) |
string | Tax ID number for the alternate tax associated with this transaction. |
|
level3.
discount_amount (optional) |
number | Tax value included in total amount, only applicable to merchants passing level 2 (Corporate Credit Card - Level II) data.
For Canadian merchants this field is the GST amount. |
|
level3.
duty_amount (optional) |
number | Total charges for any import and/or export duties included in this transaction. |
|
level3.
freight_amount (optional) |
number | Total freight or shipping and handling charges. |
|
level3.
ship_from_zip (optional) |
string | The zip/postal code of the location from which the goods were shipped. |
|
level3.
ship_to_address (optional) |
object | Shipping address associated with the transaction. |
|
level3.ship_to_address.
city (optional) |
string | The City of the “ship to” location. |
|
level3.ship_to_address.
state (optional) |
string | The State of the “ship to” location. |
|
level3.ship_to_address.
zip (optional) |
string | The Zip/postal code of the “ship to” location. |
|
level3.ship_to_address.
country (optional) |
string | The ISO-assigned code of the country to which the goods were shipped. |
|
level3.ship_to_address.
name (optional) |
string | The Accountholder’s name associated with the transaction. |
|
level3.ship_to_address.
(optional) |
string | The Accountholder’s email address associated with the transaction. |
|
level3.ship_to_address.
phone (optional) |
string | The Accountholder’s phone number associated with the transaction.
Ex:AAAEEENNNNXXXX where: AAA = Area Code, EEE = Exchange, NNNN = Number, XXXX = Extension |
|
level3.ship_to_address.
address_1 (optional) |
string | The Street Address of the “ship to” location. |
|
level3.ship_to_address.
customer_number (optional) |
string | Purchase order or other number used by merchant’s customer to track the order. |
|
level3.
line_items (optional) |
array of object | JSON object |
|
level3.line_items
description (optional) |
string | Item description. |
|
level3.line_items
quantity (optional) |
string | Number of units of the item purchased |
|
level3.line_items
commodity_code (optional) |
string | The commodity code used to classify the item purchased. For a complete list of Commodity Codes "click here" |
|
level3.line_items
discount_amount (optional) |
number | The discounted amount for the line item. |
|
level3.line_items
discount_indicator (optional) |
string | Indicator for whether a discount is present on the item or not.
1 – Discounted 0 – Not Discounted |
|
level3.line_items
gross_net_indicator (optional) |
string | Indicates whether tax is included in the total amount or not.
1 – Tax included 0 – Tax Excluded |
|
level3.line_items
line_item_total (optional) |
number | The amount of the item. Normally calculated as price multiplied by quantity. |
|
level3.line_items
product_code (optional) |
string | The UPC product code for the line item. |
|
level3.line_items
tax_amount (optional) |
number | Tax amount in dollars and cents. |
|
level3.line_items
tax_rate (optional) |
number | Tax rate applied to the item |
|
level3.line_items
tax_type (optional) |
string | Type of tax being applied. |
|
level3.line_items
unit_cost (optional) |
number | The per unit cost of the line item. |
|
level3.line_items
unit_of_measure (optional) |
string | The unit of measure, or unit of measure code used for this item |
ISO Country Codes
Below is a table of ISO-assigned country codes. When processing Level III transactions, use Alpha-2 values to popluate the Country property in the Line Item Detail.
| Country Code | Country Name |
|---|---|
| AF | AFGHANISTAN |
| AX | ÅLAND ISLANDS |
| AL | ALBANIA |
| DZ | ALGERIA |
| AS | AMERICAN SAMOA |
| AD | ANDORRA |
| AO | ANGOLA |
| AI | ANGUILLA |
| AQ | ANTARCTICA |
| AG | ANTIGUA AND BARBUDA |
| AR | ARGENTINA |
| AM | ARMENIA |
| AW | ARUBA |
| AU | AUSTRALIA |
| AT | AUSTRIA |
| AZ | AZERBAIJAN |
| BS | BAHAMAS |
| BH | BAHRAIN |
| BD | BANGLADESH |
| BB | BARBADOS |
| BY | BELARUS |
| BE | BELGIUM |
| BZ | BELIZE |
| BJ | BENIN |
| BM | BERMUDA |
| BT | BHUTAN |
| BO | BOLIVIA, PLURINATIONAL STATE OF |
| BQ | BONAIRE, SINT EUSTATIUS AND SABA |
| BA | BOSNIA AND HERZEGOVINA |
| BW | BOTSWANA |
| BV | BOUVET ISLAND |
| BR | BRAZIL |
| IO | BRITISH INDIAN OCEAN TERRITORY |
| BN | BRUNEI DARUSSALAM |
| BG | BULGARIA |
| BF | BURKINA FASO |
| BI | BURUNDI |
| KH | CAMBODIA |
| CM | CAMEROON |
| CA | CANADA |
| CV | CAPE VERDE |
| KY | CAYMAN ISLANDS |
| CF | CENTRAL AFRICAN REPUBLIC |
| TD | CHAD |
| CL | CHILE |
| CN | CHINA |
| CX | CHRISTMAS ISLAND |
| CC | COCOS (KEELING) ISLANDS |
| CO | COLOMBIA |
| KM | COMOROS |
| CG | CONGO |
| CD | CONGO, THE DEMOCRATIC REPUBLIC OF THE |
| CK | COOK ISLANDS |
| CR | COSTA RICA |
| CI | CÔTE D'IVOIRE |
| HR | CROATIA |
| CU | CUBA |
| CW | CURAÇAO |
| CY | CYPRUS |
| CZ | CZECH REPUBLIC |
| DK | DENMARK |
| DJ | DJIBOUTI |
| DM | DOMINICA |
| DO | DOMINICAN REPUBLIC |
| EC | ECUADOR |
| EG | EGYPT |
| SV | EL SALVADOR |
| GQ | EQUATORIAL GUINEA |
| ER | ERITREA |
| EE | ESTONIA |
| ET | ETHIOPIA |
| FK | FALKLAND ISLANDS (MALVINAS) |
| FO | FAROE ISLANDS |
| FJ | FIJI |
| FI | FINLAND |
| FR | FRANCE |
| GF | FRENCH GUIANA |
| PF | FRENCH POLYNESIA |
| TF | FRENCH SOUTHERN TERRITORIES |
| GA | GABON |
| GM | GAMBIA |
| GE | GEORGIA |
| DE | GERMANY |
| GH | GHANA |
| GI | GIBRALTAR |
| GR | GREECE |
| GL | GREENLAND |
| GD | GRENADA |
| GP | GUADELOUPE |
| GU | GUAM |
| GT | GUATEMALA |
| GG | GUERNSEY |
| GN | GUINEA |
| GW | GUINEA-BISSAU |
| GY | GUYANA |
| HT | HAITI |
| HM | HEARD ISLAND AND MCDONALD ISLANDS |
| VA | HOLY SEE (VATICAN CITY STATE) |
| HN | HONDURAS |
| HK | HONG KONG |
| HU | HUNGARY |
| IS | ICELAND |
| IN | INDIA |
| ID | INDONESIA |
| IR | IRAN, ISLAMIC REPUBLIC OF |
| IQ | IRAQ |
| IE | IRELAND |
| IM | ISLE OF MAN |
| IL | ISRAEL |
| IT | ITALY |
| JM | JAMAICA |
| JP | JAPAN |
| JE | JERSEY |
| JO | JORDAN |
| KZ | KAZAKHSTAN |
| KE | KENYA |
| KI | KIRIBATI |
| KP | KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF |
| KR | KOREA, REPUBLIC OF |
| KW | KUWAIT |
| KG | KYRGYZSTAN |
| LA | LAO PEOPLE'S DEMOCRATIC REPUBLIC |
| LV | LATVIA |
| LB | LEBANON |
| LS | LESOTHO |
| LR | LIBERIA |
| LY | LIBYA |
| LI | LIECHTENSTEIN |
| LT | LITHUANIA |
| LU | LUXEMBOURG |
| MO | MACAO |
| MK | MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF |
| MG | MADAGASCAR |
| MW | MALAWI |
| MY | MALAYSIA |
| MV | MALDIVES |
| ML | MALI |
| MT | MALTA |
| MH | MARSHALL ISLANDS |
| MQ | MARTINIQUE |
| MR | MAURITANIA |
| MU | MAURITIUS |
| YT | MAYOTTE |
| MX | MEXICO |
| FM | MICRONESIA, FEDERATED STATES OF |
| MD | MOLDOVA, REPUBLIC OF |
| MC | MONACO |
| MN | MONGOLIA |
| ME | MONTENEGRO |
| MS | MONTSERRAT |
| MA | MOROCCO |
| MZ | MOZAMBIQUE |
| MM | MYANMAR |
| NA | NAMIBIA |
| NR | NAURU |
| NP | NEPAL |
| NL | NETHERLANDS |
| NC | NEW CALEDONIA |
| NZ | NEW ZEALAND |
| NI | NICARAGUA |
| NE | NIGER |
| NG | NIGERIA |
| NU | NIUE |
| NF | NORFOLK ISLAND |
| MP | NORTHERN MARIANA ISLANDS |
| NO | NORWAY |
| OM | OMAN |
| PK | PAKISTAN |
| PW | PALAU |
| PS | PALESTINIAN TERRITORY, OCCUPIED |
| PA | PANAMA |
| PG | PAPUA NEW GUINEA |
| PY | PARAGUAY |
| PE | PERU |
| PH | PHILIPPINES |
| PN | PITCAIRN |
| PL | POLAND |
| PT | PORTUGAL |
| PR | PUERTO RICO |
| QA | QATAR |
| RE | RÉUNION |
| RO | ROMANIA |
| RU | RUSSIAN FEDERATION |
| RW | RWANDA |
| BL | SAINT BARTHÉLEMY |
| SH | SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA |
| KN | SAINT KITTS AND NEVIS |
| LC | SAINT LUCIA |
| MF | SAINT MARTIN (FRENCH PART) |
| PM | SAINT PIERRE AND MIQUELON |
| VC | SAINT VINCENT AND THE GRENADINES |
| WS | SAMOA |
| SM | SAN MARINO |
| ST | SAO TOME AND PRINCIPE |
| SA | SAUDI ARABIA |
| SN | SENEGAL |
| RS | SERBIA |
| SC | SEYCHELLES |
| SL | SIERRA LEONE |
| SG | SINGAPORE |
| SX | SINT MAARTEN (DUTCH PART) |
| SK | SLOVAKIA |
| SI | SLOVENIA |
| SB | SOLOMON ISLANDS |
| SO | SOMALIA |
| ZA | SOUTH AFRICA |
| GS | SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS |
| SS | SOUTH SUDAN |
| ES | SPAIN |
| LK | SRI LANKA |
| SD | SUDAN |
| SR | SURINAME |
| SJ | SVALBARD AND JAN MAYEN |
| SZ | SWAZILAND |
| SE | SWEDEN |
| CH | SWITZERLAND |
| SY | SYRIAN ARAB REPUBLIC |
| TW | TAIWAN, PROVINCE OF CHINA |
| TJ | TAJIKISTAN |
| TZ | TANZANIA, UNITED REPUBLIC OF |
| TH | THAILAND |
| TL | TIMOR-LESTE |
| TG | TOGO |
| TK | TOKELAU |
| TO | TONGA |
| TT | TRINIDAD AND TOBAGO |
| TN | TUNISIA |
| TR | TURKEY |
| TM | TURKMENISTAN |
| TC | TURKS AND CAICOS ISLANDS |
| TV | TUVALU |
| UG | UGANDA |
| UA | UKRAINE |
| AE | UNITED ARAB EMIRATES |
| GB | UNITED KINGDOM |
| US | UNITED STATES |
| UM | UNITED STATES MINOR OUTLYING ISLANDS |
| UY | URUGUAY |
| UZ | UZBEKISTAN |
| VU | VANUATU |
| VE | VENEZUELA, BOLIVARIAN REPUBLIC OF |
| VN | VIET NAM |
| VG | VIRGIN ISLANDS, BRITISH |
| VI | VIRGIN ISLANDS, U.S. |
| WF | WALLIS AND FUTUNA |
| EH | WESTERN SAHARA |
| YE | YEMEN |
| ZM | ZAMBIA |
| ZW | ZIMBABWE |
Tax Type
Use these values to populate the TaxType property in Level III Line Item Detail.
| Code | Description |
|---|---|
| 0 | Unknown |
| 1 | Federal/National Sales Tax |
| 2 | State Sales Tax |
| 3 | City Sales Tax |
| 4 | Local Sales Tax |
| 5 | Municipal Sales Tax |
| 6 | Other Tax |
| 10 | Value Added Tax (VAT) |
| 11 | Goods and Services Tax (GST) |
| 12 | Provincial Sales Tax (PST) |
| 13 | Harmonized Sales Tax (HST) |
| 14 | Quebec Sales Tax (QST) |
| 20 | Room Tax |
| 21 | Occupancy Tax |
| 22 | Energy Tax |
| space | Not supported |
Unit of Measure
Use these values to populate the UnitOfMeasure property tag when processing Level III data.
The asterisk (*) after the unit name indicates recommended units of measurement that are either an SI (International System of Units) unit, or its multiple or a non-SI unit that may be used together with the SI units and their multiples.
| Unit Name | Description |
|---|---|
| Acre (4840 yd2) | ACR |
| Alcoholic strength by mass | ASM |
| Alcoholic strength by volume | ASV |
| Ampere* | AMP |
| Ampere-hour (3,6 kC)* | AMH |
| Are (100 m2) | ARE |
| Bar* | BAR |
| Barrel | BLL |
| Barrel (petroleum) (158,987 dm3) | BLL |
| Becquerel* | BQL |
| Billion EUR (trillion US) | BIL |
| Billion US | MLD |
| Billions US (milliard) | MLD |
| Board foot | BFT |
| Box | BX |
| Brake horse power (245,7 watts) | BHP |
| British thermal unit (1,055 kilojoules) | BTU |
| Bushel (35,2391 dm3) | BUA |
| Bushel (36,36874 dm3) | BUI |
| Candela* | CDL |
| Carrying capacity in metric tons | CCT |
| Case | CS |
| Cental GB (45,359237 kg) | CNT |
| Centigram* | CGM |
| Centilitre* | CLT |
| Centimetre* | CMT |
| Centner/Quintal Metric (100 kg) (Decitonne) | DTN |
| Cord (3.63 m3) | WCD |
| Coulomb* | COU |
| Cubic decimetre* | DMQ |
| Cubic foot | FTQ |
| Cubic inch | INQ |
| Cubic metre | MTQ |
| Cubic metre per hour* | MQH |
| Cubic metre per second* | MQS |
| Cubic millimetre* | MMQ |
| Cubic yard | YDQ |
| Curie | CUR |
| Day* | DAY |
| Decade (ten years) | DEC |
| Decare | DAA |
| Decilitre* | DLT |
| Decimetre* | DMT |
| Degree fahrenheit | FAH |
| Degrees Celsius | CEL |
| Displacement tonnage | DPT |
| Dozen | DZN |
| Dozen packs | DZP |
| Dozen pairs | DZR |
| Dozen pieces | DPC |
| Dozen rolls | DRL |
| Drachm GM (3.887935 g) | DRM |
| Dram GB (1.771745 g) | DRI |
| Dram US (3.887935 g) | DRA |
| Dry barrel (115.627 dm3) | BLD |
| Dry Gallon (4.404884 dm3) | GLD |
| Dry pint (.55061 dm3) | PTD |
| Dry quart (1.101221 dm3) | QTD |
| Each | EA |
| Each | EAC |
| Farad* | FAR |
| Fluid ounce (28.413 cm3) | OZI |
| Fluid ounce (29.5735 cm3) | OZA |
| Foot (.3048 m) | FOT |
| Gallon (4.546092 dm3) | GLI |
| Gigabequerel* | GBQ |
| Gigawatt-hour (1 million kw/h)* | GWH |
| Gill (.142065 dm3) | GII |
| Gill (11.8294 cm3) | GIA |
| Grain GB, US (64.798910 mg) | GRN |
| Gram of fissile isotopes | GFI |
| Gram* | GRM |
| Great gross (12 gross) | GGR |
| Gross | GRO |
| Gross (register) ton | GRT |
| Half year (six months) | SAN |
| Hectare | HAR |
| Hectobar* | HBA |
| Hectogram* | HGM |
| Hectokilogram* | DTH |
| Hectolitre of pure alcohol | HPA |
| Hectolitre* | HLT |
| Hectometre* | HMT |
| Hertz* | HTZ |
| Hour* | HUR |
| Hundred | CEN |
| Hundred boxes | BHX |
| Hundred Int‘l Units | HIU |
| Hundred leaves | CLF |
| Hundred packs | CNP |
| Hundred weight US (45.3592 kg) | CWA |
| Inch (25.4 mm) | INH |
| Item | ITM |
| Joule* | JOU |
| Kelvin* | KEL |
| Kilobar* | KBA |
| Kilogoule* | KJO |
| Kilogram of caustic potash (kilogram of potassium hydroxide) | KPH |
| Kilogram of caustic soda | KSH |
| Kilogram of named substance | KNS |
| Kilogram of nitrogen | KNI |
| Kilogram of phosphoric anhydride (kilogram of phosphoric pentoxide) | KPP |
| Kilogram of potassium oxide | KPO |
| Kilogram of substance 90% dry | KSD |
| Kilogram of uranium | KUR |
| Kilogram per cubic meter | KMQ |
| Kilogram per second* | KGS |
| Kilogram* | KGM |
| Kilohertz* | KHZ |
| Kilometre per hour* | KMH |
| Kilometre* | KMT |
| Kilopascal* | KPA |
| Kilotonne | KTN |
| Kilovar | KVR |
| Kilovolt* | KVT |
| Kilovolt-ampere* | KVA |
| Kilowatt* | KWT |
| Kilowatt-hour* | KWH |
| Knot (1 nautical mile per hour) | KNT |
| Leaf | LEF |
| Liquid gallon (3.78541 dm3) | GLL |
| Liquid pint (.473176 dm3) | PTL |
| Liquid quart (.946353 dm3) | QTL |
| Litre (1dm3)* | LTR |
| Litre of pure alcohol | LPA |
| Long ton GB, US (1.0160469 t) | LTN |
| Lumen* | LUM |
| Lux | LUX |
| Megahertz* | MHZ |
| Megalitre* | MAL |
| Megametre* | MAM |
| Megapascal* | MPA |
| Megavolt-ampere (1000 KVA)* | MVA |
| Megawatt* | MAW |
| Megawatt-hour (1000 kw/h)* | MWH |
| Metre per second squared* | MSK |
| Metre per second* | MTS |
| Metre* | MTR |
| Metric Carat (200 MG = 2.10-4kg) | CTM |
| Metric ton (1000 kg) (tonne (1000 kg)) | TNE |
| Millibar* | MBR |
| Millicurie | MCU |
| Milligram* | MGM |
| Millilitre* | MLT |
| Millimetre* | MMT |
| Million | MIO |
| Million cubic metres* | HMQ |
| Million international units | MIU |
| Minute* | MIN |
| Month | MON |
| Nautical mile (1852 m) | NMI |
| Net (register) ton | NTT |
| Newton* | NEW |
| Number | NMB |
| Number of articles | NAR |
| Number of bobbins | NBB |
| Number of cells* | NCL |
| Number of international units | NIU |
| Number of packs | NMP |
| Number of pairs | NMR |
| Number of parcels | NPL |
| Number of parts | NPT |
| Number of rolls | NRL |
| Ohm* | OHM |
| Ounce GB, US (28.348523 g) | ONZ |
| Ounce GB, US (31.10348 g) Troy Ounce | APZ |
| Package | PK |
| Pascal* | PAL |
| Pennyweight GB, US (1.555174 g) | DWT |
| Piece | PCB |
| Piece | PCE |
| Piece | Psc |
| Pint (.568262 dm3) | PTI |
| Pound GB, US (.45359237 kg) | LBR |
| Pounds | LBS |
| Proof gallon | PGL |
| Quart (1.136523 dm3) | QTI |
| Quarter (of a year) | QAN |
| Quarter, GB (12.700586 kg) | QTR |
| Revolution per minute* | RPM |
| Revolution per second* | RPS |
| Score | SCO |
| Scruple GB, US (1.285982 g) | SCR |
| Second* | SEC |
| Set | SET |
| Shipping ton | SHT |
| Short standard (7200 matches) | SST |
| Short ton GB, US (.90718474 t) | STN |
| Siemens* | SIE |
| Square centimetre* | CMK |
| Square decimetre* | DMK |
| Square foot | FTK |
| Square inch | INK |
| Square kilometre* | KMK |
| Square metre* | MTK |
| Square Mile | MIK |
| Square millimetre* | MMK |
| Square yard | YDK |
| Standard | WSD |
| Standard atmosphere (101325 Pa) | ATM |
| Statute mile (1609.344 m) | SMI |
| Stone GB (6.350293 kg) | STI |
| Technical atmosphere (98066.5 Pa) | ATT |
| Ten days | DAD |
| Ten pairs | TPR |
| Thousand | MIL |
| Thousand ampere-hour* | TAH |
| Thousand board-feet (2.36 m3) | MBF |
| Thousand cubic metres per day* | TQD |
| Thousand standard brick equivalent | MBE |
| Ton of steam per hour | TSH |
| Tonne of substance 90% dry | TSD |
| Trillion EUR | TRL |
| Troy pound, US (373.242 g) | LBT |
| Unknown unit of measure | ST |
| Volt* | VLT |
| Watt* | WTT |
| Watt-hour* | WHR |
| Weber | WEB |
| Week | WEE |
| Yard (.9144 m) | YRD |
| Year | ANN |
Bank Response
Payeezy Bank Response Codes
The following list reflects all currently defined Payeezy bank response reason codes. Many of these codes will never be returned in your output.
For the most common codes returned by Payeezy , the list includes an action field that suggests the best probable course of action to take based on the code returned. If you are receiving codes not listed here, please contact your Account Manager. The following KEY describes the Column Headings and the values appearing in the columns.
Note: Not all codes will be received on an authorization. Some codes are for deposit/conditionals only
| Keys | Description |
|---|---|
| Type |
S = Successful Response Codes R = Reject Response Codes D = Decline Response Codes |
| Code |
3‐digit response code |
| Name |
Description of the response code |
| Action |
Resend = Send this transaction back at any time Wait = Wait 2‐3 days before sending back, or try to resolve with your customer Cust. = Try to resolve with customer, or get an alternate method of payment Fix = There is an invalid field being sent Fix and resend N/A = Not applicable Voice = Perform a voice authorization per First Data instructions Call = Call First Data |
| Response | Code | Name | Action | Comments |
|---|---|---|---|---|
| D | 000 | No Answer | Resend | First Data received no answer from auth network |
| S | 100 | Approved | N/A | Successfully approved |
| S | 101 | Validated | N/A | Account Passed edit checks |
| S | 102 | Verified | N/A | Account Passed external negative file |
| S | 103 | Pre-Noted | N/A | Passed Pre-Note |
| S | 104 | No Reason to Decline | N/A | Successfully approved |
| S | 105 | Received and Stored | N/A | Successfully approved |
| S | 106 | Provided Auth | N/A | Successfully approved Note: Indicates customized code was used in processing |
| S | 107 | Request Received | N/A | Successfully approved Note: Indicates customized code was used in processing |
| S | 108 | Approved for Activation | N/A | Successfully Activated |
| S | 109 | Previously Processed Transaction | N/A | Transaction was not re-authorized with the Debit Network because it was previously processed |
| S | 110 | BIN Alert | N/A | Successfully approved Note: Indicates customized code was used in processing |
| S | 111 | Approved for Partial | N/A | Successfully approved Note: Indicates customized code was used in processing |
| S | 164 | Conditional Approval | Wait | Conditional Approval - Hold shipping for 24 hours |
| R | 201 | Invalid CC Number | Cust | Bad check digit, length, or other credit card problem |
| R | 202 | Bad Amount Nonnumeric Amount | If | Amount sent was zero, unreadable, over ceiling limit, or exceeds maximum allowable amount. |
| R | 203 | Zero Amount | Fix | Amount sent was zero |
| R | 204 | Other Error | Fix | Unidentifiable error |
| R | 205 | Bad Total Auth Amount | Fix | The sum of the authorization amount from extended data information does not equal detail record authorization Amount. Amount sent was zero, unreadable, over ceiling limit, or exceeds Maximum allowable amount. |
| R | 218 | Invalid SKU Number | Fix | Non‐numeric value was sent |
| R | 219 | Invalid Credit Plan | Fix | Non‐numeric value was sent |
| R | 220 | Invalid Store Number | Fix | Non‐numeric value was sent |
| R | 225 | Invalid Field Data | Fix | Data within transaction is incorrect |
| R | 227 | Missing Companion Data | Fix | Specific and relevant data within transaction is absent |
| R | 229 | Percents do not total 100 | Fix | FPO monthly payments do not total 100 Note: FPO only |
| R | 230 | Payments do not total 100 | Fix | FPO monthly payments do not total 100 Note: FPO only |
| R | 231 | Invalid Division Number | Fix | Division number incorrect |
| R | 233 | Does not match MOP | Fix | Credit card number does not match method of payment type or invalid BIN |
| R | 234 | Duplicate Order Number | Fix | Unique to authorization recycle transactions. Order number already exists in system Note: Auth Recycle only |
| R | 235 | FPO Locked | Resend | FPO change not allowed Note: FPO only |
| R | 236 | Auth Recycle Host System Down | Resend | Authorization recycle host system temporarily unavailable Note: Auth Recycle only |
| R | 237 | FPO Not Approved | Call | Division does not participate in FPO. Contact your First Data Representative for information on getting set up for FPO Note: FPO only |
| R | 238 | Invalid Currency | Fix | Currency does not match First Data merchant setup for division |
| R | 239 | Invalid MOP for Division | Fix | Method of payment is invalid for the division |
| R | 240 | Auth Amount for Division | Fix | Used by FPO |
| R | 241 | Illegal Action | Fix | Invalid action attempted |
| R | 243 | Invalid Purchase Level 3 | Fix | Data is inaccurate or missing, or the BIN is ineligible for P‐card |
| R | 244 | Invalid Encryption Format | Fix | Invalid encryption flag. Data is Inaccurate. |
| R | 245 | Missing or Invalid Secure Payment Data | Fix | Visa or MasterCard authentication data not in appropriate Base 64 encoding format or data provided on A non‐e‐Commerce transaction. |
| R | 246 | Merchant not MasterCard Secure code Enabled | Call | Division does not participate in MasterCard Secure Code. Contact your First Data Representative for information on getting setup for MasterCard SecureCode. |
| R | 247 | Check conversion Data Error | Fix | Proper data elements were not sent |
| R | 248 | Blanks not passed in reserved field | Fix | Blanks not passed in Reserved Field |
| R | 249 | Invalid (MCC) | Fix | Invalid Merchant Category (MCC) sent |
| R | 251 | Invalid Start Date | Fix | Incorrect start date or card may require an issue number, but a start date was submitted. |
| R | 252 | Invalid Issue Number | Fix | Issue number invalid for this BIN. |
| R | 253 | Invalid Tran. Type | Fix | If an “R” (Retail Indicator) is sent for a transaction with a MOTO Merchant Category Code (MCC) |
| R | 257 | Missing Cust Service Phone | Fix | Card was authorized, but AVS did not match. The 100 was overwritten with a 260 per the merchant’s request Note: Conditional deposits only |
| R | 258 | Not Authorized to Send Record | Call |
Division does not participate in Soft Merchant Descriptor. Contact your First Data Representative for information on getting set up for Soft Merchant Descriptor. |
| D | 260 | Soft AVS | Cust. | Authorization network could not reach the bank which issued the card |
| R | 261 | Account Not Eligible For Division’s Setup | N/A | Account number not eligible for division’s Account Updater program setup |
| R | 262 | Authorization Code Response Date Invalid | Fix | Authorization code and/or response date are invalid. Note: MOP = MC, MD, VI only |
| R | 263 | Partial Authorization Not Allowed or Partial Authorization Request Note Valid | Fix | Action code or division does not allow partial authorizations or partial authorization request is not valid. |
| R | 264 | Duplicate Deposit Transaction | N/A | Transaction is a duplicate of a previously deposited transaction. Transaction will not be processed. |
| R | 265 | Missing QHP Amount | Fix | Missing QHP Amount |
| R | 266 | Invalid QHP Amount | Fix | QHP amount greater than transaction amount |
| R | 274 | Transaction Not Supported | N/A |
The requested transaction type is blocked from being used with this card. Note: This may be the result of either an association rule, or a merchant boarding option. |
| D | 301 | Issuer unavailable | Resend | Authorization network could not reach the bank which issued the card |
| D | 302 | Credit Floor | Wait | Insufficient funds |
| D | 303 | Processor Decline | Cust. | Generic decline – No other information is being provided by the Issuer |
| D | 304 | Not On File | Cust. | No card record, or invalid/nonexistent to account specified |
| D | 305 | Already Reversed | N/A | Transaction previously reversed. Note: MOP = any Debit MOP, SV, MC, MD, VI only |
| D | 306 | Amount Mismatch | Fix | Requested reversal amount does not match original approved authorization amount. Note: MOP = MC, MD, VI only |
| D | 307 | Authorization Not Found | Fix | Transaction cannot be matched to an authorization that was stored in the database. Note: MOP = MC, MD, VI only |
| R | 351 | TransArmor Service Unavailable | Resend | TransArmor Service temporarily unavailable. |
| D | 352 | Expired Lock | Cust. | ValueLink - Lock on funds has expired. |
| R | 353 | TransArmor Invalid Token or PAN | Fix | TransArmor Service encountered a problem converting the given Token or PAN with the given Token Type. |
| R | 354 | TransArmor Invalid Result | Cust | TransArmor Service encountered a problem with the resulting Token/PAN. |
| D | 401 | Call | Voice | Issuer wants voice contact with cardholder |
| D | 402 | Default Call | Voice | Decline |
| D | 501 | Pickup | Cust | Card Issuer wants card returned |
| D | 502 | Lost/Stolen | Cust | Card reported as lost/stolen Note: Does not apply to American Express |
| D | 503 | Fraud/ Security Violation | Cust | CID did not match Note: Discover only |
| D | 505 | Negative File | Cust | On negative file |
| D | 508 | Excessive PIN try | Cust | Allowable number of PIN tries exceeded |
| D | 509 | Over the limit | Cust | Exceeds withdrawal or activity amount limit |
| D | 510 | Over Limit Frequency | Cust | Exceeds withdrawal or activity count limit |
| D | 519 | On negative file | Cust | Account number appears on negative file |
| D | 521 | Insufficient funds | Cust | Insufficient funds/over credit limit |
| D | 522 | Card is expired | Cust | Card has expired |
| D | 524 | Altered Data | Fix | Altered Data\Magnetic stripe incorrect |
| D | 530 | Do Not Honor | Cust | Generic Decline – No other information is being provided by the issuer. Note: This is a hard decline for BML (will never pass with recycle attempts) |
| D | 531 | CVV2/VAK Failure | Cust | Issuer has declined auth request because CVV2 or VAK failed |
| D | 534 | Do Not Honor - High Fraud | Cust | The transaction has failed PayPal or Google Checkout risk models |
| D | 570 | Stop payment order one time recurring/ installment | Fix | Cardholder has requested this one recurring/installment payment be stopped. |
| D | 571 | Revocation of Authorization for All Recurring / Installments | Cust | Cardholder has requested all recurring/installment payments be stopped |
| D | 572 | Revocation of All Authorizations – Closed Account | Cust | Cardholder has requested that all authorizations be stopped for this account due to closed account. Note: Visa only |
| D | 580 | Account previously activated | Cust | Account previously activated |
| D | 581 | Unable to void | Fix | Unable to void |
| D | 582 | Block activation failed | Fix | Reserved for Future Use |
| D | 583 | Block Activation Failed | Fix | Reserved for Future Use |
| D | 584 | Issuance Does Not Meet Minimum Amount | Fix | Issuance does not meet minimum amount |
| D | 585 | No Original Authorization Found | N/A | No original authorization found |
| D | 586 | Outstanding Authorization, Funds on Hold | N/A | Outstanding Authorization, funds on hold |
| D | 587 | Activation Amount Incorrect | Fix | Activation amount incorrect |
| D | 588 | Block Activation Failed | Fix | Reserved for Future Use |
| D | 589 | CVD Value Failure | Cust | Magnetic stripe CVD value failure |
| D | 590 | Maximum Redemption Limit Met | Cust | Maximum redemption limit met |
| D | 591 | Invalid CC Number | Cust | Bad check digit, length or other credit card problem. Issuer generated |
| D | 592 | Bad Amount | Fix | Amount sent was zero or unreadable. Issuer generated |
| D | 594 | Other Error | Fix | Unidentifiable error. Issuer generated |
| D | 595 | New Card Issued | Cust | New Card Issued |
| D | 596 | Suspected Fraud | Cust | Issuer has flagged account as suspected fraud |
| D | 599 | Refund Not Allowed | N/A | Refund Not Allowed |
| D | 602 | Invalid Institution Code | Fix | Card is bad, but passes MOD 10 check digit routine, wrong BIN |
| D | 603 | Invalid Institution | Cust | Institution not valid (i.e. possible merger) |
| D | 605 | Invalid Expiration Date | Cust | Card has expired or bad date sent. Confirm proper date |
| D | 606 | Invalid Transaction Type | Cust | Issuer does not allow this type of transaction |
| D | 607 | Invalid Amount | Fix | Amount not accepted by network. (This response is provided by the card issuer.) |
| D | 610 | BIN Block | Cust | Merchant has requested First Data not process credit cards with this BIN |
| S | 704 | FPO Accepted | N/A | Stored in FPO database |
| R | 740 | Match Failed | Fix |
Unable to validate the debit. Authorization Record - based on amount, action code, and MOP (Batch response reason code for Debit Only) |
| R/D | 741 | Validation Failed | Fix |
Unable to validate the Debit Authorization Record - based on amount, action code, and MOP (Batch response reason code for Debit Only) |
| R/D | 750 | Invalid Transit Routing Number | Fix | EC - ABA transit routing number is invalid, failed check digit |
| R/D | 751 | Transit Routing Number Unknown | Fix | Transit routing number not on list of current acceptable numbers. |
| R | 752 | Missing Name | Fix | Pertains to deposit transactions only |
| R | 753 | Invalid Account Type | Fix | Pertains to deposit transactions only |
| R/D | 754 | Account Closed | Cust | Bank account has been closed For PayPal and GoogleCheckout – the customer’s account was closed / restricted |
| R | 755 | Subscriber Number Does Not Exist | Cust | No Account/Unable to Locate |
| R | 758 | Subscriber Number Not Active | Cust | Account Frozen |
| R/D | 760 | ACH Non-Participant | Cust. | EC – Banking Institution does not accept
ACH transactions |
| D | 776 | Duplicate Check | Cust | Duplicate Transaction |
| D | 777 | Original transaction was not approved | Cust | Original not approved |
| D | 787 | Rejected Code 3 (Risk) | Cust | Decline High Risk |
| D | 788 | Refund or partial amount is > original sale amount | Fix | Refund Greater than original sale |
| D | 802 | Positive ID | Voice | Issuer requires further information |
| D | 806 | Restraint | Cust | Card has been restricted |
| D | 811 | Invalid Security Code | Fix | American Express CID is incorrect |
| D | 813 | Invalid PIN | Cust | PIN for online debit transactions is incorrect |
| D | 825 | No Account | Cust | Account does not exist |
| D | 833 | Invalid Merchant | Fix | Service Established (SE) number is incorrect, closed or Issuer does not allow this type of transaction |
| R | 834 | Unauthorized User | Fix | Method of payment is invalid for the division |
| D | 902 | Process Unavailable | Resend/ Call/ Cust. | System error/malfunction with Issuer For Debit – The link is down or setup issue; contact your First Data Representative. |
| D | 903 | Invalid Expiration | Cust | Invalid or expired expiration date |
| D | 904 | Invalid Effective | Cust./ Resend | Card not active |
| D | 997 | Acquirer Error | Call | Acquiring bank configuration problem. Contact your First Data representative. |
Auth Code Responses
The following Auth Code responses may be generated by First Data to indicate the status of an authorized transaction based on your processing parameters.
| Code | Description |
|---|---|
| notdep | Not deposited |
| rcycle | Not deposited – transaction sent to First Data recycle program |
| sofdep | Deposited transaction with a soft decline |
| tntCxx | Test only (do not send in production) |
| tstxxx | Test only (do not send in production) |
