Used when submitting payment for finalization. It could be used during direct API integration or via SDK / Button integration. Many of the data is optional; If optional data is found to be required after submitting payment information, buyer will be redirected to a Pipwave-controlled page which collects the required information in merchant’s behalf. Initiate Payment API call 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 Initiate Payment API call, differences being:
- amount, currency_code and many other order-related parameters are not in Submit Payment Information API call
- payment_method_code and extra payment parameters within payment_info is not a parameter in Initiate Payment API call
- pw_id must be provided by Submit Payment Information API call, being a pair from Initiate Payment API call
- Any other overlapping parameters from Submit Payment Information API call will overwrite the data within Initiate Payment API call
Method: POST
Action: submit-payment
Request
Format: POST data
- action
required
: string (32)
Remark |
Sample |
The action of this call, must be hardcoded to “submit-payment” |
submit-payment |
- timestamp
required
: timestamp
Remark |
Sample |
The timestamp for this API call |
- |
- api_key
required
: string (32)
Remark |
Sample |
Pipwave-assigned merchant’s API key |
123456 |
- token
required
: string (32)
Remark |
Sample |
Pipwave’s payment token |
abcdef |
- payment_method_code : string (32)*
Remark |
Sample |
The payment method code that buyer selected. Refer to appendix for list of possible values. |
- |
- payment_info : key-value *Only up to 100 values, must be PG-specific
Remark |
Sample |
Any other payment information which specific PG requires |
- |
- session_info.ip_address : string (45)
Remark |
Sample |
Buyer’s IP address, for anti-fraud purposes |
123.123.123.123 |
- session_info.language : string (5)
Remark |
Sample |
Default: en-gb, language to show to buyer. Refer to appendix for list of possible values. |
en-gb |
- buyer_info.email : string (255)
- buyer_info.first_name : string (255)
Remark |
Sample |
Buyer’s first name |
Doe |
- buyer_info.last_name : string (255)
Remark |
Sample |
Buyer’s last name |
John |
- buyer_info.contact_no : string (255)
Remark |
Sample |
Buyer’s contact number |
123456789 |
- buyer_info.contact_no_country_code : string (3)
Remark |
Sample |
Buyer’s contact number country |
60 |
- billing_info.name : string (255)
Remark |
Sample |
Billing name |
John Doe |
- billing_info.address1 : string (255)
Remark |
Sample |
Billing address |
1, Jalan John |
- billing_info.address2 : string (255)
Remark |
Sample |
Billing address |
- |
- billing_info.city : string (255)
Remark |
Sample |
Billing address city |
John Town |
- billing_info.state : string (255)
Remark |
Sample |
Billing address state |
Selangor |
- billing_info.zip : string (255)
Remark |
Sample |
Billing address zip |
12345 |
- billing_info.country : string (255)
Remark |
Sample |
Billing address country ISO2 |
Malaysia |
- billing_info.country_iso2 : string (2)
Remark |
Sample |
Billing country ISO2 |
MY |
- billing_info.contact_no : string (255)
Remark |
Sample |
Billing contact number |
- |
- billing_info.contact_no_country_iso2 : string (2)
Remark |
Sample |
Billing contact number country ISO2 |
MY |
- billing_info.email : string (255)
Remark |
Sample |
Billing email address |
- |
- shipping_info : key-value
- shipping_info.name : string (255)
Remark |
Sample |
Shipping name |
John Doe |
- shipping_info.address1 : string (255)
Remark |
Sample |
Shipping address |
1, Jalan John |
- shipping_info.address2 : string (255)
Remark |
Sample |
Shipping address |
- |
- shipping_info.city : string (255)
Remark |
Sample |
Shipping address city |
John Town |
- shipping_info.state : string (255)
Remark |
Sample |
Shipping address state |
Selangor |
- shipping_info.zip : string (255)
Remark |
Sample |
Shipping address zip |
12345 |
- shipping_info.country : string (2)
Remark |
Sample |
Shipping address country |
Malaysia |
- shipping_info.country_iso2 : string (2)
Remark |
Sample |
Shipping country ISO2 |
MY |
- shipping_info.contact_no : string (255)
Remark |
Sample |
Shipping contact number |
- |
- shipping_info.contact_no_country_iso2 : string (2)
Remark |
Sample |
Shipping contact number country ISO2 |
MY |
- shipping_info.email : string (255)
Remark |
Sample |
Shipping email address |
- |
* - Not required for direct API, but SDK will automatically populate based on buyer’s selections
Response
Format: JSON
Remark |
Sample |
Status of the request. Refer to appendix for list of possible values. |
0 |
Remark |
Sample |
Error message, if any |
- |
- redirect_url : string (255)
- payment_status: string (5)
Remark |
Sample |
Status of the payment. Refer to appendix for list of possible values. |
- |
- payment_reason : string (255)
Remark |
Sample |
The reason why the PG status is not successful |
- |
Signature
There is no need to include signature in this API call.