API Reference

Pay By Link

post
https://example.com/tnc/checkout/apis/v2/transactions/link

This API is used to get the long-lived payment transaction link. In the response of the API, there will be a redirect URL to which user is to be redirected. This API is used to create a transaction for processing payments.

HTTP Status and Response Status Matrix

HTTP
Status		Response StatusResponse Message
200CREATEDSuccess
400TRANSACTION_EXPIREDTransaction has expired,
create a new transaction
400VALIDATION_ERRORWhen validation fails for request body,
field specific validation
errors will be returned.
400REJECTEDappUtr provided is already used
500INTERNAL_PROCESSING_ERRORWhen there is an error/exception at Checkout
which is not handled gracefully or un-recoverable.
Specific error messages or generic error
messages will be returned on the basis of scenario.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 20
^[0-9]+$

Amount to be charged. The amount is always considered in the smallest currency sub-unit i.e. to do transaction of 100 USD, provide 10000 as value. In the case of three decimal currencies, such as KWD, BHD and OMR, pass the value as 100000.

string
required
length ≤ 3
^[A-Z]{3}$

Currency in which transaction is to be done. It should follow ISO 4217 describing three-letter codes for currency. e.g. USD, EUR, AED, INR etc.

string
required
length ≤ 250
^[A-Za-z0-9#_,/().&:\\-]+$

Description of the transaction.

string
enum
length ≤ 20

O – If not passed then by default it is PURCHASE. For PURCHASE transaction type, auto capture is enabled. If AUTH is passed, then Capture Transaction API should be called separately to capture the transaction.

Allowed:
notes
object

Notes of the transaction. O – It will be provided back in response to the Check Transaction Status API.

emiDetails
object

EMI details for the transaction. O – If provided, EMI-related information will be used.

app
object
required
string
required
length ≤ 18
^[0-9A-Za-z]+$

Order Id of the transaction. This will be forwarded to the PG if the underlying PG supports it. It may be present in the bank records/statements. NOTE: This is not considered for transaction idempotency

string
required
length ≤ 25

The payment modes allowed for the transaction.

customerDetails
object
required

Customer details including address. C – When provided it will be sent to PG if supported by PG. NOTE: Checkout is not storing any of the customer details.

refundConfig
object
required

This configuration will be used when the refund is initiated on the original transaction.

string
required
length ≤ 5
^\d+$|^$

Transaction link will be active for the mentioned value of minutes.

string
enum
length ≤ 2

O -The language parameter is optional; supported values are EN and AR. If provided, the response will be in the specified language; otherwise, it defaults to English (EN).

Allowed:
string
length ≤ 20
^[A-Za-z0-9]+$

O - The externalCustomerReference parameter, if provided in the request, will be returned in the fetch response and included in the webhook notification.

Headers
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?