v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payee Payment Channels

Create Payment Channel

Create a payment channel

post/v4/payees/{payeeId}/paymentChannels/

Path parameters

payeeIdstring uuid required

Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9

The UUID of the payee.

Request body

paymentChannelNamestring

ibanstring

Must match the regular expression ^[A-Za-z0-9]+$.

accountNumberstring

routingNumberstring

countryCodestring

Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.

currencystring

Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.

accountNamestring

Example request

{
  "paymentChannelName": "My Payment Channel",
  "routingNumber": "XXXXX6789",
  "accountName": "My Account",
  "countryCode": "US",
  "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
  "currency": "USD",
  "accountNumber": "XXXXXX5678"
}

Response

Payment channel is created.