Skip to main content
POST
Single Payment Subscription

Authorizations

x-api-key
string
header
required

Merchant API Key

x-signature
string
header
required

Generated request signature

Body

application/json
subscriptionId
string<MongoId>
required

This is transact bridge subscription Id

referenceId
string<referenceId>
required

This is a partner-generated ID to map a subscription. Partners can use this to query the subscriptions as well. This cannot be the same for two subscriptions.

returnUrl
string
required

This URL is needed to redirect the user after the session is completed.

Example:

"https://example.com/payment/success"

items
object[]
required

Items the customer wants to buy.

mandatePay
boolean
default:false

If marked as true then the invoice will be paid through the current mandate.

Example:

false

payMethod
enum<string>[]

If payMethod parameter is sent by the partner then on the payment page for the customer only that payment method will be visible to user.

Available options:
UPI,
NB,
CC,
DC
Example:
dayUntillDue
string

Period of time from the issue date after which DUE invoice is converted into OVERDUE status

Example:

"7"

reAttempt
object[]

To configure how the reattempt for failed invoices be processed.

Response

200 - application/json

Contains the subscriptionId and URL

status
string

The response from the API

sub_status
string

Used for internal purposes only

data
object

Contains the subscriptionId and URL.