GoCardlessDeveloper Docs
Create a sandbox account

Adding a Creditor Bank Account#

View as Markdown

In this step of the GoCardless Embed guide you will create a creditor bank account for the creditor you created in the previous step.

The creditor bank account is where GoCardless will settle the funds we collect from the creditor's payers. This bank account must be controlled by you and notbe the merchant's bank account. GoCardless will only pay out once we have verified you control the bank account. You should add a creditor bank account for each currency you collect so GoCardless can pay out in that currency.

POST /creditor_bank_accounts#

You can create a creditor bank account by performing a POST request to the /creditor_bank_accounts endpoint.

The required parameters depend on the country. For a French bank account they are:

ParameterDescription
country_codeThe country that the bank account is registered in, as a ISO 3166-1 alpha-2 code.
currencyISO 4217 currency code. Currently EUR, GBP, and USD are supported for the GoCardless Embed product.
account_holder_nameName of the account holder, as known by the bank. This must be an account owned by you and notthe merchant.
ibanInternational Bank Account Number. Alternatively you can provide local details.
links[creditor]The ID of the creditor whose payments should be paid out to this account.

Examples of how to make this request using the GoCardless client libraries:

POST https://api.gocardless.com/creditor_bank_accounts HTTP/1.1
Content-Type: application/json
{
"creditor_bank_accounts": {
  "account_number": "55779911",
  "branch_code": "200000",
  "country_code": "GB",
  "account_holder_name": "Nude Wines",
  "links": {
    "creditor": "CR123"
  }
}
}

HTTP/1.1 201 Created
Location: /creditor_bank_accounts/BA123
Content-Type: application/json
{
"creditor_bank_accounts": {
"id": "BA123",
"created_at": "2014-05-27T12:43:17.000Z",
"account_holder_name": "Nude Wines",
"account_number_ending": "11",
"account_type": null,
"country_code": "GB",
"currency": "GBP",
"bank_name": "BARCLAYS BANK PLC",
"enabled": true,
"verification_status": "pending",
"links": {
"creditor": "CR123"
}
}
}
$client->creditorBankAccounts()->create([
"params" => [
"account_number" => "55779911",
"branch_code" => "200000",
"country_code" => "GB",
"account_holder_name" => "Nude Wines",
"links" => [
"creditor" => "CR123"
]
]
]);
client.creditor_bank_accounts.create(params={
"account_number": "55779911",
"branch_code": "200000",
"country_code": "GB",
"account_holder_name": "Nude Wines",
"links": {
"creditor": "CR123"
}
})
@client.creditor_bank_accounts.create(
params: {
account_holder_name: "Example Ltd",
account_number: "55779911",
branch_code: "200000",
country_code: "GB",
links: {
creditor: "CR123"
}
}
)
CreditorBankAccount creditorBankAccount = client.creditorBankAccounts().create()
.withAccountNumber("55779911")
.withBranchCode("200000")
.withCountryCode("GB")
.withAccountHolderName("Nude Wines")
.withLinksCreditor("CR123")
.execute();
const creditorBankAccount = await client.creditorBankAccounts.create({
account_number: "55779911",
branch_code: "200000",
country_code: "GB",
account_holder_name: "Nude Wines",
links: {
creditor: "CR123",
},
});
var creditorBankAccountRequest = new GoCardless.Services.CreditorBankAccountCreateRequest()
{
AccountHolderName = "Example Ltd",
AccountNumber = "55779911",
BranchCode = "200000",
CountryCode = "GB",
SetAsDefaultPayoutAccount = true,
Links = new GoCardless.Services.CreditorBankAccountCreateRequest.CreditorBankAccountLinks()
{
Creditor = "CR0123"
}
};

var creditorBankAccountResponse = await gocardless.CreditorBankAccounts.CreateAsync(creditorBankAccountRequest);
GoCardless.Resources.CreditorBankAccount creditorBankAccount = creditorBankAccountResponse.CreditorBankAccount;
package main

import (
gocardless "github.com/gocardless/gocardless-pro-go/v6"
)

accessToken := "your_access_token_here"
config, err := gocardless.NewConfig(accessToken, gocardless.WithEndpoint(gocardless.SandboxEndpoint))
if err != nil {
fmt.Printf("got err in initialising config: %s", err.Error())
return
}
client, err := gocardless.New(config)
if err != nil {
fmt.Println("error in initialisating client: %s", err.Error())
return
}

creditorBankAccountCreateParams := gocardless.CreditorBankAccountCreateParams{
AccountNumber: "55779911",
BranchCode: "200000",
CountryCode: "GB",
AccountHolderName: "Nude Wines",
}

creditorBankAccount, err := client.CreditorBankAccounts.Create(context, creditorBankAccountCreateParams)
curl --silent \
-H "Content-Type: application/json" \
-H "Gocardless-Version: 2015-07-06" \
-H "Authorization: Bearer ${API_ACCESS_TOKEN}" \
"https://api.gocardless.com/creditor_bank_accounts" \
-d @- << EOF
{
"creditor_bank_accounts": {
"account_number": "55779911",
"branch_code": "200000",
"country_code": "GB",
"account_holder_name": "Nude Wines",
"links": {
"creditor": "CR123"
}
}
}
EOF

For more details, see the API reference docs for creating creditor bank accounts.

Verify your bank account#

Once you have added a creditor bank account, you will see that the bank account verification_status will be in pending state. You will receive an email with details about how to verify your bank account which requires you to make a verification payment to us. You must verify your bank account in order to start receiving payouts.

Once you have submitted the verification payment, you can check on the verification progress via the GET /creditor_bank_accounts/BA123 API.

The verification_status will move to in_review state while we verify your account. Once your bank account has been verified, the verification_status will be in successful state and you will be able to start receiving payouts to that bank account.

What's next?#

Setting a Scheme Identifier

Request a custom scheme identifier so your merchant's name appears on payers' bank statements.

Learn more
Setting Up Mandates & Payments

Use Billing Requests to set up Direct Debit mandates and collect payments.

Learn more
SupportDashboard