Endpoint: https://api.validate.bankersalmanac.com/payment-networkĀ
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/paymentNetworkĀ
Overview
This call is designed to return the details of the payment networks or channels that the institution is a member of.
The call willĀ retrieve the details against the national code entered. Ā These are:
- National id participating in the payment network (channel)
- Direct or Indirect participation
- Additional network details.
This call will return all may return multiple channels that the institution is a member of.
Endpoint inputs
The request parameters are below in the table that describes theĀ and here is the extract from the service WADL.
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | ISO Country Code | Alpha | Optional | |
| nationalId | Bank national id | Alphanumeric | Optional | |
| accountNumber | Account Number | Alphanumeric | Optional | |
| bic8 | BIC 8 | Y or N | Optional | |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | Optional | |
| ref | Your reference | Alphanumeric & Extended Characters | Optional | |
| group | Group | Alphanumeric | Optional | |
| bankToken | Bank token | Alphanumeric & Extended Characters | Mandatory | |
| errorComment | If the field is set to E then you will be able to edit the error text in the self service hub | E | Optional |
Response modifications
| Field Name | Description | Format |
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N |
Response outcomes
To understand the responses, please refer to Swagger āĀ https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/paymentNetwork
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| countryCode | ISO Country Code | Alpha | ||
| nationalId | Bank code entered in the search | Alphanumeric | ||
| accountNumber | Account number | Alphanumeric | ||
| status | Status of the response PASS, CAUTION or FAIL | Alpha | ||
| comment | Alphanumeric | |||
| bic8 | Domestic accountNumber or IBAN. | Alphanumeric | ||
| dataStore | Yes/No flag if you wish the data to be stored for periodic scanning | Y or N | ||
| ref | Your reference | Alphanumeric & Extended Characters | ||
| group | Group | Alphanumeric | ||
| payServiceDetails | ||||
| serviceId | Service Name | Alphanumeric | ||
| currency | ISO Currency Code | Alpha | ||
| participantId | Routing Number | Alphanumeric | ||
| participantName | The Institution name | Alpha | ||
| participantType | ISO Country Code | Alpha | ||
| directIndirect | āDā if PARTICIPANT TYPE is Directly connected; āIā if PARTICIPANT TYPE is Indirectly connected. | Alpha | ||
| intermediaryId | Country Intermediary Id | Alpha | ||
| addressableId | Bank Code | Alphanumeric | ||
| attributeType1 | Location type | Alpha | ||
| attributeValue1 | Location type value | Alpha | ||
| attributeType2 | Payment type/flag | Alpha | ||
| attributeValue2 | Payment type/flag value | Alpha | ||
| attributeType3 | Transaction description | Alpha | ||
| attributeValue3 | Transaction allowed country codes | Alpha | ||
| countryCode | ISO Country Code | Alpha | ||
| scheme | Bank Address | Alpha |
Ā Test Examples
token