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
  • March 25, 2025
  • February 1, 2025
  • January 15, 2025
  • January 3, 2025
  • December 14, 2024
  • December 5, 2024
  • November 15, 2024
  • November 11, 2024
  • October 10, 2024
  • October 8, 2024
  • Spetember 20, 2024
  • September 16, 2024
  • August 21, 2024
  • July 23, 2024
  • July 12, 2024
  • July 2, 2024
  1. API Basics

Changelog

Last updated 1 month ago

March 25, 2025

Added support for new tokens.

Name
Code
Network

Polygon Token

POL

Polygon

Native USD Coin

USDC

Polygon

Please refer to a page for more detail.

February 1, 2025

Added support for Chinese Yuan (CNY), Brazilian Real (BRL), Chilean Peso (CLP) and Indian Rupee (INR) currencies.

The following currency pairs are available and supported in invoices, channels and payouts:

  • crypto/CNY

  • crypto/BRL

  • crypto/CLP

  • crypto/INR

Please note that when creating invocies, channels and payouts with this currencies, merchants are also required to supply their account currency they'd like to get payments processed through, e.g. EUR.

January 15, 2025

Merchants can now supply their preferred account currency when creating invoices, channels and payouts.

  • For invoices, it's a new optional targetCurrency parameter which specifies the account that an invoice payment amount should be credited to.

  • For channels, it's a new optional localCurrency parameter which specifies the currency code that a channel deposit amount should be denoted in.

  • For payouts, it's a new optional sourceCurrency parameter which specifies the account that a payout amount should be debited from.

  • For payment links, it's a new optional accountCurrency paramter which specifies the account that a payment amount should be credited/debited to/from.

January 3, 2025

Added support for Canadian Dollar (CAD) and New Zealand Dollar (NZD) currencies.

The following currency pairs and directions are available and supported in exchanges, invoices, channels and payouts:

  • crypto/CAD - buy and sell

  • crypto/NZD - buy and sell

  • EUR/CAD - buy and sell

  • EUR/NZD - buy and sell

December 14, 2024

December 5, 2024

Platform users can now request CSV transaction reports containing data on all currency account transactions via the UI and receive the files at their registered email addresses. Navigate to the Reports page from the left-hand menu in your Txn account.

November 15, 2024

Added support for a new token.

Name
Code
Network

Chainlink

LINK

Ethereum (ERC20)

November 11, 2024

Added support for new cryptocurrencies and tokens.

Name
Code
Network

Bitcoin Cash

BCH

BItcoin Cash

Litecoin

LTC

Litecoin

Ether

ETH

Ethereum

Tether USD

USDT

Ethereum (ERC20)

USD Coin

USDC

Ethereum (ERC20)

XRP

XRP

Ripple

CNH trading currency pairs delisted

Txn no longer supports currency pairs and trading routes for buying and selling CNH. We are working on a comprehensive solution to support additional fiat currencies.

Additional routes for crypto-crypto invoices and payouts

Invoice Flow: USDT <- BTC, BCH, LTC, ETH, USDT, USDC, TRX, XRP. Users can pay with any of the supported cryptocurrencies or tokens, and merchants are settled in USDT.

Payout Flow: USDT -> BTC, BCH, LTC, ETH, USDT, USDC, TRX, XRP. Users can request payouts in any supported cryptocurrency or token, which will be processed from the merchant’s USDT balance.

Endpoints for listing and creating account addresses

October 10, 2024

Handling of invoice payment exception scenarios and automated invoice refunds are now available for Txn clients.

Merchants can now use automated by Txn payment refunds in scenarios where their end-users overpay, underpay, or make a payment after the invoice has expired. Txn issues a refund payment link, which can be embedded or emailed to the end-user. On the refund webpage, end-users are asked to provide their wallet address where they would like to receive their refund.

October 8, 2024

The Channels related public API endpoints made available to Txn clients:

Spetember 20, 2024

Added support for Offshore Renminbi (CNH) currency.

The following currency pairs and directions are available and supported in exchanges, invoices, channels and payouts:

  • USDT/CNH - buy and sell

  • BTC/CNH - buy and sell

September 16, 2024

Webhook messages are now available in both Production and Sandbox environments.

August 21, 2024

Invoices

  • successRedirectUrl: Specifies the URL to which your customer will be redirected after a successful invoice completion

  • unsuccessRedirectUrl: Specifies the URL to redirect your customer if the invoice expires, is canceled, or is rejected

Additionally, invoices now come with hosted web pages provided by Txn. You can either embed these hosted pages within your UI or redirect your customers to them. The API response for each invoice now includes the hostedPageUrl attribute, which contains the URL of the hosted page.

Payouts

  • absorbFees: If true, both service and network fees are deducted from the transaction amount. If false, both fees are deducted from your account balance.

July 23, 2024

Key Features:

  • Address Format Validation: Ensures that the provided address adheres to the correct format

  • Address Risk Profile Assessment: Evaluates the risk associated with the address, helping to mitigate fraudulent transactions

July 12, 2024

The Invoices and Payouts related public API endpoints made available to Txn clients:

Invoices

Payouts

July 2, 2024

The Accounts and Exchange related public API endpoints made available to Txn clients:

Accounts

Exchange

The endpoints are exposed in the public API, allowing platform clients to fetch data about bank accounts linked to their transaction accounts, as well as to receive webhook notifications related to bank deposits and withdrawals.

Please refer to a page for more detail.

Please refer to a page for more detail.

Txn clients can now acceess API endpoints for and account addresses.

Please refer to the page for more information on how it works for both merchants and their end-users.

For more information, please refer to the page.

The following optional parameters are now supported in the API call:

The following optional parameter is now supported in the API call:

The endpoint made available for Txn Public API users. This new feature enhances the security and reliability of your crypto payout transactions by providing address validation capabilities.

Usage Recommendation: We strongly recommend that Txn merchants utilize this endpoint to validate destination wallet addresses before initiating crypto payouts via the endpoint. By doing so, you can prevent potential issues arising from invalid address formats or high-risk addresses.

Supported Currencies
Fiat Settlement API
Supported Currencies
Supported Currencies
listing
creating
Invoice Refunds
Create channel
Read channel
Update channel
List channels
List channel deposits by channel ID
Read channel depopsit
Webhooks
Create Invoice
Create Payout
Validate Address
Create Payout
Create invoice
Read invoice
List invoices
Create payout
Read payout
List payouts
List accounts
Read account
List account transactions
Read account transaction
Read exchange rate
Create quote
Confirm quote