Create channel

Creates a new channel for transaction routing and control.

A channel is a client‑defined code that identifies the source of a payment or cash‑management operation. It controls how back‑business‑date transactions are handled and determines whether a transaction can bypass cutoff rules, since only active channels in the allowed set can override the cutoff. Channels also enable routing based on the transaction’s source.

This endpoint generates the following events:

Refer to Data and reporting for more information about events and setting up event notifications.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create channel request body

Request body to create a new channel

string
required
length between 1 and 20
^[a-zA-Z0-9]+$

Alphanumeric channel code identifier

string
length ≤ 255

Text describing the channel

Responses

401

Access token is missing or invalid

403

The request has been lost

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json