Initiate Payment

Used when submitting payment for initiation. It could be used during direct API integration or via SDK / Button integration. Payment initiation must be done before payment information can be submitted via Submit Payment Information API call. The Request data of this API call is very similar to Submit Payment Information API call, differences being:

1. amount, currency_code and many other order-related parameters are not in Submit Payment Information API call
2. payment_method_code and extra payment parameters within payment_info is not a parameter in Initiate Payment API call
3. txn_id must be provided by Initiate Payment API call, and pw_id must be provided by Submit Payment Information API call, being a pair from Initiate Payment API call
4. Any other overlapping parameters from Submit Payment Information API call will overwrite the data within Initiate Payment API call

Method: POST

Action: initiate-payment

Request

Format: POST data

• action required : string (32)

• timestamp required : timestamp (32)

• api_key required : string (32)

• txn_id required : string (255)

• amount required : decimal (11, 2)

• shipping_amount : decimal (11, 2)

• handling_amount : decimal (11, 2)

• tax_exempted_amount : decimal (11, 2)

• currency_code required : string (3)

• short_description : string (255)

• prefered_payment : text

• exclude_payment : text

• prefered_category : string (255)

• subscription_info : key-value

• subscription_info.subscription : boolean

• subscription_info.subscription_frequency : string (32)

• subscription_info.subscription_monthly_charge_day : unix datetime

• payment_info : key-value

• session_info : key-value

• session_info.ip_address : string (45)

• session_info.session_id : string (255)

• session_info.language : string (5)

• buyer_info : key-value

• buyer_info.id required : string (255)

• buyer_info.email required : string (255)

• buyer_info.first_name : string (255)

• buyer_info.last_name : string (255)

• buyer_info.contact_no : string (255)

• buyer_info.contact_no_country_iso2 : string (2)

• buyer_info.contact_no_country_code : string (3)

• buyer_info.country_code required : string (3)

• buyer_info.processing_fee_group : string (64)

• buyer_info.kyc_status : string (32)

• buyer_info.login_ip_address : string (45)

• buyer_info.signup_ip_address : string (45)

• buyer_info.signup_date : timestamp

• billing_info : key-value

• billing_info.name : string (255)

• billing_info.address1 : string (255)

• billing_info.address2 : string (255)

• billing_info.city : string (255)

• billing_info.state : string (255)

• billing_info.zip : string (255)

• billing_info.country : string (255)

• billing_info.country_iso2 : string (2)

• billing_info.contact_no : string (255)

• billing_info.contact_no_country_iso2 : string (2)

• billing_info.email : string (255)

• shipping_info : key-value

• shipping_info.name : string (255)

• shipping_info.address1 : string (255)

• shipping_info.address2 : string (255)

• shipping_info.city : string (255)

• shipping_info.state : string (255)

• shipping_info.zip : string (255)

• shipping_info.country : string (2)

• shipping_info.country_iso2 : string (2)

• shipping_info.contact_no : string (255)

• shipping_info.contact_no_country_iso2 : string (2)

• shipping_info.email : string (255)

• item_info : array *Only up to 20 values, 255 character length for each data

• item_info.x.name : string (255)

• item_info.x.description : string (255)

• item_info.x.amount : decimal (11, 2)

• item_info.x.quantity : decimal (11, 2)

• item_info.x.category : string (128)

• item_info.x.is_tangible_good : boolean

• item_info.x.sku *required: string (255)

• subtotal_info : array * Only up to 20 values, 255 character length for each data

• subtotal_info.x.name : string (255)

• subtotal_info.x.value : decimal (11, 2)

• api_override : key-value

• api_override.notification_url : string (255)

• api_override.success_url : string (255)

• api_override.fail_url : string (255)

• api_override.redirect_extra_param1 : string (255)

• api_override.redirect_extra_param2 : string (255)

• api_override.redirect_extra_param3 : string (255)

• api_override.notification_extra_param1 : string (255)

• api_override.notification_extra_param2 : string (255)

• api_override.notification_extra_param3 : string (255)

• init_setting : key-value

• init_setting.skip_phone_verification : boolean

Response

Format: JSON

• status : string (5)

• message : string (255)

• token : string (32)

• redirect_url : string (255)

Signature

The data involved in generating the signature for this API are:

• timestamp
• action
• api_key
• txn_id
• amount
• currency_code
• api_secret