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
  1. CHANNELS

Updating channel

PATCH /api/public/v1/channels/:id/status

This endpoints updates channel status.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Path Parameters

Name
Type
Description

id

string

Channel ID.

Body

Name
Type
Description

data.type

string

Aways channels.

data.attributes.status

string

Can be either enabled or disabled.

Response

{
  "data": {
    "id": "60e05bc0-4690-4985-a08a-8acf00e48294",
    "type": "channels",
    "attributes": {
      "reference": "ecd05fb9-76e6-42e7-b86e-5a7e18f4da6d",
      "status": "disabled",
      "createdAt": "2024-09-25T08:35:07.034Z",
      "updatedAt": "2024-09-25T09:31:21.958Z",
      "payCurrency": "USDT",
      "targetCurrency": "USD",
      "address": "TJTuEYJ8P9to4Zhdw7zg55VPH3gzLaQDV6",
      "networkName": "Tron (TRC20)",
      "networkCode": "ttrx:usdt",
      "hostedPageUrl": "https://sandbox.txn.pro/redirect?channel_id=60e05bc0-4690-4985-a08a-8acf00e48294\u0026request_type=channel_hosted_page\u0026zone=eu"
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}
{
  "errors": [
    {
      "status": 404,
      "title": "Record not found",
      "code": "channel_not_found"
    }
  ]
}

Response Body

Name
Type
Description

data.id

string

Channel ID.

data.type

string

Always channels.

data.attributes.targetCurrency

string

data.attributes.payCurrency

string

data.attributes.address

string

Channel address.

data.attributes.networkCode

string

data.attributes.networkName

string

Network name.

data.attributes.hostedPageUrl

string

Channel redirect URL hosted by Txn.

data.attributes.reference

string

The custom reference ID to tie the channel and its deposits to end-user who pays.

data.attributes.status

string

Channel status. Can be either enabled or disabled. If enabled, deposits get processed and credited to the merchant's account as normal. If disabled, deposits do not get credited to the merchant's account.

data.attributes.createdAt

string

Timestamp when a channel was created.

data.attributes.updatedAt

string

Timestamp when a channel was last updated.

PreviousReading channelNextListing channels

Last updated 2 months ago

Channel currency to display to end users. Determines the currency due after processing and conversion. Refer to currencies.

Crypto currency that customer must pay in. Refer to currencies.

Payment network code. Refer to networks.

supported
supported
supported