Below is each endpoint that will need to be considered when adding an additional scheme. When building your initial integration with GoCardless, certain items like those listed below may have been hardcoded. These will need to be changed to variable values that can change to support additional schemes.
ACTION | PROPERTY / PARAMETER | AVAILABLE RESOURCES |
---|---|---|
Create a Creditor Bank Account | Properties | 'country_code' ; 'currency' |
Parameters | 'iban' or 'account_number' + 'bank_code' + 'branch_code' | |
Update a Customer | Properties | 'address' (Bacs only) ; 'country_code' ; 'currency' ; 'language' |
Parameters | 'country_code' ; 'language' | |
Where applicable... | 'danish_identity_number' / 'swedish_identity_number' | |
Create a Payment | Properties | 'currency' |
Parameters | 'currency' | |
Create a Redirect Flow | Properties | 'scheme' |
Parameters | 'prefilled_customer' ['language'] | |
Where applicable... | 'danish_identity_number' / 'swedish_identity_number' | |
Create a Subscription | Properties | 'currency' |
Parameters | 'currency' | |
Create a refund | Properties | 'currency' |
Perform a Bank Details Lookup | Properties | 'available_debit_schemes' ; 'currency' |
Parameters | 'iban' or 'account_number' + 'bank_code' + 'branch_code' | |
Create a mandate PDF | Properties | 'country_code' ; 'scheme' ; 'iban' or 'account_number' + 'bank_code' + 'branch_code' |
Where applicable... | 'danish_identity_number' / 'swedish_identity_number' |
GoCardless PRO Accounts ONLY
ACTION | PROPERTY / PARAMETER | AVAILABLE RESOURCES |
---|---|---|
Create a Customer | Properties | 'address' (Bacs only) ; 'country_code' ; 'currency' ; 'language' |
Parameters | 'bank_code' or 'iban' | |
Where applicable... | 'danish_identity_number' / 'swedish_identity_number' 'region' (ACH only) |
|
Create a Customer Bank Account | Properties | 'country_code' ; 'currency' |
Parameters | 'country_code' ; 'currency' ; 'iban' or 'account_number' + 'bank_code' + 'branch_code' | |
Where applicable... | 'account_type' (ACH only) | |
Create a Mandate | Properties | 'scheme' |
Parameters | 'scheme' | |
Where applicable... | 'payer_ip_address' (ACH only) |