After successful onboarding, you’re ready to integrate with Volt. The first step in building the end-user experience is institution selection. The GET /institutions endpoint returns all necessary data required to build an interface where the end-user can select an institution (bank) from which an account-to-account payment will be initiated.

Endpoint:
GET /institutions

Required Query Parameters:

• currency: Currency of the payment (e.g., GBP, EUR)
• country: Country of your user initiating the payment (ISO 3166 alpha-2 format, e.g., GB, PL)

Optional Query Parameter:

• active: Filter institutions by active (true) or inactive (false) status

Usage Tips:

• Ensure your UI captures and correctly sends the currency and country parameters based on the user’s selection and context.
• Utilise the active parameter to display only relevant institutions if needed.

Many institutions require specific account details when initiating a payment. The GET /institutions endpoint provides this information in the accountIdentifiersRequired field for each institution.

Handling account identifiers:

1. Fetch required identifiers:

   • Use the accountIdentifiersRequired array from the GET /institutions response to determine which account identifiers are needed.

2. Data transformation:
   • From GET /institutions: Identifiers are provided in SNAKE_CASE.
   • For POST /payments: Transform SNAKE_CASE identifiers to camelCase.
     • Example:

       • PSU_ID (from GET /institutions) → psuId (in POST /payments)

3. Placement in payload:
   • Place all required account identifiers within the accountIdentifiers object inside the relevant payment system object.