Initiate transaction from online channel

Securityapi_key
Request
Request Body schema: application/json
object (TMerchantData)

merchant related data

amount
required
number

the amount of money for this payment

currency
string

local currency of the merchant

autoComplete
boolean
Default: true

default is true (for instant payment). for pre-auth, please set to false

channel
string
Default: "ECOMMERCE"
Enum: "ECOMMERCE" "POS" "MAIL_ORDER" "TELEPHONE_ORDER" "OTHER"
object (TStandingInstruction)

indicator / reason code for Card On File

description
string

transaction description (max 50 chars)

register
boolean
Default: false

indicator to store payment method (payment method must belong to a customer, hence require to register a customer). For subscription, this flag is not relevant as subscription require payment token to be stored.

object (TCustomer)

customer details object

required
object

payment method used for this payment

object

capture the subscription details only if Till maintain the agreement.

object (TThreeDSOption)

3DS request options

object (TThreeDSResult)

3DS result data

object

this metadata is used to address any specific merchants / partners integration requirements.

Responses
200

Successful response.

400

Invalid Request

401

Invalid API key.

403

Forbidden from performing this action.

500
post/online/v1/payment
Request samples
application/json
{
  • "merchantData": {
    },
  • "amount": 1,
  • "currency": "AUD",
  • "autoComplete": true,
  • "reasonCode": "INITIAL",
  • "description": "Test1234",
  • "register": false,
  • "paymentMethod": {
    }
}
Response samples
application/json
{
  • "transactionReceipt": "string",
  • "payment": {
    },
  • "result": {
    }
}