Payment Scenario Element Requirements¶
Payment scenario element requirements describe web service request element (i.e. detail) filling logic. Within this section elements marked with M are mandatory, and O are optional. Details with * represent one or more details from a specific group; for example, perspayee_gen* represents one or more details from a recurring payment specific detail group.
Simple Payment Scenarios¶
SMS Payment Scenario¶
| Element | AUTH/AUTH_NAME | SMS/QCash | RECO | REFND | ||||
|---|---|---|---|---|---|---|---|---|
| Step 1 | Step 2 | Step 1 | Step 2 | Step 1 | Step 2 | Step 1 | Step 2 | |
| billerRef | M | M | M | M | ||||
| payinstrRef | M | M | M | M | ||||
| original_payment_id | O | O | ||||||
| paymentID | M | M | M | M | ||||
| confirmed | M | M | M | M | ||||
| finished | M | M | M | M | ||||
| pan | M | M | M | |||||
| expiry | M | M | O | |||||
| amount | M | M | M13 | M | ||||
| ccy_code | M | M | M13 | M | ||||
| merchant_id | M | M | M | M | ||||
| csc | O | O | O | |||||
| sli | O | O | ||||||
| xid | O | O | ||||||
| cavv | O | O | ||||||
| eci | O | O | ||||||
| 3ds_protocol10 | O | O | ||||||
| 3ds_ds_id10 | O | O | ||||||
| transStatus | O | O | ||||||
| cookie_info_id | M | M | ||||||
| cardname | M | M | ||||||
| client_ip_addr | M | M | ||||||
| etid | O | O | O | |||||
| merchant_name | O | O | O | |||||
| perspayee_gen3 | O | O | ||||||
| cof_original_tid4 | O | |||||||
| sca_exemption | O | |||||||
| n_legs1 | O | |||||||
| ppwi2 | M | M | ||||||
| merchant_url5 | M | |||||||
| tavv6 | O9 | M | ||||||
| moto | O | O | ||||||
| onfile | O | O | ||||||
| oboc | O | O | ||||||
| recurring | O | |||||||
| recurring_reg | O | |||||||
| receiver_country | ||||||||
| receiver_birth_date | ||||||||
| recipient_name | ||||||||
| recurring_numb7 | O | |||||||
| recurring_per7 | O | |||||||
| recurring_ref7 | O | |||||||
| sl_city | O | O | ||||||
| sl_region8 | O | O | ||||||
| sl_country | O | O | ||||||
| sl_index | O | O | ||||||
| mp_mvv9 | O | O | ||||||
| mp_frn9 | O | O | ||||||
| gate_id10 | M | M | M | |||||
| avs_data11 | O | O | O | |||||
| inst_plan_id12 | M | M | ||||||
| instalment_request_id13 | M | M | M | M | M | M | ||
| instalment_plan13 | M | |||||||
| instalment_tc_version13 | M | |||||||
| instalment_tc_language13 | M | |||||||
| hr_asset14 | O14 | |||||||
| original_rtid15 | O | |||||||
2 mandatory for tokenized wallet payments and Mastercard DWO
3 only for recurring scenario when data is stored on DECTA side
4 mandatory for merchant initiated transactions execution when data is stored on IPSP side
5 mandatory for Apple Pay, Google Pay, C2P and network tokens - only for Mastercard
6 mandatory for Apple Pay, Google Pay, C2P and network tokens if the value provided to merchant
7 mandatory for cards issued in India
8 Refer to Quick Reference Booklet by Mastercard for valid country subdivision codes
9 for Visa cards only
10 mandatory for Mastercard cards only
11 mandatory for AVS transactions
12 mandatory for Visa Instalment Solutions when VIS API solution by IPSP
13 mandatory for Visa Instalment Solutions when DECTA VIS solution is used
14 mandatory for digital cash purchases and QCASH, only Mastercard
15 for Mastercard cards only
DMS/QCash Payment Scenario¶
| Element | Optional or Mandatory | ||
|---|---|---|---|
| Step 1 | Step 2 | Step 3 | |
| billerRef | M | ||
| payinstrRef | M | ||
| paymentID | M | M | |
| confirmed | M | ||
| finished | M | ||
| pan | M | ||
| expiry | M | ||
| amount | M | M11 | O |
| ccy_code | M | M11 | |
| merchant_id | M | ||
| avs_data1 | O | ||
| csc | O | ||
| sli | O | ||
| xid | O | ||
| cavv | O | ||
| eci | O | ||
| 3ds_protocol7 | O | ||
| 3ds_ds_id7 | O | ||
| transStatus | O | ||
| cookie_info_id | M | ||
| cardname | M | ||
| client_ip_addr | M | ||
| etid | O | ||
| merchant_name | O | ||
| perspayee_gen | O | ||
| n_legs2 | O | ||
| ppwi3 | M | ||
| merchant_url8 | M | ||
| tavv9 | M | ||
| onfile | O | ||
| oboc | O | ||
| recurring | O | ||
| recurring_reg | O | ||
| cof_original_tid4 | O | ||
| moto | O | ||
| sca_exemption | O | ||
| sl_city | O | ||
| sl_region5 | O | ||
| sl_country | O | ||
| sl_index | O | ||
| mp_mvv6 | O | ||
| mp_frn6 | O | ||
| gate_id7 | M | ||
| inst_plan_id10 | M | ||
| instalment_request_id11 | M | M | |
| instalment_plan11 | M | ||
| instalment_tc_version11 | M | ||
| instalment_tc_language11 | M | ||
| hr_asset12 | O12 | ||
2 airlines addendum operations only
3 mandatory for tokenized wallet payments and Mastercard DWO
4 mandatory for merchant initiated transactions execution when data is stored on IPSP side
5 refer to Quick Reference Booklet by Mastercard for valid country subdivision codes
6 for Visa cards only
7 mandatory for Mastercard cards only
8 mandatory for Apple Pay, Google Pay, C2P and network tokens - only for Mastercard
9 mandatory for Apple Pay, Google Pay, C2P and network tokens if the value provided to merchant
10 mandatory for Visa Instalment Solutions when VIS API solution by IPSP
11 mandatory for Visa Instalment Solutions when DECTA VIS solution is used
12 mandatory for digital cash and QCASH, only Mastercard
AFT Payment Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| billerRef | M | |
| payinstrRef | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| pan | M | |
| expiry | M | |
| csc | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | M | |
| merchant_id | M | |
| client_ip_addr | M | |
| recipient_name | M | |
| recipient_country_code | M | |
| recipient_city | M | |
| recipient_address1 | M1 | |
| recipient_postal_code5 | M5 | |
| recipient_birth_date | M | |
| recipient_account_number | M | |
| recipient_account_type | M | |
| client_name | M | |
| client_address | M | |
| client_city | M | |
| client_state_code1 | M | |
| client_birth_date | M4 | |
| client_country_code | M | |
| crypto | O | |
| gate_id2 | M | |
| payment_purpose3 | M | |
2 mandatory field for Mastercard cards only
3 mandatory Visa field only for India, Bangladesh, Argentina, Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
4 mandatory for Visa cards only
5 mandatory field for Canada
AFT AA Payment Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| billerRef | M | |
| payinstrRef | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| pan | M | |
| expiry | M | |
| csc | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | M | |
| merchant_id | M | |
| client_ip_addr | M | |
| funding_type1 | M | |
| recipient_name | M | |
| recipient_country_code | M | |
| recipient_city | M | |
| recipient_address | M | |
| recipient_postal_code4 | M4 | |
| recipient_birth_date | M3 | |
| recipient_account_number | M | |
| recipient_account_type | M | |
| gate_id1 | M | |
| payment_purpose2 | M | |
| hr_asset | O | |
2 mandatory Visa field only for India, Bangladesh, Argentina, Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
3 mandatory for Visa cards only
4 mandatory field only for Canada issuers
SDWO Payment Scenario¶
| Element | Digital Wallet Funding | Purchase via Digital Wallet | ||
|---|---|---|---|---|
| Step 1 | Step 2 | Step 1 | Step 2 | |
| billerRef | M | M | ||
| payinstrRef | M | M | ||
| paymentID | M | M | ||
| confirmed | M | M | ||
| finished | M | M | ||
| pan | M | M | ||
| expiry | M | M | ||
| amount | M | M | ||
| ccy_code | M | M | ||
| merchant_id | M | M | ||
| sdwo_merchant_id | M | |||
| wallet_id | M | M | ||
| csc | O | O | ||
| sli | O | O | ||
| xid | O | O | ||
| cavv | O | O | ||
| eci | O | O | ||
| 3ds_protocol | O | O | ||
| 3ds_ds_id | O | O | ||
| transStatus | O | O | ||
| cookie_info_id | M | M | ||
| cardname | M | M | ||
| client_ip_addr | M | M | ||
| perspayee_gen | O | O | ||
| onfile | O | O | ||
| oboc | O | O | ||
| recurring | O | O | ||
| recurring_reg | O | O | ||
| etid | O | O | ||
| crypto | O | |||
| gate_id1 | M | M | ||
SDWO Payout Scenario¶
| Element | SDWO Payout | SDWO Merchant Payout | ||
|---|---|---|---|---|
| Step 1 | Step 2 | Step 1 | Step 2 | |
| SwitchingID | M | M | ||
| autoSwitch | M | M | ||
| language | M | M | ||
| paymentID | M | M | ||
| confirmed | M | M | ||
| finished | M | M | ||
| pan2 | M | M | ||
| expiry | O | O | ||
| amount | M | M | ||
| ccy_code | M | M | ||
| merchant_ext2 | M | M | ||
| sdwo_merchant_id | M | |||
| wallet_id | M | M | ||
| csc | O | O | ||
| cookie_info_id | M | M | ||
| cardname | M | M | ||
| client_ip_addr | M | M | ||
| b2p_merchant | M | M | ||
| recipient_name | M | M | ||
| c_ref | M | M | ||
| recipient_country_code1 | M | M | ||
| recipient_birth_date | M | M | ||
| recipient_city1 | M | M | ||
| recipient_address1 | M | M | ||
| recipient_state_code2 | M | M | ||
| sender_name | M | M | ||
| crypto | O | O | ||
| payment_purpose3 | M | M | ||
2 mandatory only for Canada and USA issuers
3 mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
Apple Pay Payment Scenario in SMS Mode¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| billerRef | M | |
| payinstrRef | M | |
| paymentID | M | |
| confirmed | M | |
| finished | M | |
| pan | M | |
| expiry | M | |
| amount | M | |
| ccy_code | M | |
| merchant_id | M | |
| csc | O | |
| sli | O | |
| xid | O | |
| cavv | O | |
| eci | O | |
| 3ds_protocol | O | |
| 3ds_ds_id | O | |
| transStatus | O | |
| cookie_info_id | M | |
| cardname | O | |
| client_ip_addr | M | |
| avs_data1 | O | |
| tavv | M | |
| merchant_url2 | O | |
| etid | O | |
| merchant_name | O | |
| gate_id2 | M | |
2 mandatory for Mastercard
Apple Pay Payment Scenario in DMS Mode¶
| Element | Optional or Mandatory | ||
|---|---|---|---|
| Step 1 | Step 2 | Step 3 | |
| billerRef | M | ||
| payinstrRef | M | ||
| paymentID | M | M | |
| confirmed | M | ||
| finished | M | ||
| pan | M | ||
| expiry | M | ||
| amount | M | O | |
| ccy_code | M | ||
| merchant_id | M | ||
| csc | O | ||
| sli | O | ||
| xid | O | ||
| cavv | O | ||
| eci | O | ||
| 3ds_protocol | O | ||
| 3ds_ds_id | O | ||
| transStatus | O | ||
| cookie_info_id | M | ||
| cardname | O | ||
| client_ip_addr | M | ||
| avs_data1 | O | ||
| tavv | M | ||
| merchant_url2 | O | ||
| merchant_name | O | ||
| etid | O | ||
| gate_id2 | M | ||
2 mandatory for Mastercard
Airline Addendum in SMS Mode¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| billerRef | M | |
| payinstrRef | M | |
| paymentID | M | |
| confirmed | M | |
| finished | M | |
| pan | M | |
| expiry | M | |
| amount | M | |
| ccy_code | M | |
| merchant_id | M | |
| csc | O | |
| cookie_info_id | M | |
| cardname | O | |
| client_ip_addr | M | |
| n_legs | M | |
| ticket_number | M | |
| passenger_name | M | |
| customer_ref | M | |
| carrier_name | O | |
| travel_agency_code | O | |
| travel_agency_name | O | |
| plan_nr | O | |
| invoice_number | O | |
| airline_orig_ccy | O | |
| original_amnt | O | |
| ticket_issue_addr | O | |
| ticket_issue_date1 | O | |
| total_fare | O | |
| total_fees | O | |
| total_tax | O | |
| restricted_ticket_indicator | O | |
| gate_id1 | M | |
Details for airline addendum n_legs specifies the trip leg number and must be between 1..n_legs.
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| departure_airportN | M | |
| carrier_codeN | M | |
| destination_airportN | M | |
| departure_dateN | M | |
| fare_bassisN | O | |
| service_classN | M | |
| stop_over_codeN | O | |
| departure_taxN | O | |
| conjunct_ticketN | O | |
| exchange_ticketN | O | |
| coupon_numberN | O | |
| trip_numberN | M | |
| departure_timeN | O | |
| arrival_timeN | O | |
| fare_amntN | O | |
| fees_amntN | O | |
| tax_amntN | O | |
| endorsements_restrN | O | |
Airline Addendum in DMS Mode¶
| Element | Optional or Mandatory | ||
|---|---|---|---|
| Step 1 | Step 2 | Step 3 | |
| billerRef | M | ||
| payinstrRef | M | ||
| paymentID | M | M | |
| confirmed | M | ||
| finished | M | ||
| pan | M | ||
| expiry | M | ||
| amount | M | O | |
| ccy_code | M | ||
| merchant_id | M | ||
| csc | O | ||
| cookie_info_id | M | ||
| cardname | O | ||
| client_ip_addr | M | ||
| n_legs | M | ||
| ticket_number | M | ||
| passenger_name | M | ||
| customer_ref | M | ||
| carrier_name | M | ||
| travel_agency_code | O | ||
| travel_agency_name | O | ||
| plan_nr | O | ||
| invoice_number | O | ||
| airline_orig_ccy | O | ||
| original_amnt | O | ||
| ticket_issue_addr | O | ||
| ticket_issue_date1 | O | ||
| total_fare | O | ||
| total_fees | O | ||
| total_tax | O | ||
| restricted_ticket_indicator | O | ||
| gate_id1 | M | ||
Details for airline addendum n_legs specifies the trip leg number and must be between 1..n_legs.
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| departure_airportN | M | |
| carrier_codeN | M | |
| destination_airportN | M | |
| departure_dateN | M | |
| fare_bassisN | O | |
| service_classN | O | |
| stop_over_codeN | O | |
| departure_taxN | O | |
| conjunct_ticketN | O | |
| exchange_ticketN | O | |
| coupon_numberN | O | |
| trip_numberN | O | |
| departure_timeN | O | |
| arrival_timeN | O | |
| fare_amntN | O | |
| fees_amntN | O | |
| tax_amntN | O | |
| endorsements_restrN | O | |
Cancel Payment Execution¶
The only mandatory element for Cancel execution is paymentID.
Return Payment Execution¶
The only mandatory element for Return execution is paymentID.
Payment Result Retrieval¶
The only mandatory element for Result retrieval is paymentID.
Recurring Payment Scenarios¶
Recurring SMS Payment Scenario¶
Recurring payment execution in SMS mode when the cardholder data saved on DECTA side:
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| billerRef | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| clientID | M | |
| amount | O | |
| recurring | O | |
| onfile | O | |
| oboc | O | |
| hr_asset1 | O | |
Recurring DMS Payment Scenario¶
Recurring payment execution in DMS mode when the cardholder data saved on DECTA side:
| Element | Optional or Mandatory | ||
|---|---|---|---|
| Step 1 | Step 2 | Step 3 | |
| billerRef | M | ||
| confirmed | M | ||
| finished | M | ||
| paymentID | M | ||
| clientID | M | ||
| amount | M | O | |
| recurring | O | ||
| onfile | O | ||
| oboc | O | ||
| hr_asset1 | O | ||
Payout Scenarios¶
P2P Payout Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan1 | M | |
| pan2 | M | |
| expiry | O | |
| csc1 | M | |
| avs_data2 | M | |
| expiry2 | M | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | M | |
| merchant_ext3 | M | |
| merchant_ext23 | M | |
| c_ref3 | M | |
| client_ip_addr | M | |
| client_address | M | |
| client_city | M | |
| client_name | M | |
| client_postal_code | M | |
| client_birth_date | M | |
| recipient_name | M | |
| client_state_code4 | M | |
| client_country_code | M | |
| recipient_country_code | M | |
| recipient_birth_date | M | |
| client_account_number | M | |
| client_account_type | M | |
| recipient_account_number1 | M | |
| recipient_account_type1 | M | |
| recipient_address5 | M | |
| recipient_city5 | M | |
| recipient_state_code4 | M | |
| payment_purpose6 | M | |
| gate_id7 | M | |
2 mandatory only for FULL P2P (debit operations) with the AVS verification
3
c_ref or combination of merchant_ext (for FULL P2P) and merchant_ext2 must be provided4 mandatory field for Canada and USA issuers
5 mandatory field for Canada issuers
6 mandatory Visa field for India, Bangladesh, Argentina, Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
7 mandatory field for Mastercard cards only
B2P Payout Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| b2p_merchant | M | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan2 | M | |
| expiry2 | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | M | |
| merchant_ext2 | M | |
| c_ref | M | |
| recipient_name | M | |
| recipient_country_code | M | |
| recipient_birth_date | M | |
| recipient_city1 | M | |
| recipient_address1 | M | |
| recipient_state_code2 | M | |
| payment_purpose3 | M | |
| crypto | O | |
2 mandatory field for Canada issuers
3 mandatory Visa field for India, Bangladesh, Argentina, Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
OG Payout Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| payout_type | M | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan2 | M | |
| expiry2 | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | O | |
| merchant_id2 | M | |
| recipient_name | M | |
| recipient_birth_date | M | |
| recipient_city1 | M | |
| recipient_country_code1 | M | |
| recipient_address1 | M | |
| recipient_state_code2 | M | |
| payment_purpose3 | M | |
2 mandatory field for Canada issuers
3 mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
Account to Account Payout Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| payout_type | M | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan2 | M | |
| expiry2 | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | O | |
| merchant_id2 | M | |
| client_name | M | |
| client_country_code | M | |
| client_birth_date | M | |
| client_city | M | |
| client_state_code1 | M | |
| client_address | M | |
| client_postal_code | M | |
| client_account_number | M | |
| client_account_type | M | |
| payment_purpose2 | M | |
| hr_asset | O | |
2 mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
Funds Transfer Payout Scenario¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| payout_type | M | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan2 | M | |
| expiry2 | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | O | |
| merchant_id2 | M | |
| client_name | M | |
| client_country_code | M | |
| client_birth_date | M | |
| client_city | M | |
| client_state_code1 | M | |
| client_address | M | |
| client_postal_code | M | |
| client_account_number | M | |
| client_account_type | M | |
| crypto | O | |
| payment_purpose2 | M | |
2 mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients
Payroll & Pensions Disbursements¶
| Element | Optional or Mandatory | |
|---|---|---|
| Step 1 | Step 2 | |
| payout_type | M | |
| switchingID | M | |
| autoSwitch | M | |
| confirmed | M | |
| finished | M | |
| paymentID | M | |
| language | M | |
| pan2 | M | |
| expiry2 | O | |
| amount | M | |
| ccy_code | M | |
| cookie_info_id | O | |
| cardname | O | |
| merchant_id2 | M | |
| recipient_name | M | |
| recipient_country_code1 | M | |
| recipient_birth_date | M | |
| recipient_city1 | M | |
| recipient_address1 | M | |
| recipient_state_code2 | M | |
| payment_purpose3 | M | |
2 mandatory field for Canada and USA issuers
3 mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, Mexico and Saudi Arabia recipients