Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
​
amount
number
required
Required range: x > 0
​
currency
string
required
​
storeId
string
required
​
orderId
string
​
paymentInstrumentId
string
​
mode
enum<string>
default:purchase
Available options:
purchase,
auth,
capture
​
customerId
string
​
initiatedBy
enum<string>
default:customer
Available options:
customer,
merchant
​
reasonType
enum<string>
Available options:
recurring,
unscheduled,
installment
​
returnUrl
string<uri>
​
draft
boolean
default:false
​
isRetry
boolean
default:false
​
threedsSessionId
string
​
subscriptionId
string
​
paymentFlowId
string
​
paymentId
string
​
useTagadaVault
boolean
​
forceProcessorId
string
​
paymentMethod
string
​
processorId
string
​
isExpress
boolean
​
shippingAddress
object

Optional — only for physical goods; omit entirely for digital products. When provided, include a valid ISO 3166-1 alpha-2 country; an address without one is not forwarded to the acquirer.

​
billingAddress
object

Optional but recommended — improves issuer approval rates (AVS) and 3DS frictionless outcomes. When provided, include a valid ISO 3166-1 alpha-2 country; an address without one is not forwarded to the acquirer.

Response

Successful response