Payment Scenario Requirements - soap | DECTA Acquiring Processing Guide

Payment Scenario Element Requirements

Overview

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
Element	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	M¹³			M
ccy_code	M		M	M¹³			M
merchant_id	M		M		M		M
csc		O		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
etid		O		O				O
merchant_name		O		O				O
perspayee_gen³		O		O
cof_original_tid⁴				O
sca_exemption				O
n_legs¹				O
ppwi²				M				M
merchant_url⁵				M
tavv⁶				M
moto		O		O
onfile		O		O
oboc		O		O
recurring				O
recurring_reg				O
receiver_country
receiver_birth_date
recipient_name
recurring_numb⁷				O
recurring_per⁷				O
recurring_ref⁷				O
sl_city		O		O
sl_region⁸		O		O
sl_country		O		O
sl_index		O		O
mp_mvv⁹		O		O
mp_frn⁹		O		O
gate_id¹⁰		M		M				M
avs_data¹¹		O		O				O
inst_plan_id¹²				M				M
instalment_request_id¹³			M	M	M	M	M	M
instalment_plan¹³				M
instalment_tc_version¹³				M
Instalment_tc_language¹³				M

¹ airlines addendum operations only
²mandatory for tokenized wallet payments and Mastercard DWO
³only for recurring scenario when data is stored on DECTA side
⁴mandatory for merchant initiated transactions execution when data is stored on IPSP side
⁵mandatory for Apple Pay and Google Pay, only Mastercard
⁶andatory for Apple Pay and Google Pay if the value provided to merchant
⁷mandatory for cards issued in India
⁸Refer to Quick Reference Booklet by Mastercard for valid country subdivision codes
⁹for Visa cards only
¹⁰mandatory for Mastercard cards only
¹¹mandatory for AVS transactions
¹²mandatory for Visa Instalment Solutions when VIS API solution by IPSP
¹³mandatory for Visa Instalment Solutions when DECTA VIS solution is used

DMS/QCash Payment Scenario

Element	Optional or Mandatory
Element	Step 1	Step 2	Step 3
billerRef	M
payinstrRef	M
paymentID		M	M
confirmed			M
finished			M
pan		M
expiry		M
amount	M	M¹¹	O
ccy_code	M	M¹¹
merchant_id	M
avs_data¹		O
csc		O
sli		O
xid		O
cavv		O
eci		O
3ds_protocol⁷		O
3ds_ds_id⁷		O
transStatus		O
cookie_info_id		M
cardname		M
client_ip_addr		M
etid		O
merchant_name		O
perspayee_gen		O
n_legs²		O
ppwi³		M
merchant_url⁸		M
tavv⁹		M
onfile		O
oboc		O
recurring		O
recurring_reg		O
cof_original_tid⁴		O
moto		O
sca_exemption		O
sl_city		O
sl_region⁵		O
sl_country		O
sl_index		O
mp_mvv⁶		O
mp_frn⁶		O
gate_id⁷		M
inst_plan_id¹⁰		M
instalment_request_id¹¹	M	M
instalment_plan¹¹		M
instalment_tc_version¹¹		M
instalment_tc_language¹¹		M

¹mandatory for AVS transactions
²airlines addendum operations only
³mandatory for tokenized wallet payments and Mastercard DWO
⁴mandatory for merchant initiated transactions execution when data is stored on IPSP side
⁵refer to Quick Reference Booklet by Mastercard for valid country subdivision codes
⁶for Visa cards only
⁷mandatory for Mastercard cards only
⁸mandatory for Apple Pay and Google Pay, only Mastercard
⁹mandatory for Apple Pay and Google Pay if the value provided to merchant
¹⁰mandatory for Visa Instalment Solutions when VIS API solution by IPSP
¹¹mandatory for Visa Instalment Solutions when DECTA VIS solution is used

AFT Payment Scenario

Element	Optional or Mandatory
Element	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_address¹		M¹
recipient_postal_code⁵		M⁵
recipient_birth_date		M
recipient_account_number		M
recipient_account_type		M
client_name		M
client_address		M
client_city		M
client_state_code¹		M
client_birth_date		M⁴
client_country_code		M
crypto		O
gate_id²		M
payment_purpose³		M

¹ mandatory field only for Canada and USA issuers as well for Visa issuers in Australia, New Zealand and the South Pacific countries, islands and territories
² mandatory field for Mastercard cards only
³ mandatory Visa field only for India, Bangladesh, Argentina, Egypt, Chile, Colombia, and Mexico recipients
⁴ mandatory for Visa cards only
⁵ mandatory field for Canada

AFT AA Payment Scenario

Element	Optional or Mandatory
Element	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_type¹		M
recipient_name		M
recipient_country_code		M
recipient_city		M
recipient_address		M
recipient_postal_code⁴		M⁴
recipient_birth_date		M³
recipient_account_number		M
recipient_account_type		M
gate_id¹		M
payment_purpose²		M
hr_asset		O

¹ mandatory field for Mastercard cards only
² mandatory Visa field only for India, Bangladesh, Argentina, Egypt, Chile, Colombia, and Mexico recipients
³ mandatory for Visa cards only
⁴ mandatory field only for Canada issuers

SDWO Payment Scenario

Element	Digital Wallet Funding		Purchase via Digital Wallet
Element	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_id¹		M		M

¹ mandatory field for Mastercard cards only

SDWO Payout Scenario

Element	SDWO Payout		SDWO Merchant Payout
Element	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_code¹	M		M
recipient_birth_date	M		M
recipient_city¹	M		M
recipient_address¹	M		M
recipient_state_code²	M		M
sender_name	M		M
crypto	O		O
payment_purpose³	M		M

