GoCardless API API Documentation
Select Institution for a Billing Request
POST {{url}}/billing_requests/{{billing_request}}/actions/select_institution
Creates an Institution object and attaches it to the Billing Request
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"billing_requests": {
"id": "BRQ0005Y9RXA8EN",
"created_at": "2024-03-22T21:33:00.533Z",
"status": "pending",
"mandate_request": null,
"payment_request": {
"description": "Refined Fresh Chair",
"currency": "GBP",
"amount": 79350,
"min_amount": null,
"max_amount": null,
"default_min_amount": null,
"default_max_amount": null,
"app_fee": null,
"scheme": "faster_payments",
"links": {},
"metadata": {
"postman": "payment-only-br"
},
"flexible_amount": false,
"reference": null,
"funds_settlement": "managed"
},
"metadata": {
"test": "BR861"
},
"links": {
"customer": "CU0014DR96ZN5Q",
"customer_billing_detail": "CBD000JFDY58X71",
"creditor": "CR00006C6DF0TD",
"organisation": "OR00004AE28612",
"payment_request": "PRQ0000RABQ0FAK"
},
"fallback_enabled": false,
"fallback_occurred": false,
"sign_flow_url": null,
"creditor_name": "Ondooo",
"actions": [
{
"type": "choose_currency",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed",
"available_currencies": [
"GBP",
"AUD",
"EUR"
]
},
{
"type": "collect_amount",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed"
},
{
"type": "collect_customer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"choose_currency",
"collect_amount"
],
"status": "completed",
"collect_customer_details": {
"incomplete_fields": {
"customer": [],
"customer_billing_detail": []
},
"default_country_code": "GB"
}
},
{
"type": "select_institution",
"required": true,
"completes_actions": [],
"requires_actions": [],
"status": "completed",
"institution_guess_status": "not_needed"
},
{
"type": "collect_bank_account",
"required": false,
"completes_actions": [
"choose_currency"
],
"available_country_codes": [
"GB"
],
"requires_actions": [
"collect_amount"
],
"status": "pending"
},
{
"type": "bank_authorisation",
"required": true,
"completes_actions": [],
"requires_actions": [
"select_institution"
],
"status": "pending",
"bank_authorisation": {
"authorisation_type": "payment",
"adapter": "open_banking_gateway_pis"
}
}
],
"resources": {
"customer": {
"id": "CU0014DR96ZN5Q",
"created_at": "2024-03-22T21:33:00.504Z",
"email": "jayme47@example.com",
"given_name": "Miles",
"family_name": "Morar",
"company_name": "Schowalter LLC",
"language": "en",
"phone_number": "+1 617-555-1212",
"metadata": {
"example_uuid": "1e92198b-c420-44ef-b45b-dab28f2ec4ea"
}
},
"customer_billing_detail": {
"id": "CBD000JFDY58X71",
"created_at": "2024-03-22T21:33:00.522Z",
"address_line1": "080 Dooley Springs",
"address_line2": null,
"address_line3": null,
"city": "East Addieville",
"region": null,
"postal_code": "E8 3GX",
"country_code": "GB",
"swedish_identity_number": null,
"danish_identity_number": null
},
"institution": {
"id": "read_refund_account_sandbox_bank",
"name": "Read Refund Account Bank - Automatically authorises the payment request, and returns payment with payer account details",
"icon_url": "https://storage.googleapis.com/gc-prd-institution_icons-production/consent_authorised_sandbox_bank",
"country_code": "GB",
"roles": [
"institutions_list",
"read_refund_account"
],
"bank_redirect": true
}
},
"experimentation": {
"is_eligible_for_share_of_wallet_experiments": false,
"is_eligible_for_optional_vm_experiments": false,
"is_eligible_for_institution_experiments": false,
"is_eligible_for_ach_optional_address_experiments": false,
"is_eligible_for_ach_mx_experiments": false,
"is_eligible_for_single_tab_experiments": false,
"is_eligible_for_bankid_safe_start_experiments": false
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_requests/https://api-sandbox.gocardless.com/actions/select_institution' -d '{"data":{"institution":"institution","country_code":"GB"}}'
ENDPOINTS