GoCardless API API Documentation
Change Currency for a Billing Request
POST {{url}}/billing_requests/{{billing_request}}/actions/choose_currency
This will allow for the updating of the currency and subsequently the scheme if needed for a billing request this will only be available for mandate only flows, it will not support payments requests or plans
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"billing_requests": {
"id": "BRQ0005Y9RVW41R",
"created_at": "2024-03-22T21:32:00.532Z",
"status": "pending",
"mandate_request": {
"currency": "EUR",
"constraints": null,
"scheme": "sepa_core",
"sweeping": false,
"verify": "recommended",
"links": {},
"metadata": {
"postman": "mandate-only-br"
},
"description": null,
"payer_requested_dual_signature": false
},
"payment_request": null,
"metadata": {
"test": "BR893"
},
"links": {
"customer": "CU0014DR8VS2MD",
"customer_billing_detail": "CBD000JFDY236F5",
"creditor": "CR00006C6DF0TD",
"organisation": "OR00004AE28612",
"mandate_request": "MRQ0005F4V4KFA6"
},
"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": [
"USD",
"SEK",
"GBP",
"AUD",
"NZD",
"DKK",
"CAD",
"EUR"
]
},
{
"type": "collect_customer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"choose_currency"
],
"status": "pending",
"collect_customer_details": {
"incomplete_fields": {
"customer": [
"given_name",
"family_name"
],
"customer_billing_detail": [
"address_line1",
"city",
"postal_code",
"country_code"
]
},
"default_country_code": null
}
},
{
"type": "collect_bank_account",
"required": true,
"completes_actions": [
"choose_currency"
],
"available_country_codes": [
"AT",
"BE",
"CY",
"EE",
"FI",
"FR",
"DE",
"GR",
"IE",
"IT",
"LV",
"LT",
"LU",
"MT",
"NL",
"PT",
"SK",
"SI",
"ES",
"GF",
"GP",
"MQ",
"YT",
"RE",
"BL",
"MF",
"PM",
"AX",
"MC",
"SM",
"BG",
"HR",
"CZ",
"DK",
"GI",
"GG",
"HU",
"IS",
"IM",
"JE",
"LI",
"NO",
"PL",
"RO",
"SE",
"CH",
"GB"
],
"requires_actions": [],
"status": "pending"
},
{
"type": "confirm_payer_details",
"required": true,
"completes_actions": [],
"requires_actions": [
"collect_customer_details",
"collect_bank_account"
],
"status": "pending"
},
{
"type": "bank_authorisation",
"required": false,
"completes_actions": [
"collect_bank_account"
],
"requires_actions": [
"select_institution"
],
"status": "pending",
"bank_authorisation": {
"authorisation_type": "mandate",
"adapter": "open_banking_gateway_ais",
"supported_sepa_country_codes": [
"DE",
"FR",
"IE"
]
}
}
],
"resources": {
"customer": {
"id": "CU0014DR8VS2MD",
"created_at": "2024-03-22T21:32:00.520Z",
"email": null,
"given_name": null,
"family_name": null,
"company_name": null,
"language": "en",
"phone_number": null,
"metadata": {}
},
"customer_billing_detail": {
"id": "CBD000JFDY236F5",
"created_at": "2024-03-22T21:32:00.528Z",
"address_line1": null,
"address_line2": null,
"address_line3": null,
"city": null,
"region": null,
"postal_code": null,
"country_code": null,
"swedish_identity_number": null,
"danish_identity_number": null
}
},
"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/choose_currency' -d '{"data":{"currency":"EUR","metadata":{"test":"BR123"}}}'
ENDPOINTS