Skip to main content

Authorization

Follow this guide to create a new GoCardless credential that will allow Nexla to authenticate to and exchange data with your GoCardless account.
go_cardless_api_auth.png

GoCardless

Prerequisites​

GoCardless uses access token authentication for all API requests. You will need to generate an access token from your GoCardless Dashboard before configuring the credential in Nexla.

GoCardless provides two environments — Sandbox for development and testing, and Live for production. Each environment requires its own access token. It is recommended to test your integration using the Sandbox environment before switching to Live.

Create a GoCardless Account​

If you do not already have a GoCardless account, register at gocardless.com. For testing and development purposes, you can also register for a free Sandbox account at manage-sandbox.gocardless.com.

Generate an API Access Token​

  1. Log in to your GoCardless Dashboard (or your Sandbox Dashboard for testing).

  2. Click the Developers link in the left-hand navigation menu to open the Developer section.

  3. Click the Create button in the upper-right area of the Developer section, and select Access token from the menu.

  4. Enter a descriptive name for the token in the Name field (for example, "Nexla Integration").

  5. Select the appropriate permission level for the token:

    • Read-only: Allows Nexla to read data from GoCardless but not make any changes. Select this permission when using GoCardless as a data source only.

    • Read-write: Allows Nexla to both read data from and write data to GoCardless. Select this permission when using GoCardless as a destination or when creating payments, mandates, or subscriptions through Nexla.

  6. Click Create access token.

Important

Copy the access token immediately after it is generated. GoCardless displays the token only once and it cannot be retrieved after you leave the page. Store the token securely, such as in a password manager or secrets vault.

GoCardless access tokens are environment-specific. A token created in the Sandbox environment will only work with the Sandbox API (https://api-sandbox.gocardless.com), and a token created in the Live environment will only work with the Live API (https://api.gocardless.com). Ensure you generate a token in the correct environment for your use case.

For complete information about GoCardless API access tokens and authentication, refer to the GoCardless Developer Documentation.

Create a GoCardless Credential​

  • To create a new GoCardless credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Access Token​

  1. Enter the GoCardless API access token you generated in the Prerequisites section above in the Access Token field. The token authenticates all API requests that Nexla makes to your GoCardless account.

    Nexla uses the Bearer authentication scheme when passing this token to the GoCardless API. You do not need to include the word "Bearer" in the field — enter only the token value itself.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.