¹ mandatory only for Canada issuers
² mandatory only for Canada and USA issuers
³ mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, and Mexico recipients

Apple Pay Payment Scenario in SMS Mode

Element	Optional or Mandatory
Element	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_data¹		O
tavv		M
merchant_url²		O
etid		O
merchant_name		O
gate_id²		M

¹ mandatory for operations with the AVS verification
² mandatory for Mastercard

Apple Pay Payment Scenario in DMS Mode

Element	Optional or Mandatory
Element	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_data¹		O
tavv		M
merchant_url²		O
merchant_name		O
etid		O
gate_id²		M

¹ mandatory for operations with the AVS verification
² mandatory for Mastercard

Airline Addendum in SMS Mode

Element	Optional or Mandatory
Element	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_date¹		O
total_fare		O
total_fees		O
total_tax		O
restricted_ticket_indicator		O
gate_id¹		M

Details for airline addendum n_legs specifies the trip leg number and must be between 1..n_legs.

Element	Optional or Mandatory
Element	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

¹ mandatory field for Mastercard cards only

Airline Addendum in DMS Mode

Element	Optional or Mandatory
Element	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_date¹		O
total_fare		O
total_fees		O
total_tax		O
restricted_ticket_indicator		O
gate_id¹		M

Details for airline addendum n_legs specifies the trip leg number and must be between 1..n_legs.

Element	Optional or Mandatory
Element	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

¹ mandatory field for Mastercard cards only

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
Element	Step 1	Step 2
billerRef	M
confirmed		M
finished		M
paymentID		M
clientID	M
amount	O
recurring	O
onfile	O
oboc	O

Recurring DMS Payment Scenario

Recurring payment execution in DMS mode when the cardholder data saved on DECTA side:

Element	Optional or Mandatory
Element	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

Payout Scenarios

P2P Payout Scenario

Element	Optional or Mandatory
Element	Step 1	Step 2
switchingID	M
autoSwitch	M
confirmed		M
finished		M
paymentID		M
language	M
pan¹	M
pan2	M
expiry	O
csc¹	M
avs_data²	M
expiry2	M
amount	M
ccy_code	M
cookie_info_id	O
cardname	M
merchant_ext³	M
merchant_ext2³	M
c_ref³	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_code⁴	M
client_country_code	M
recipient_country_code	M
recipient_birth_date	M
client_account_number	M
client_account_type	M
recipient_account_number¹	M
recipient_account_type¹	M
recipient_address⁵	M
recipient_city⁵	M
recipient_state_code⁴	M
payment_purpose⁶	M
gate_id⁷	M

¹ mandatory for FULL P2P
² mandatory only for FULL P2P (debit operations) with the AVS verification
³ c_ref or combination of merchant_ext (for FULL P2P) and merchant_ext2 must be provided
⁴ mandatory field for Canada and USA issuers
⁵ mandatory field for Canada issuers
⁶ mandatory Visa field for India, Bangladesh, Argentina, Egypt, Chile, Colombia, and Mexico recipients
⁷ mandatory field for Mastercard cards only

B2P Payout Scenario

Element	Optional or Mandatory
Element	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_city¹	M
recipient_address¹	M
recipient_state_code²	M
payment_purpose³	M
crypto	O

¹ mandatory field for Canada and USA issuers
² mandatory field for Canada issuers
³ mandatory Visa field for India, Bangladesh, Argentina, Egypt, Chile, Colombia, and Mexico recipients

OG Payout Scenario

Element	Optional or Mandatory
Element	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_city¹	M
recipient_country_code¹	M
recipient_address¹	M
recipient_state_code²	M
payment_purpose³	M

¹ mandatory field for Canada and USA issuers
² mandatory field for Canada issuers
³ mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, and Mexico recipients

Account to Account Payout Scenario

Element	Optional or Mandatory
Element	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_code¹	M
client_address	M
client_postal_code	M
client_account_number	M
client_account_type	M
payment_purpose²	M

¹ mandatory field for USA and Canada senders
² mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, and Mexico recipients

Funds Transfer Payout Scenario

Element	Optional or Mandatory
Element	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_code¹	M
client_address	M
client_postal_code	M
client_account_number	M
client_account_type	M
crypto	O
payment_purpose²	M

¹ mandatory for USA and Canada senders
² mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, and Mexico recipients

Payroll & Pensions Disbursements

Element	Optional or Mandatory
Element	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_code¹	M
recipient_birth_date	M
recipient_city¹	M
recipient_address¹	M
recipient_state_code²	M
payment_purpose³	M

¹ mandatory field for Canada issuers
² mandatory field for Canada and USA issuers
³ mandatory Visa field only for India, Bangladesh, Argentina, and Egypt, Chile, Colombia, and Mexico recipients

Payment Scenario Element Requirements

Overview

Simple Payment Scenarios

SMS Payment Scenario

DMS/QCash Payment Scenario

AFT Payment Scenario

AFT AA Payment Scenario

SDWO Payment Scenario

SDWO Payout Scenario

Apple Pay Payment Scenario in SMS Mode

Apple Pay Payment Scenario in DMS Mode

Airline Addendum in SMS Mode

Airline Addendum in DMS Mode

Cancel Payment Execution

Return Payment Execution

Payment Result Retrieval

Recurring Payment Scenarios

Recurring SMS Payment Scenario

Recurring DMS Payment Scenario

Payout Scenarios

P2P Payout Scenario

B2P Payout Scenario

OG Payout Scenario

Account to Account Payout Scenario

Funds Transfer Payout Scenario

Payroll & Pensions Disbursements

Jump to