GoCardless

This page provides an overview of the payments methods provided by the GoCardless adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating GoCardless within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods

Payment Method	Transaction Flows	Transaction Types
BankTransfer	Full-Page Redirect, Server-To-Server	Debit, Register, Deregister, Refund

Mandatory Parameters for Debit with Register

Name	Type	Required	Description
description	string	true	A human-readable description of the payment. This will be displayed to the payer when authorising the billing request.

Additional Parameters for Debit, Register

note

The required bank details depend on the configured scheme. The requirements can be found here.

Name	Type	Required	Description
extraData.charge_date	string	false	A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. If the value is before the mandate’s next_possible_charge_date creation will fail. If the value is not a working day it will be rolled forwards to the next available one.
reference	string	false	An optional reference that will appear on your customer’s bank statement. The character limit for this reference is dependent on the scheme.
customer.company	string	false	Customer’s company name. Required unless a given_name and family_name are provided. For Canadian customers, the use of a company_name value will mean that any mandate created from this customer will be considered to be a "Business PAD" (otherwise, any mandate will be considered to be a "Personal PAD").
customer.company	string	false	Customer’s company name. Required unless a given_name and family_name are provided. For Canadian customers, the use of a company_name value will mean that any mandate created from this customer will be considered to be a "Business PAD" (otherwise, any mandate will be considered to be a "Personal PAD").
customer.firstName	string	false	Customer’s surname. Required unless a company_name is provided.
customer.lastName	string	false	Customer’s first name. Required unless a company_name is provided.
customer.billingPhone	string	false	ITU E.123 formatted phone number, including country code.
customer.billingAddress1	string	false	The first line of the customer’s address.
customer.billingAddress2	string	false	The second line of the customer’s address.
extraData.address_line3	string	false	The third line of the customer’s address.
customer.email	string	false	Customer’s email address. Required in most cases, as this allows GoCardless to send notifications to this customer.
customer.billingCity	string	false	The city of the customer’s address.
customer.billingCountry	string	false	ISO 3166-1 alpha-2 code.
customer.billingState	string	false	The customer’s address region, county or department. For US customers a 2 letter ISO3166-2:US state code is required (e.g. CA for California).
customer.billingPostcode	string	false	The customer’s postal code.
extraData.lang	string	false	ISO 639-1 code. Used as the language for notification emails sent by GoCardless. Currently only "en", "fr", "de", "pt", "es", "it", "nl", "da", "nb", "sl", "sv" are supported. If this is not provided, the language will be chosen based on the country_code (if supplied) or default to "en"
customer.paymentData.ibanData.iban	string	false	International Bank Account Number. Alternatively you can provide local details. IBANs are not accepted for Swedish bank accounts denominated in SEK - you must supply local details.
extraData.danish_identity_number	string	false	For Danish customers only. The civic/company number (CPR or CVR) of the customer. Must be supplied if the customer’s bank account is denominated in Danish krone (DKK).
extraData.swedish_identity_number	string	false	For Swedish customers only. The civic/company number (personnummer, samordningsnummer, or organisationsnummer) of the customer. Must be supplied if the customer’s bank account is denominated in Swedish krona (SEK). This field cannot be changed once it has been set.
extraData.account_number	string	false	Bank account number. Alternatively you can provide an iban.
extraData.account_number_suffix	string	false	Account number suffix (only for bank accounts denominated in NZD).
extraData.account_type	string	false	Bank account type. Required for USD-denominated bank accounts. Must not be provided for bank accounts in other currencies.
extraData.bank_code	string	false	Bank code. Alternatively you can provide an iban
extraData.branch_code	string	false	Branch code. Alternatively you can provide an iban.
extraData.lock_customer_details	string	false	If true, the payer will not be able to edit their customer details within the flow. Default is false.
extraData.lock_bank_account	string	false	If true, the payer will not be able to change their bank account within the flow. Default is false.

Additional Parameters for Refund

Name	Type	Required	Description
reference	string	false	An optional reference that will appear on your customer’s bank statement. The character limit for this reference is dependent on the scheme.