Initiate Payment

post

https://api.portone.cloud/api/initiatePayment

Create a payment transaction for specific PSP and their supported Payment Methods. Please refer the list of supported PSPs & payment methods on PortOne. Once you have the response, depending on the “Payment Method” attribute, you will be either redirected to the PSP hosted payment page OR results page incase of Card/ Installment methods.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

key

string

required

The unique PortOne key for merchant

merchant_order_id

string

required

The unique merchant order reference generated by the merchant

pmt_channel

string

required

The Payment Channel Key listed in PortOne docs

pmt_method

string

required

The Payment Method Key listed in PortOne docs

description

string

required

The description of the transaction

environment

string

enum

required

The environment of the transaction is either live OR sandbox

Allowed:

amount

double

required

The amount of transaction, can be a floating-point number

currency

string

required

The currency of transaction

signature_hash

string

required

The signature_hash of transaction details generated as per Payment Request Signature Documentation

billing_details

object

The JSON object for billing details

shipping_details

object

The JSON object for shipping details

token_params

object

The JSON object for initiating transaction using card details

order_details

array of objects

The JSON array for order details

Orders object

success_url

string

required

The url of success page hosted by merchant.

failure_url

string

required

The url of failure page hosted by merchant.

pending_url

string

The url of pending page hosted by merchant.

routing_enabled

boolean

Boolean flag to identify if routing is enabled

routing_params

object

The JSON object for adding routing details, only applicable in routing enabled is set to true

transaction_type

string

enum

The type of the transaction to capture

Allowed:

user_configured_field1

string

Custom user configured field 1

user_configured_field2

string

Custom user configuration field 2

user_configured_field3

string

Custom user configuration field 3

user_configured_field4

string

Custom user configuration field 4

user_configured_field5

string

Custom user configuration field 5

Headers

Content-Type

string

X-Portone-Client-Key

string

Responses

200Successful response

401Failure response