Txn.pro - API Documentation
Sandbox LoginChangelogStatus Page
  • Getting setup
    • Environments
    • Creating a Sandbox account
    • Back office user roles
    • Creating your API keys
    • Postman collection
  • API Basics
    • API specification
    • API status
    • Supported currencies
    • Date and time format
    • Authenticating the API
    • Webhooks
      • Verifying webhooks
      • Source IP addresses
      • Retrying schedule
    • Rate limits
  • Hosted pages
  • Accounts
    • Accounts concept
    • Listing accounts
    • Reading account
    • Listing account addresses
    • Creating account address
    • Listing account transactions
    • Reading account transaction
  • Exchange
    • Exchange concept
    • Supported currency pairs
    • Reading exchange rates
    • Exchange webhooks
    • Creating quote
    • Confirming quote
  • Invoices
    • Invoices concept
    • Invoice status flow
    • Invoices in cashier
    • Invoice limitations
    • Listing invoice currency pairs
    • Invoice webhooks
    • Creating invoice
    • Reading invoice
    • Listing invoices
    • Invoice refunds
  • Payouts
    • Payouts concept
    • Payout status flow
    • Payout limitations
    • Listing payout currency pairs
    • Validating addresses
    • Payout webhooks
    • Creating payout
    • Reading payout
    • Listing payouts
  • Mass Payouts
  • PAYMENT LINKS
    • Payment links concept
    • Creating payment link
    • Expiring payment link
    • Reading payment link
    • Listing payment links
  • CHANNELS
    • Channels concept
    • Channels deposit flow
    • Listing channel currency pairs
    • Channel webhooks
    • Creating channel
    • Reading channel
    • Updating channel
    • Listing channels
    • Listing channel deposits
    • Reading channel deposit
  • (BETA) Fiat Settlements
    • Important information
    • Bank withdrawal webhooks
    • Bank deposit webhooks
    • Listing bank accounts
    • Reading bank account
    • Previewing bank withdrawal
    • Creating bank withdrawal
    • Listing bank withdrawals
    • Reading bank withdrawal
    • Listing bank deposits
    • Reading bank deposit
Powered by GitBook
On this page
  • Types of Payment Links
  • Invoice Payment Links
  • Payout Payment Links
  • List of Payment Link States
  • Payment Link UI Examples
  • Invoice Payment Links
  • Payout Payment Links
  1. PAYMENT LINKS

Payment links concept

PreviousMass PayoutsNextCreating payment link

Last updated 3 months ago

Payment Links are an add-on feature for Invoices and Payouts. While both and can be created independently with predefined cryptocurrencies and networks via dedicated endpoints, Payment Links enable merchants to extend the payment flow. By creating a Payment Link, you can redirect customers and end-users to a Payment Link page hosted by Txn, where they can select the cryptocurrency and network they prefer to use for payment.

Types of Payment Links

Invoice Payment Links

These links initiate the creation of invoices and emit invoice webhook messages to notify merchants about the status of invoice payments.

Payout Payment Links

These links perform a similar function for payouts, triggering the creation of payouts and emitting corresponding webhook messages to update merchants on payout statuses.

List of Payment Link States

Payment Links do not share their statuses with child Invoices and Payouts; they are independent entities. Refer to the list of Payment Link statuses in the table below.

For information on possible statuses for Invoices and Payouts, please refer to the corresponding documentation:

Status
Final?
Description

created

N

This is the initial status of the Payment Link, which will later update to either Pending if your end-user takes action, Completed if your end-user completes the payment or Expired.

pending

N

The status Pending means that the end-user has triggered the creation of a child invoice or payout via the payment link. If they complete the payment, the payment link status updates to Completed. Otherwise, it changes to Expired.

completed

Y

This is the final status, indicating that your end-user has successfully initiated a child Invoice or Payout through the Payment Link. As a result, the Payment Link is considered Completed.

expired

Y

This is the final status, indicating that your end-user did not proceed with initiating their deposit or withdrawal transaction while the Payment Link was pending.

Payment Link UI Examples

Invoice Payment Links

A Payment Link is created to allow an end-user to select their preferred cryptocurrency (coin) and network for completing a transaction:

After clicking Continue, Txn creates an invoice and redirects the end-user to the invoice page hosted by Txn:


Payout Payment Links

A Payment Link is created to enable an end-user to select their preferred cryptocurrency (coin) and network, as well as submit their wallet address to complete the transaction:

After clicking Continue, the end-user is prompted to review their payout details before the cryptocurrency transaction is sent to their wallet address:

After clicking Confirm, Txn initiates a cryptocurrency transaction to the end-user's wallet address:

Read more about the and to gain a complete understanding of how the entire process works.

Read more about the and to gain a complete understanding of how the entire process works.

Invoices Concept
Invoice Payment Flow
Payouts Concept
Payout Payment Flow
Invoice status flow
Invoice webhooks
Payout status flow
Payout webhooks
Invoices
Payouts