Onboarding your users#

<?php
require 'vendor/autoload.php';

$client = new \GoCardlessPro\Client([
'access_token' => $currentUser->gocardlessAccessToken,
'environment' => \GoCardlessPro\Environment::SANDBOX
]);

// The Creditors API returns a list of creditors, but any GoCardless account connected
// to your application will have a single creditor, so you can just look at the first one
$creditor = $client->creditors()->list()->records[0];

// We'll see below how to redirect users to the onboarding flow, and how it works
if ($creditor->verification_status == "action_required") {
redirectToOnboardingFlow();
}

import gocardless_pro

client = gocardless_pro.Client(
access_token=current_user.gocardless_access_token,
environment='sandbox'
)

# The Creditors API returns a list of creditors, but any GoCardless account connected

# to your application will have a single creditor, so you can just look at the first one

creditor = client.creditors.list().records[0];

# We'll see below how to redirect users to the onboarding flow, and how it works

if creditor.verification_status == "action_required":
redirect_to_onboarding_flow()

require 'gocardless_pro'

client = GoCardlessPro::Client.new(
access_token: current_user.gocardless_access_token,
environment: :sandbox
)

# The Creditors API returns a list of creditors, but any GoCardless account connected

# to your application will have a single creditor, so you can just look at the first one

creditor = client.creditors.list.records.first

# We'll see below how to redirect users to the onboarding flow, and how it works

redirect_to_onboarding_flow if creditor.verification_status == "action_required"

package com.gcintegration;

import com.gocardless.GoCardlessClient;
import com.gocardless.resources.Creditor;

import static com.gocardless.resources.Creditor.VerificationStatus.ACTION_REQUIRED;

GoCardlessClient client = GoCardlessClient
.newBuilder(CurrentUser.gocardlessAccessToken)
.withEnvironment(GoCardlessClient.Environment.SANDBOX)
.build();

// The Creditors API returns a list of creditors, but any GoCardless account connected
// to your application will have a single creditor, so you can just look at the first one
Creditor creditor = client.creditors().list().execute().getItems().get(0);

// We'll see below how to redirect users to the onboarding flow, and how it works
if (creditor.getVerificationStatus() == ACTION_REQUIRED) {
redirectToOnboardingFlow();
}

const client = gocardless(
// We recommend storing your access token in an environment
// variable for security
process.env.GoCardlessAccessToken,
// Change me to constants.Environments.Live when you're ready to go live
constants.Environments.Sandbox,
);

const creditors = gocardless.creditors.list({ limit: 1 });

// The Creditors API returns a list of creditors, but any GoCardless account connected
// to your application will have a single creditor, so you can just look at the first one
const creditor = creditors.creditors[0];

if (creditor.verification_status === "action_required") {
// We'll see below how to redirect users to the onboarding flow, and how it works
redirectUserToOnboardingFlow();
}

GoCardlessClient client = GoCardlessClient.Create(
// We recommend storing your access token in an
// configuration setting for security
ConfigurationManager.AppSettings["GoCardlessAccessToken"],
// Change me to LIVE when you're ready to go live
GoCardlessClient.Environment.SANDBOX
);

var creditorListResponse = await gocardless.Creditors.ListAsync(
new GoCardless.Services.CreditorListRequest() { Limit = 1 }
);

// The Creditors API returns a list of creditors, but any GoCardless account connected
// to your application will have a single creditor, so you can just look at the first one
GoCardless.Resources.Creditor creditor = creditorListResponse.Creditors[0];

if (creditor.VerificationStatus == CreditorVerificationStatus.ActionRequired)
{
// We'll see below how to redirect users to the onboarding flow, and how it works
RedirectUserToOnboardingFlow();
}

package main

import (
"context"
"fmt"

  gocardless "github.com/gocardless/gocardless-pro-go/v6"

)

func main() {
accessToken := "your_access_token_here"
opts := gocardless.WithEndpoint(gocardless.SandboxEndpoint)
client, err := gocardless.New(accessToken, opts)
if err != nil {
fmt.Println("error in initialisating client: %s", err.Err())
return
}

  creditorListParams := gocardless.CreditorListParams{}
  creditorListParams.Limit = 1

  ctx := context.TODO()
  creditors, err := client.Creditors.List(ctx, creditorListParams)
  if err != nil {
  	fmt.Printf("error in fetching creditors: %s", err.Error())
  }

  // The Creditors API returns a list of creditors, but any GoCardless account connected
  // to your application will have a single creditor, so you can just look at the first one
  creditor := creditors[0]

  if creditor.VerficationStatus == "action_required" {
  	// We'll see below how to redirect users to the onboarding flow, and how it works
  	redirectUserToOnboardingFlow()
  }

}