Please refer payment API field validation
Type Description
| A | Alphabets (A-Z, a-z) |
| N | Numbers (0-9) |
| S | Special Characters |
| AN | Alphabets (A-Z, a-z) & Numbers (0-9) |
| AS | Alphabets (A-Z, a-z) & Special Characters |
| NS | Numbers (0-9) & Special Characters |
| ANS | Alphabets (A-Z, a-z), Numbers (0-9) and Special Characters |
| T | Time, syntax format: YYYY-MM-DD HH:mm:ss |
| D | Date?syntax format: YYYY-MM-DD |
Request
Title | Object | Type | Type1 | Required? (Yes/No/ Conditional) | Value(e.g.) | Description | Length | Allowed | Not Allowed | Audit |
|---|---|---|---|---|---|---|---|---|---|---|
| account | string | AN | No (Mandatory if organisation & currency are not sent) | e6287e2adc434cddbfdb13223a43015b | The ID of the account. Acts as an override. Must be submitted if organisation and currency are not used in the request. | 250 | Alphanumeric | Special Characters | ||
| organisation | string | AN | No (Mandatory if account is not sent) | 6c18a82fe5a2439b922522570c9abc37 | The ID of an organisation. Must be submitted along with currency if account is not used in the request. | 250 | Alphanumeric | Special Characters | ||
| currency | string | A | No (Mandatory if account is not sent) | GBP | Currency using which transaction needs to be processed. Must be submitted if account is not used in the request. This field is ignored if submitted along with the account, Apexx uses the currency configured with the account to process the transaction when account is submitted. A 3-letter ISO 4217 currency code, see Currencies Section for more details. | 3 | ISO 4217 currency code | Numbers and Special Characters | ||
| amount | Number | N | Yes | 100 | Amount is charged without a decimal place e.g. $1.50 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. | 12 | Numeric | Alphabets and Special characters | ||
| capture_now | string | A | Yes | TRUE | True will auto-capture the transaction. False will only authorise the transaction. | 250 | Boolean: True or False | |||
| dynamic_descriptor | string | ANS | No | First order | A short reference/descriptor that will show up on the customers bank statement. Only supported by some acquirers. Please confirm with your Implementation Manager for supported acquirers and formats. | 255 | All Alphabets, Numbers and Special Characters | |||
| merchant_reference | string | ANS | Yes | 98565825 | A reference specified by the merchant to identify the transaction. This field must be unique per transaction. | 255 | All Alphabets, Numbers and Special Characters | |||
| card | Object | Yes | Card Details | |||||||
| card_holder_name | card | string | ANS | No | John Doe | Full name of the card holder as printed on the card | 255 | All Alphabets, Numbers and Special Characters | ||
| card_number | card | Number | N | Yes (if encrypted_data is not sent in card block) | 40000000000000000 | The new card number, also known as PAN. | 20 | only Numbers | ||
| cvv | card | Number | N | No | 123 | The Card Verification Value. Note: CVV is not required when transaction is a recurring or oneclick transaction. | 4 | only Numbers | ||
| expiry_month | card | Number | N | Yes(if encrypted_data is not sent in card block) | 12 | Card expiry month. A string representing the month, valid values are 01 to 12. | 2 | only Numbers | ||
| expiry_year | card | Number | N | Yes(if encrypted_data is not sent in card block) | 20 | Card expiry year. A string representing the last two digits of the year, e.g. 19 for 2019. | 2 | only Numbers | ||
| token | card | string | AN | No | The token representing the payment card. | 250 | Alphabets Numbers | Special Characters | ||
| create_token | card | Boolean | A | No | TRUE | The token representing the payment card. | 5 | Alphabets | Numbers and Special Characters | |
| encrypted_data | card | string | ANS | No | This field will contain the encryption data of card_number, expiry_month, expiry_year and cvv fields. Encryption data generated by client-side-encryption SDK. | NA | All Alphabets, Numbers and Special Characters | |||
| customer | Object | No | Customer Object | |||||||
| customer_id | customer | string | AS | No | John | First name of the customer. Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | 255 | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | Numeric, Special characters, Alpha-numeric | |
| last_name | customer | string | ANS | No | Doe | Last name of the customer. Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | 255 | All Alphabets, Numbers and Special Characters | ||
| date_of_birth | customer | string | ANS | No | 2020-01-01 | The date of birth of a customer, 10 characters, ISO-8601 (YYYY-MM-DD). | 255 | All Alphabets, Numbers and Special Characters | ||
| postal_code | customer | string | ANS | No | 33415 | A postal code for the address Note: Only alpha-numeric characters | All Alphabets, Numbers and Special Characters | |||
| account_number | customer | string | N | No | 95856585958 | This is the recipient's account number. | All Alphabets, Numbers and Special Characters | |||
| customer_ip | string | ANS | No | 192.168.1.135 | The IP address of the customer | 250 | ||||
| recurring_type | string | A | No | recurring | Valid Values: "first" "recurring" "oneclick" This field is to be used only when a transaction is part of a series of recurring transactions. If it's the initial transaction, set the value to 'first', and if it's not, set it to 'recurring'. This field must not be included in transactions that will not be part of a series of repeated transactions. (All values are written in lowercase letters). | 255 | Alphabets | Numbers and Special Characters | ||
| user_agent | string | ANS | No | Mozilla/5.0 (Windows; U; Windows NT 6.1; en-GB;rv:1.9.2.13) Gecko/20101203 Firefox/3.6.13 (.NET CLR 3.5.30729) | The full user agent string of the device the customer used to submit the transaction | 255 | All Alphabets, Numbers and Special Characters | |||
| webhook_transaction_update | string | ANS | No | https://qaigate.apexxfintech.com/mgw | A webhook url that is called when a transaction is updated. Note: This overrides any URL set on the account. | 255 | All Alphabets, Numbers and Special Characters | |||
| card_brand | string | AS | No | visa | valid values: "amex" "diners" "discover" "elo" "jcb" "maestro" "mastercard" "visa" "visa electron" "carte bancaire" Card brand for the card used for processing | 50 | Alphabets Special Characters | Numbers | ||
| billing_address | object | No | Some fields may be mandatory for certain acquirers. Please speak to your Implementation Manager for further information. | |||||||
| first_name | billing_address | string | ANS | No | John | First name of the delivery customer Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | 255 | |||
| last_name | billing_address | string | ANS | No | Doe | Last name of the delivery customer Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | 255 | |||
| billing_address | string | ANS | No | john.doe@email.com | Email address of the card holder Note: Only alphabets, numeric, @, comma(,) dot(.), plus(+), underscore(_), dash(-) and apostrophe(‘) | 255 | Alphabets and Numbers, Special characters allowed are @, comma(,) dot(.), plus(+), underscore(_), dash(-) and apostrophe(‘) | |||
| address | billing_address | string | ANS | No | 123 Gütersloher Str. | Street address of the card holder Note: All characters support | All Alphabets, Numbers and Special Characters | |||
| city | billing_address | string | AS | No | Verl | City of the card holder Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | ||
| state | billing_address | string | AS | No | A region / state / province for the address Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | |||
| postal_code | billing_address | string | ANS | No | 33415 | A postal code for the address Note: Only alpha-numeric characters | All Alphabets, Numbers and Special Characters | |||
| country | billing_address | string | A | No | DE | A 2-letter ISO3166 alpha-2. country code for the address. Note: Alphabets upto two characters (e.g. GB, RU etc..) | Alphabets upto two characters (e.g. GB, RU etc..) | Numeric and Special Characters | ||
| phone | billing_address | number | N | No | 9865245632 | Numbers only, no dash or any other separator. Note: Length - min(3) & max(20) | 3 to 20 | Numbers | Alphabets and Special characters | |
| shopper_interaction | string | A | No | ecommerce | Valid Values: "ecommerce" "pos" "moto" "unknown" Determines the point of sale of a customer. Default values: ecommerce | 50 | Only Alphabets: Valid values are "ecommerce" "pos" "moto" "unknown" | |||
| three_ds | Object | Enroll a given transaction for 3D-secure to verify whether authentication is supported for the card being used. | ||||||||
| term_url | three_ds | string | ANS | No | https://example.com/return | The return url to which the customer is redirected after a transaction is processed. | All Alphabets, Numbers and Special Characters | |||
| three_ds_required | three_ds | boolean | A | No | true | true if 3DS required for this transaction, false otherwise. | 5 | Alphabets | Numbers and Special Characters | |
| three_ds_version | three_ds | enum | NS | No | 1.0 | Valid Values: "1.0" "2.0" The 3-D Secure version used for the authentication. | 5 | Numbers, special characters allowed is fullstop(.) | Alphabets | |
| airline_data | object | No | Airline itinerary data for the transaction | |||||||
| airline_itinerary_data | boolean | A | No ( Default value = false) | FALSE | Airline itinerary data | |||||
numeric_code airline_numeric_code | airline_data | string | N | Yes (if airline_itenary_data = true) | 531 | Airline numeric code | ||||
| airline_name | airline_data | string | ANS | Yes (if airline_itenary_data = true) | British Airways | Name of the airline | 255 | All Alphabets, Numbers and Special Characters | ||
| ticket_number | airline_data | string | ANS | Yes (if airline_itenary_data = true) | 1.05913E+12 | Ticket/document number, or PNR locator code. | 255 | All Alphabets, Numbers and Special Characters | ||
| agency | Object | |||||||||
| agency_code | agency | string | ANS | No | 12345678 | Travel agency code | 25 | All Alphabets, Numbers and Special Characters | ||
| agency_name | agency | string | ANS | No | Travel Agency | Travel agency name | 255 | All Alphabets, Numbers and Special Characters | ||
| invoice_number | airline_data | string | ANS | No | 65411 | Invoice number of the ticket | 25 | All Alphabets, Numbers and Special Characters | ||
| ticket_type | array | No | [1,2,3] | Array of the type of tickets, should be separated by comma(,) | ||||||
flight_leg legs | Object | Flight leg details | ||||||||
| flight_number | legs | number | N | Yes (if airline_itenary_data = true) | 81 | Flight number excluding carrier code | 5-Jan | Numbers | ||
| carrier_code | legs | string | AN | Yes (if airline_itenary_data = true) | AA | Travel carrier code | 2 | Alphabets Numbers | Special Characters | |
| service_class | legs | string | AN | Yes (if airline_itenary_data = true) | first class | Ticket category (“0” if no class) Valid values:first class, Second class, business, Economic, 0 | 20 | Alphabets Numbers | Special Characters | |
| departure_date | legs | date | NS | Yes (if airline_itenary_data = true) | 43852 | Departure date. Format - YYYY-MM-DD | Numbers Special Characters | Alphabets | ||
| destination_airport | legs | string | A | Yes (if airline_itenary_data = true) | JFK | Destination airport/city IATA code | 3 | Alphabets | Numbers Special Characters | |
| origin_airport | legs | string | A | Yes (if airline_itenary_data = true) | JFK | Origin airport/city IATA code | 3 | Alphabets | Numbers Special Characters | |
| stop_over_code | legs | string | A | Yes (if airline_itenary_data = true) | N | Stop over code | 1 | Alphabets | ||
| fare_basis_code | legs | string | ANS | No | VLVA2FI | Fare basis code | 8 | All Alphabets, Numbers and Special Characters | ||
| flight_leg | ?? | number | N | No | 1 | Sequence number of the flight leg | 2 | Numbers | Alphabets Special Characters | |
| outbound_departure_city | ?? | string | AS | No | Verl | Outbound departure city of the booking Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | ||
| outbound_arrival_time | string | ANS | No | Sat Apr 07 10:40:00 BST 2018 | Outbound arrival time of the booking | |||||
| outbound_arrival_city | string | AS | No | Verl | Outbound arrival city of the booking Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | |||
| inbound_flight_number | string | N | Yes (if airline_itenary_data = true) | 81 | Flight number excluding carrier code | 5-Jan | Numbers | |||
| inbound_departure_time | string | ANS | No | Sat Apr 07 10:40:00 BST 2018 | Inbound flight number of the booking | |||||
| inbound_departure_city | string | AS | No | Verl | Inbound departure city of the booking Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | |||
| inbound_departure_airport_code | string | A | Yes (if airline_itenary_data = true) | JFK | Inbound departure airport/city IATA code | 3 | Alphabets | Numbers Special Characters | ||
| inbound_arrival_time | string | ANS | No | Sat Apr 07 10:40:00 BST 2018 | Inbound arrival time of the booking | |||||
| inbound_arrival_city | string | AS | No | Verl | Inbound arrival city of the card holder Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | |||
| inbound_arrival_airport_code | string | A | Yes (if airline_itenary_data = true) | JFK | Inbound arrival airport/city IATA code | 3 | Alphabets | Numbers Special Characters | ||
| passenger_details | Object | No | Passenger Details | |||||||
| passenger_title | string | A | No | Mr | Valid Values: "Mr" "Mrs" "Miss" Salutation of the customer | 10 | Alphabets | Numbers and Special Characters | ||
| passenger_name | string | AS | No | John Doe | Name of passenger Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | 255 | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) | Numeric, Special characters, Alpha-numeric | ||
pax_age_group passenger_age_group | string | A | No | ADT | Travelling passenger's age group | 50 | Alphabets | Numbers and Special Characters | ||
| is_lead | Boolean | A | No | true | ||||||
| shipping_info | Object | No | Shipping information | |||||||
| string | ANS | No | john.doe@email.com | Email address of the card holder Note: Only alphabets, numeric, @, comma(,) dot(.), plus(+), underscore(_), dash(-) and apostrophe(‘) | 255 | Alphabets and Numbers, Special characters allowed are @, comma(,) dot(.), plus(+), underscore(_), dash(-) and apostrophe(‘) | ||||
| address | string | ANS | No | 123 Gütersloher Str. | Street address of the card holder Note: All characters support | All Alphabets, Numbers and Special Characters | ||||
| city | string | AS | No | Verl | City of the card holder Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | |||
| state | string | AS | No | A region / state / province for the address Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) | Numeric, Special characters, Alpha-numeric | ||||
| postal_code | string | ANS | No | 33415 | A postal code for the address Note: Only alpha-numeric characters | All Alphabets, Numbers and Special Characters | ||||
| country | string | A | No | DE | A 2-letter ISO3166 alpha-2. country code for the address. Note: Alphabets upto two characters (e.g. GB, RU etc..) | Alphabets upto two characters (e.g. GB, RU etc..) | Numeric and Special Characters | |||
| phone | string | N | No | 9865245632 | Numbers only, no dash or any other separator. Note: Length - min(3) & max(20) | 3 to 20 | Numbers | Alphabets and Special characters | ||
| external_authentication | Object | externalAuthentication | ||||||||
| xid | string | ANS | No | 3-D Secure X id. | ||||||
| cavv | string | ANS | Yes(if external_authentication block is received) | 3-D Secure “Cardholder Authentication Verification Value”. | ||||||
| cavv_algorithm | string | ANS | No | 3-D Secure “Cardholder Authentication Verification Value” algorithm(0-9). | ||||||
| 3ds_status | string | ANS | Yes(if external_authentication block is received) | 3-D Secure status: y = authentication successful n = not authenticated u = authentication unavailable a = authentication attempted r = authentication rejected | ||||||
| eci | string | ANS | Yes(if external_authentication block is received) | The Electronic Commerce Indicator (ECI). | ||||||
| 3ds_enrolled | string | ANS | No | Card’s enrollment status. | ||||||
| directory_server_transaction_id | string | ANS | No | The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication | ||||||
| 3ds_transaction_status_reason | string | ANS | No | 3-D Secure out of scope reason. Shall be used if the transaction type is out of scope of Strong Customer Authentication (SCA). The following transaction types are out of scope of SCA: mit Merchant Initiated Transactions moto Mail Order/Telephone Order one_leg_out anonymous_prepaid_card | ||||||
| 3ds_score | string | ANS | No | CB scoring. Mandatory for CB transactions. | ||||||
| 3ds_preference | string | ANS | No | 3DS Requestor Challenge Indicator. Mandatory for CB. Acccepted values: sca ask for a strong authentication; frictionless ask for a frictionless authentication; nopref or absent, the decision will be made by Dalenys; scamandate strong authentication required by regulation | ||||||
| 3ds_mode | string | ANS | No | Applied authentification mode: sca Strong authentication; frictionless Frictionless authentication; | ||||||
| 3ds_version | string | ANS | Yes(if external_authentication block is received) | The 3-D Secure version used for the authentication. | ||||||
| 3ds_result | string | ANS | No | 6 character value composed of 3DSECURESTATUS converted to hexadecimal concatenated with the result VRes converted to hexadecimal | ||||||
| 3ds_server_transaction_id | string | ANS | No | The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication. | ||||||
| external_risk_data | Object | No | Risk and Fraud check details | |||||||
| provider | enum | A | Yes(if external_risk_data is received) | accertify | Provider name to be used for performing risk & fraud check. Valid Values: accertify | |||||
| session_id | string | ANS | Yes(if external_risk_data is received) | 1952715134TUITHB2050EB68164A408CCD02A49B04B43A3 | Session identifier of the transaction | |||||
| risk_data | Object | Risk related details | ||||||||
| promo_id | string | ANS | No | Promo identifier applied on the transaction | ||||||
| promo_amount | Number | N | No | 101 | Promo amount applied on the transaction | |||||
| app_session_id | string | ANS | No | B2050EB68164A408CCD02A49B04B43A3 | Application session identifier | |||||
| cps_session_id | string | ANS | No | B2050EB68164A408CCD02A49B04B43A3 | CPS session identifier | |||||
| cps_unique_token | string | ANS | No | e20e1db5-589c-42f8-a06b-9ad33e0c350c | CPS unique token | |||||
| shop_number | string | ANS | No | 2660 | Shop number | |||||
| sales_channel | string | ANS | No | TUITH | Sales channel of the transaction | |||||
| accommodation | Object | No | Accommodation details of the transaction | |||||||
| accommodation_name | string | ANS | No | Hotel Flamingo Oasis | Name of the hotel or accommodation for the booking | |||||
| selling_code | string | ANS | No | ESCB0008 | Selling code of the booking | |||||
| resort | string | ANS | No | Benidorm | Name of the resort for the booking | |||||
| destination | string | ANS | No | Costa Blanca | Destination city/place for the booking | |||||
| country | string | ANS | No | Spain | Country name | |||||
| checkin_date | string | DT | No | Sat Mar 31 01:00:00 BST 2018 | Check in date | |||||
| checkout_date | string | DT | No | Sat Mar 31 01:00:00 BST 2018 | Check out date | |||||
| stay_duration | Number | N | No | 7 | Number of days of the accommodation | |||||
| inventory | string | ANS | No | |||||||
| package_type | string | ANS | No | PDP | Type of the package selected by customer for the accommodation |
Response
| Title | Type | Description |
| _id | string | This is the unique id generated by Apexx. |
| account | string | The ID of the account. Acts as an override. Must be submitted if organisation and currency are not used in the request. |
| organisation | string | The ID of an organisation |
| currency | string | A 3-letter ISO 4217 currency code, see Currencies Section for more details. |
| amount | number | Amount is charged without a decimal place e.g. $1.50 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. |
| authorization_code | string | An authorisation code assigned by the processing platform |
| capture_now | boolean | True will auto-capture the transaction. False will only authorise the transaction. |
| blocked | boolean | True if the transaction has been blocked by a ruleset, false otherwise |
| dynamic_descriptor | string | A short reference/descriptor that will show up on the customers bank statement. Only supported by some acquirers. Please confirm with your Implementation Manager for supported acquirers and formats. |
| merchant_reference | string | A reference specified by the merchant to identify the transaction. This field must be unique per transaction. |
| card | Object | BaseCardDetails |
| card_holder_name | string | Name of the card holder as printed on the card |
| card_number | number | The new card number, also known as PAN. |
| expiry_month | number | Card expiry month. A string representing the month, valid values are 01 to 12. |
| expiry_year | number | Card expiry year. A string representing the last two digits of the year, e.g. 19 for 2019. |
| token | string | The token representing the payment card. |
| encrypted_data | string | This field will contain the encryption data of card_number, expiry_month, expiry_year and cvv fields. Encryption data generated by client-side-encryption SDK. |
| customer_ip | string | The IP address of the customer |
| pares | string | The unmodified PaRes value as received after the customer was redirected back from 3DS Authentication. |
| recurring_type | enum | Valid Values: "first" "recurring" "oneclick" The value used to flag how the acquirer/ issuer should consider the transaction |
| user_agent | string | The full user agent string of the device the customer used to submit the transaction |
| webhook_transaction_update | string | A webhook url that is called when a transaction is updated. Note: This overrides any URL set on the account. |
| actions | array | |
| created_at | string | The time at which the transaction was created |
| cvv_present | boolean | True if the card was used with a cvv |
| fees | number | |
| geo_location | string | The latitude/longitude resolved from the customer's ip address |
| last_status_update | date | The last time when the status of the transaction was updated |
| payment_product | string | The payment product corresponding to this transaction |
| card_brand | string | Valid Values: "amex" "diners" "discover" "elo" "jcb" "maestro" "mastercard" "visa" "visa electron" "carte bancaire" Card brand for the card used for processing |
| issuer_name | string | Card Issuer Name for this transaction |
| issuer_country | string | Issuing country of the card. A 2-letter ISO3166 alpha-2. Acquirer country code |
| organisation_psp_name | string | The name of the processor as setup within the APEXX payment gateway. i.e. Merchant Name - Acquirer Name |
| reason_code | string | A reason code assigned by the acquiring platform; '0' in case of Success, see reason codes section for declined scenarios and error codes section for failed scenarios. |
| reason_message | string | A reason message assigned by the acquiring platform. Reason message will return if reason_code is not 0 |
| fraud_predictions | Object | |
| error_message | string | |
| rec | string | |
| rules_triggered | string | |
| score | string | |
| status | string | Valid Values: "AUTHENTICATION_REQUIRED" "DECLINED" "FAILED" |
| billing_address | Object | Some fields may be mandatory for certain acquirers. Please speak to your Implementation Manager for further information. |
| first_name | string | First name of the delivery customer Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) |
| last_name | string | Last name of the delivery customer Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,) and apostrophe(‘)) |
| string | Email address of the card holder Note: Only alphabets, numeric, @, comma(,) dot(.), plus(+), underscore(_), dash(-) and apostrophe(‘) | |
| address | string | Street address of the card holder Note: All characters support |
| city | string | City of the card holder Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) |
| state | string | A region / state / province for the address Note: Only alphabetic characters, Special characters allowed are (hyphen(-), underscore(_), dot(.), comma(,)) |
| postal_code | string | A postal code for the address Note: Only alpha-numeric characters |
| country | string | A 2-letter ISO3166 alpha-2. country code for the address. Note: Alphabets upto two characters (e.g. GB, RU etc..) |
| phone | number | Numbers only, no dash or any other separator. Note: Length - min(3) & max(20) |
| details | Object | |
| shopper_interaction | string | Valid Values: "ecommerce" "pos" "moto" "unknown" Determines the point of sale of a customer. Default values: ecommerce |
| cvv_result | string | CVV verification result, as returned by the processor |
| avs_result | string | Address verification services result, as returned by the processor |
| three_ds | object | Enroll a given transaction for 3D-secure to verify whether authentication is supported for the card being used. |
| term_url | string | The return url to which the customer is redirected after a transaction is processed. |
| three_ds_required | boolean | true if 3DS required for this transaction, false otherwise. |
| three_ds_version | string | Valid Values: "1.0" "2.0" The 3-D Secure version used for the authentication. |
| external_risk_data | Object | Risk and Fraud check details |
| risk_transaction_id | string | Transaction risk ID as received from the risk & fraud check service |
| risk_transaction_reference | string | Transaction risk reference Id as received from the risk & fraud check service |
| rules_triggered | string | Rules triggered to check risk |
| score | number | Score of the risk check |
| recommendation_code | string | Recommendation as suggested by the risk & fraud check service |
| remarks | string | Remarks for the risk & fraud check service |