API Reference
Dashboard

Create a Bank Channel

post
https://faas.sandbox.tracefinance.io/exchange/api/bankChannels

Creates a new bank channel, which represents a bank account associated with a specific counterparty. This is a necessary step before you can create orders that involve this bank account.

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

Request payload for creating a new bank channel. The type of channel can be TED/Pix, SWIFT, or Crypto Wallet. Each channel type has specific required fields. The correct schema is selected based on the type field provided in the request.

Payload schema for creating a TED/Pix bank channel in BRL. Requires bank code, branch code, and account number when the Pix key is not provided. The Pix key is optional. Used for domestic payments in Brazil.

string
enum
required

Bank channel type

Allowed:
string
required

Bank channel nick name

string

Required if pixKey is not provided.

string

Required if pixKey is not provided.

string

Required if pixKey is not provided.

string

Optional. If not provided, bankCode, branchCode, and accountNumber are required.

string

identifier for the bank channel. For virtual accounts, this field must contain the virtual account ID; for standard bank accounts, it may be a user-defined label or nickname for identification.

Headers
string

Access Token

const
enum
required

Indicates the version of Trace Finance's API to be used. This header should be included by clients using version 2 of the API

Allowed:
Responses

Updated 20 days ago

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

Updated 20 days ago