Payee Payment Channels
Get All Payment Channels Details
Get all payment channels details for a payee
get/v4/payees/{payeeId}/paymentChannels/
Path parameters
payeeIdstring uuid required
Example:2aa5d7e0-2ecb-403f-8494-1865ed0454e9
The UUID of the payee.
Query parameters
payorIdstring uuid
<p>(UUID) the id of the Payor.</p>
<p>If specified the payment channels are filtered to those mapped to this payor.</p>
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>
ignorePayorInviteStatusboolean
payable if true only return the payment channel if the payee is payable
Response
Success response, request completed okay
Example response
{
"paymentChannels": [
{
"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"
},
{
"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"
}
],
"payorToPaymentChannelMappings": [
{
"payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
},
{
"payorId": "9ac75325-5dcd-42d5-b992-175d7e0a035e",
"paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3"
}
]
}