Theme switcher

Pay By Link

Sample

merchantIdstring

The unique identifier assigned to the merchant within the payment system.

sessionModestring

Specifies the intended action or context for the payment session, such as authorization or capture.

transactionInitiatorstring

Identifies the party that initiated the transaction, providing context for transaction processing.

currencystring

The ISO 4217 currency code specifying the transaction currency, such as "AUD" for Australian Dollar, "USD" for US Dollar, or "GBP" for British Pound. See https://en.wikipedia.org/wiki/ISO_4217 for all supported currencies.

amountstring

The monetary amount to be processed in the transaction (decimal value e.g.15.00)

merchantReferencestring

A merchant-provided reference string used for transaction identification or reporting.

sendLinkBystring

Specifies the delivery method for sending the Pay by Link to the recipient, such as email or SMS.

emailstring

The email address where the Pay by Link will be sent if email delivery is selected.

countryCodestring

The ISO 3166-1 alpha-2 country code used specifically for SMS delivery routing.

phoneNumberstring

The mobile phone number where the Pay by Link will be sent via SMS.

cardAuthenticationModestring

Specifies the card authentication method to be used, such as 3DS2 (3-D Secure 2) or AVS (Address Verification Service).

redirectUrlsobject
validForobject
countrystring

The ISO 3166-1 alpha-2 country code representing the cardholder’s country. For example, use "AU" for Australia, "US" for United States, or "GB" for United Kingdom. Refer to https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for all supported codes.

metadataarray
cardBrandsarray
displayConfigobject
billingAddressobject
allowToSaveCardboolean

Boolean flag indicating whether users can save their card details for future transactions.

timeoutMinutesnumber

Duration in minutes before the payment link expires and becomes invalid.

Was this section helpful?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 { "merchantId": "*****", "sessionMode": "PERFORM_TRANSACTION", "transactionInitiator": "CARDHOLDER", "currency": "USD", "amount": "", "merchantReference": "INVOICE_1", "sendLinkBy": "", "email": "example@gmail.com", "countryCode": "1", "phoneNumber": "**********", "cardAuthenticationMode": "NONE", "redirectUrls": { "approvedUrl": "https://www.example.com", "declinedUrl": "https://www.example.com", "errorUrl": "https://www.example.com", "cancelUrl": "https://www.example.com" }, "validFor": { "value": 1, "unit": "Day" }, "country": "US", "metadata": [ { "name": "Order", "value": "12345" } ], "cardBrands": [ { "card": "VISA", "showLogo": true, "surchargePercentage": "0.00" }, { "card": "MASTERCARD", "showLogo": true, "surchargeAmount": "0.00" }, { "card": "AMEX", "surchargePercentage": "0.00" } ], "displayConfig": { "theme": "tns", "headerText": "Welcome to the Example Store", "logoUrl": "https://tnsi.com/wp-content/uploads/2022/09/brand.svg", "pageTitle": "Pay by Link", "backToCartButtonLabel": "Cancel", "showCart": false, "showAmounts": true, "showBasketIcon": false, "showFooterBar": true, "footerText": "This is a sample footer message", "showPayButton": true, "payButtonLabel": "Pay", "cancelButtonLabel": "Cancel", "googlePay": "button", "applePay": "button", "paypal": "button", "customCss": null, "approvedMessage": "Transaction is Approved. Contact Merchant for more details", "declinedMessage": "Transaction is Declined. Contact Merchant for more details", "errorMessage": "Transaction Error. Contact Merchant for more details", "linkExpiredMessage": "Link Expired. Contact Customer Care" }, "billingAddress": { "firstName": "John", "lastName": "Smith", "addressLine1": "Street Line 1", "city": "San Jose", "state": "CA", "phone": "********", "email": "john.smith@gmail.com", "zipCode": "95234", "country": "USA" }, "allowToSaveCard": true, "timeoutMinutes": 10 }
Was this section helpful?