v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payee Payment Channels

Update Payment Channel

Update the details of the payment channel. Note payment channels are immutable. The current payment channel will be logically deleted as part of this call and replaced with new one with the correct details; this endpoint will return a Location header with a link to the new payment channel upon success. Updating a currently disabled payment channel will result in a new, fully enabled, payment channel.

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

Path parameters

payeeIdstring uuid required

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

The UUID of the payee.

paymentChannelIdstring uuid required

Example:70faaff7-2c32-4b44-b27f-f0b6c484e6f3

The UUID of the payment channel.

Request body

routingNumberstring

accountNumberstring

ibanstring

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

paymentChannelNamestring

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.

accountNamestring

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.

Example request

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

Response

Request accepted. No content.