Create a new payment session/transaction

POST

/api/v1/payment_session/{gid}

Fynd Platform will call this API to initiate/create payment session/transaction. Extension will need to validate checksum_auth in headers before proceeding with the request.

Request Parameters

gid

string

Global identifier for the transaction. This is generated by Fynd payments platform and is unique for each transaction

Request body

amount

integer

Transaction value in the smallest unit of the currency (paise/cents)

app_id

string

Application id of sales channel

billing_address

object (AddressDetail)

Optional

AddressDetail

cancel_url

string

A URL provided by the Fynd platform for redirection in case of payment failure

cod_eligibility

boolean

Indicates whether Cash on Delivery is available for the transaction - To be used only by Payment Gateways which support Cash on Delivery

company_id

string

Unique identifier for the company

currency

string

Currency of the payment

customer_contact

string

Customer's mobile number

customer_email

string

Customer's email

customer_name

string

Customer's name

fynd_platform_id

string

Unique Order Id for which payment was made

g_user_id

string

A unique global user Id, created by the Fynd platform

gid

string

Global identifier of the transaction against which payment_session was initiated. This is generated by Fynd payments platform and is unique for each transaction

initiated_at

integer

Timestamp marking when the payment was initiated, in epoch time

journey_type

string

Enum

kind

string

Optional

Kind of transaction: either a one-time payment (sale) or a subscription, with the default set to sale

Default Value : sale

Enum

locale

string

Optional

User's language locale

Default Value : en

merchant_locale

string

Optional

Merchant's language locale

Default Value : en