search
Sandbox LoginProduction LoginStatus Page

Creating payment link

POST /api/public/v1/payment_links

This endpoint creates payment links.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Request Body

Name
Type
Required
Description

data.type

string

Yes

Can only be payment_links.

data.attributes.amount

string

Yes

Payment amount to display to end users.

data.attributes.currency

string

Yes

Payment currency to display to end users. Refer to supported currencies.

data.attributes.accountCurrency

string

No

Specifies the merchant account to be used for crediting invoice payments or debiting payout amounts. Can be EUR, USD, USDT or USDC.

data.attributes.paymentType

string

Yes

Payment type. Can be either Invoice or Payout.

data.attributes.paymentMethods

array

No

This field is an array listing the supported payment methods for a particular invoice.

Can be ONE of these possible values:

  • "on_chain" - Generates a deposit wallet address for receiving an on-chain cryptocurrency transaction. Users can send crypto directly from their wallet.

  • "binance_pay" - Generates payment instructions for an off-chain payment via the Binance app, allowing users to complete the transaction within Binance.

  • "nft" - Generates payment instructions for purchasing an NFT.

If no value supplied, defaults to "on_chain".

data.attributes.payCurrencies[]

array

No

If you want to limit the cryptocurrency and token options your end-users can make payments in, provide a list of allowed options. Refer to supported currencies.

data.attributes.reference

string

No

The custom reference ID to tie the payment to end-user. This can be anything you choose. Must be a unique value for each payment you create.

data.attributes.expires_at

string

Yes

Payment link expiration date and time. Follow the format 2025-01-12T23:00:00.000Z

data.attributes.successRedirectUrl

string

No

Only applicable to Invoices. URL you want your customer to be redirected from our hosted page to if the invoice completes.

data.attributes.unsuccessRedirectUrl

string

No

Only applicable to Invoices. URL you want your customer to be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.

cURL

curl -X "POST" "https://api.sandbox.txn.pro/api/public/v1/payment_links" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer ' \
     -d $'{
  "data": {
    "type": "payment_links",
    "attributes": {
      "amount": "100",
      "currency": "EUR",
      "accountCurrency": "EUR",
      "reference": "8c40d8b6-ccdf-4861-a6d6-6c3125ce3f31",
      "expires_at": "2025-01-12T23:00:00.000Z",
      "paymentType": "Invoice",
      "paymentMethods": [
        "on_chain"
      ],
      "payCurrencies": [
        "USDC"
      ],
      "successRedirectUrl": "https://example.com/success",
      "unsuccessRedirectUrl": "https://example.com/fail"
    }
  }
}'

Response Body

Name
Type
Description

data.id

string

Payment link ID.

data.type

string

Entity type returned. Always paymentLinks.

data.attributes

object

Set of payment attributes.

data.attributes.amount

string

Payment amount to display to end users.

data.attributes.currency

string

Payment currency to display to end users. Refer to Supported currencies.

data.attributes.accountCurrency

string

Specifies the merchant account to be used for crediting invoice payments or debiting payout amounts.

data.attributes.network

string

Payment network code. E.g. trx:usdt. Refer to Supported currencies.

data.attributes.networkName

string

Payment network name. E.g. Tron (TRC20). Refer to Supported currencies.

data.attributes.reference

string

The custom reference ID to tie the payment to end-user.

data.attributes.hostedPageUrl

The payment hosted page URL to redirect your end-users to.

data.attributes.status

string

Payment link status context. Can be created, pending, completed, expired.

data.attributes.network

string

Network code. Refer to Supported currencies.

data.attributes.expiresAt

string

Payment link expiry date and time.

data.attributes.createdAt

string

Date and time payment was created at.

data.attributes.paymentType

string

Payment type. Can be either Invoice or Payout.

data.attributes.paymentMethods[]

array

Available payment methods.

data.attributes.payCurrencies[]

array

A list of cryptocurrency and token options your end-users can make payments in. This can be left empty if no value is passed in the request.

data.attributes.successRedirectUrl

string

URL you want your customer to be redirected from our hosted page to if the invoice completes.

data.attributes.unsuccessRedirectUrl

string

URL you want your customer to be redirected from our hosted page to if the invoice gets expired, cancelled or rejected.

data.relationships.target

object

This object will contain ID of the child Invoice or Payout generated by the Payment Link.

included

array

This array will contain data about the child Invoice or Payout generated by the Payment Link. For more details refer to Invoice and Payout pyaloads.

Response

PreviousPayment links conceptNextExpiring payment link

Last updated