List Institutions for Billing Request
GET {{url}}/billing_requests/{{billing_request}}/institutions?country_code=GB
Returns all institutions valid for a Billing Request.
This endpoint is currently supported only for FasterPayments.
List Insitutions for a Billing Request API Docs
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
country_code | string | required ISO 3166-1 alpha-2 code. The country code of the institution. | |
ids | null | ID(s) of the institution(s) to retrieve. More than one ID can be specified using a comma-separated string. | |
search | null | A search substring for retrieving institution(s), based on the institution’s name. |
RESPONSES
status: OK
{"institutions":[{"id":"payment_consent_unknown_sandbox_unavailable_bank","name":"Bank Down - Consent unknown as Bank is temporarily unavailable","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-staging/consent_rejected_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-staging/consent_rejected_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":false},{"id":"payment_failed_sandbox_bank","name":"Payment Failed Bank - Automatically authorises the payment request, but later fails the payment","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/payment_failed_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/payment_failed_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":false},{"id":"payment_failed_read_refund_account_sandbox_bank","name":"Payment Failed Read Refund Account Bank - Automatically authorises the payment request, but later fails the payment","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/payment_failed_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/payment_failed_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":true},{"id":"read_refund_account_sandbox_bank","name":"Read Refund Account Bank - Automatically authorises the payment request, and returns payment with payer account details","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_authorised_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_authorised_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":true},{"id":"consent_rejected_sandbox_bank","name":"Reject Bank - Automatically rejects the payment request","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_rejected_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_rejected_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":false},{"id":"consent_authorised_sandbox_bank","name":"Success Bank - Automatically authorises the payment request","logo_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_authorised_sandbox_bank","icon_url":"https://storage.googleapis.com/gc-prd-institution_icons-production/consent_authorised_sandbox_bank","country_code":"GB","autocompletes_collect_bank_account":false}]}