v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payee Payment Channels

Get Payment Channel Details

Get the payment channel details for the payee

get/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.

Query parameters

payableboolean

payable if true only return the payment channel if the payee is payable

sensitiveboolean

<p>Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked.</p> <p>If set to true, and you have permission, the PII values will be returned as their original unmasked values.</p>

Response

Success response, request completed okay

idstring uuid required

payeeIdstring uuid

paymentChannelNamestring required

accountNamestring required

channelTypestring required

Payment channel type. One of the following values: CHANNEL_BANK

countryCodestring required

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.

routingNumberstring

accountNumberstring

ibanstring

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

currencystring required

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.

payorIdsstring[]

payeeNamestring

bankNamestring

bankSwiftBicstring

deletedboolean

enabledboolean

disabledReasonCodestring

disabledReasonstring

payableboolean

Whether this payment channel is payable

Example response

{
  "disabledReason": "disabled reason",
  "disabledReasonCode": "disabled reason code",
  "accountName": "My Account",
  "payorIds": [
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  ],
  "channelType": "CHANNEL_BANK",
  "bankName": "HSBC Bank plc",
  "accountNumber": "XXXXXX5678",
  "bankAddress": {
    "country": "US",
    "countyOrProvince": "FL",
    "line4": "line4",
    "city": "Key West",
    "line3": "line3",
    "line2": "line2",
    "line1": "500 Duval St",
    "zipOrPostcode": "33945"
  },
  "enabled": true,
  "paymentChannelName": "My Payment Channel",
  "routingNumber": "XXXXX6789",
  "payeeName": "John Stuart",
  "deleted": true,
  "payable": true,
  "countryCode": "US",
  "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
  "currency": "USD",
  "id": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
  "payeeId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
  "bankSwiftBic": "MIDLGB22"
}