Payments APIInstitutions
Get institution details
GET
Fetch particular institution details.
Bearerheader
AuthorizationBearer <JWT>Bearer token using a JWT.
id*stringIdentifier of the institution.
Format
uuidX-Volt-Api-Version*1Version of the API used. Currently, version 1 is the only version.
Value in
1OK - Successful request, returning given institution's details.
application/json- response
id?stringIdentifier of the institution.
Format
uuidcountry?stringInstitution country.
Length
2 <= length <= 2name?stringName of the institution.
localName?|Localised name of the institution.
alternativeName?|Alternative name of the institution.
Might be previous name, etc. Handy for search mechanisms on merchant's side.
group?Institutions' group info.
branch?Institution's branch info.
nationalId?|National ID of the institution.
assets?Graphical assets for the institution.
types?array<>Institution type(s).
capabilities?List of institution's capabilities with details.
curl -X GET 'https://gateway.sandbox.volt.io/institutions/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'X-Volt-Api-Version: 1'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "country": "DE", "name": "Sparkasse Nienburg", "localName": "Sparkasse Nienburg", "alternativeName": null, "group": { "name": "Sparkasse", "localName": "Sparkasse" }, "branch": { "name": "Nienburg", "localName": "Nienburg" }, "nationalId": "25650106", "assets": { "icon": "http://cdn.example.com/assets/bank.svg", "logo": "http://cdn.example.com/assets/bank.svg" }, "types": [ "BUSINESS" ], "capabilities": { "payments": { "active": true, "accountIdentifiersRequired": [ "IBAN" ], "additionalDataRequired": [], "communication": { "appToApp": "SUPPORTED" }, "recurring": { "commercial": false } } }}