Connectors

Finance, Billing & Payments

GoCardless

Bank payments: mandates, payments, subscriptions, instalment schedules, and billing requests

Signs in with: API token
Runs on: Cloud or On-Prem Worker
Operations: 138
Ready-made triggers: 7

Connect GoCardless

In Neblex open Connect › Connections and click New Connection.
Search for GoCardless and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
EnvironmentRequired	Live uses api.gocardless.com; Sandbox uses api-sandbox.gocardless.com.
Access tokenRequiredSecret	A GoCardless access token (read-only or read-write) for the selected environment.

Triggers

Start a flow when something changes in GoCardless: add a Poll for changes trigger, choose GoCardless and pick the event.

Event	What it does	How
Customer created	Fires for each customer created since the last check.	Checks for changes by `created_at`
Event created	Fires for each GoCardless event (payment, mandate, payout, subscription and other resource changes) since the last check.	Checks for changes by `created_at`
Mandate created	Fires for each mandate created since the last check.	Checks for changes by `created_at`
Payment created	Fires for each payment created since the last check.	Checks for changes by `created_at`
Payout created	Fires for each payout created since the last check.	Checks for changes by `created_at`
Refund created	Fires for each refund created since the last check.	Checks for changes by `created_at`
Subscription created	Fires for each subscription created since the last check.	Checks for changes by `created_at`

Use it in a flow

Open a flow, open the node library and search for GoCardless.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

Operations

138 operations in 46 groups. Each one is a step you can add to a flow.

Balance1

List balanceslistBalances GET Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of balances for a given creditor.

Bank account detail1

Get bank account detailgetBankAccountDetail GET Returns bank account details in the flattened JSON Web Encryption format described in RFC 7516.

Bank account holder verification2

Create bank account holder verification`createBankAccountHolderVerification`	POST	Verify the account holder of the bank account.
Get bank account holder verification`getBankAccountHolderVerification`	GET	Fetches a bank account holder verification by ID.

Bank authorisation2

Create bank authorisation`createBankAuthorisation`	POST	Create a Bank Authorisation.
Get bank authorisation`getBankAuthorisation`	GET	Get a single bank authorisation.

Bank details lookup1

Create bank details lookupcreateBankDetailsLookup POST Performs a bank details lookup.

Billing request12

Cancel billing request`cancelBillingRequest`	POST	Immediately cancels a billing request, causing all billing request flows to expire.
Choose currency billing request`chooseCurrencyBillingRequest`	POST	This will allow for the updating of the currency and subsequently the scheme if needed for a Billing Request.
Collect bank account billing request`collectBankAccountBillingRequest`	POST	If the billing request has a pending collect bank account action, this endpoint can be used to collect the details in order to complete it.
Collect customer details billing request`collectCustomerDetailsBillingRequest`	POST	If the billing request has a pending collect customer details action, this endpoint can be used to collect the details in order to complete it.
Confirm payer details billing request`confirmPayerDetailsBillingRequest`	POST	This is needed when you have a mandate request.
Create billing request`createBillingRequest`	POST	Important: All properties associated with subscription request and instalment schedule request are only supported for ACH and PAD schemes.
Fallback billing request`fallbackBillingRequest`	POST	Triggers a fallback from the open-banking flow to direct debit.
Fulfil billing request`fulfilBillingRequest`	POST	If a billing request is ready to be fulfilled, call this endpoint to cause it to fulfil, executing the payment.
Get billing request`getBillingRequest`	GET	Fetches a billing request
List billing requests`listBillingRequests`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your billing requests.
Notify billing request`notifyBillingRequest`	POST	Notifies the customer linked to the billing request, asking them to authorise it.
Select institution billing request`selectInstitutionBillingRequest`	POST	Creates an Institution object and attaches it to the Billing Request

Billing request flow2

Create billing request flow`createBillingRequestFlow`	POST	Creates a new billing request flow.
Initialise billing request flow`initialiseBillingRequestFlow`	POST	Returns the flow having generated a fresh session token which can be used to power integrations that manipulate the flow.

Billing request template4

Create billing request template`createBillingRequestTemplate`	POST	Create billing request template
Get billing request template`getBillingRequestTemplate`	GET	Fetches a Billing Request Template
List billing request templates`listBillingRequestTemplates`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your Billing Request Templates.
Update billing request template`updateBillingRequestTemplate`	PUT	Updates a Billing Request Template, which will affect all future Billing Requests created by this template.

Billing request with action1

Create billing request with actionscreateWithActionsBillingRequestWithAction POST Creates a billing request and completes any specified actions in a single request.

Block6

Block by ref`blockByRefBlock`	POST	Creates new blocks for a given reference.
Create block`createBlock`	POST	Creates a new Block of a given type.
Disable block`disableBlock`	POST	Disables a block so that it no longer will prevent mandate creation.
Enable block`enableBlock`	POST	Enables a previously disabled block so that it will prevent mandate creation
Get block`getBlock`	GET	Retrieves the details of an existing block.
List blocks`listBlocks`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your blocks.

Creditor4

Create creditor`createCreditor`	POST	Creates a new creditor.
Get creditor`getCreditor`	GET	Retrieves the details of an existing creditor.
List creditors`listCreditors`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your creditors.
Update creditor`updateCreditor`	PUT	Updates a creditor object.

Creditor bank account4

Create creditor bank account`createCreditorBankAccount`	POST	Creates a new creditor bank account object.
Disable creditor bank account`disableCreditorBankAccount`	POST	Immediately disables the bank account, no money can be paid out to a disabled account.
Get creditor bank account`getCreditorBankAccount`	GET	Retrieves the details of an existing creditor bank account.
List creditor bank accounts`listCreditorBankAccounts`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your creditor bank accounts.

Currency exchange rate1

List currency exchange rateslistCurrencyExchangeRates GET Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of all exchange rates.

Customer5

Create customer`createCustomer`	POST	Creates a new customer object.
Get customer`getCustomer`	GET	Retrieves the details of an existing customer.
List customers`listCustomers`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your customers.
Remove customer`removeCustomer`	DELETE	Removed customers will not appear in search results or lists of customers (in our API or exports), and it will not be possible to load an individually removed customer by ID.
Update customer`updateCustomer`	PUT	Updates a customer object.

Customer bank account5

Create customer bank account`createCustomerBankAccount`	POST	Creates a new customer bank account object.
Disable customer bank account`disableCustomerBankAccount`	POST	Immediately cancels all associated mandates and cancellable payments.
Get customer bank account`getCustomerBankAccount`	GET	Retrieves the details of an existing bank account.
List customer bank accounts`listCustomerBankAccounts`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your bank accounts.
Update customer bank account`updateCustomerBankAccount`	PUT	Updates a customer bank account object.

Customer notification1

Handle customer notificationhandleCustomerNotification POST "Handling" a notification means that you have sent the notification yourself (and don't want GoCardless to send it).

Event2

Get event`getEvent`	GET	Retrieves the details of a single event.
List events`listEvents`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your events.

Export2

Get export`getExport`	GET	Returns a single export.
List exports`listExports`	GET	Returns a list of exports which are available for download.

Funds availability1

Check funds availabilitycheckFundsAvailability GET Checks if the payer's current balance is sufficient to cover the amount the merchant wants to charge within the consent parameters defined on the mandate.

Instalment schedule6

Cancel instalment schedule`cancelInstalmentSchedule`	POST	Immediately cancels an instalment schedule; no further payments will be collected for it.
Create instalment schedule with dates`createWithDatesInstalmentSchedule`	POST	Creates a new instalment schedule object, along with the associated payments.
Create instalment schedule with schedule`createWithScheduleInstalmentSchedule`	POST	Creates a new instalment schedule object, along with the associated payments.
Get instalment schedule`getInstalmentSchedule`	GET	Retrieves the details of an existing instalment schedule.
List instalment schedules`listInstalmentSchedules`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your instalment schedules.
Update instalment schedule`updateInstalmentSchedule`	PUT	Updates an instalment schedule.

Institution2

List institution for billing request`listForBillingRequestInstitution`	GET	Returns all institutions valid for a Billing Request.
List institutions`listInstitutions`	GET	Returns a list of supported institutions.

Logo1

Create logo for creditorcreateForCreditorLogo POST Creates a new logo associated with a creditor.

Mandate6

Cancel mandate`cancelMandate`	POST	Immediately cancels a mandate and all associated cancellable payments.
Create mandate`createMandate`	POST	Creates a new mandate object.
Get mandate`getMandate`	GET	Retrieves the details of an existing mandate.
List mandates`listMandates`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your mandates.
Reinstate mandate`reinstateMandate`	POST	Reinstates a cancelled or expired mandate to the banks.
Update mandate`updateMandate`	PUT	Updates a mandate object.

Mandate import4

Cancel mandate import`cancelMandateImport`	POST	Cancels the mandate import, which aborts the import process and stops the mandates being set up in GoCardless.
Create mandate import`createMandateImport`	POST	Mandate imports are first created, before mandates are added one-at-a-time, so this endpoint merely signals the start of the import process.
Get mandate import`getMandateImport`	GET	Returns a single mandate import.
Submit mandate import`submitMandateImport`	POST	Submits the mandate import, which allows it to be processed by a member of the GoCardless team.

Mandate import entry2

Create mandate import entry`createMandateImportEntry`	POST	For an existing mandate import (https://developer.gocardless.com/api-reference/ core-endpoints-mandate-imports), this endpoint can be used to add individual mandates to be imported into...
List mandate import entries`listMandateImportEntries`	GET	For an existing mandate import, this endpoint lists all of the entries attached.

Mandate pdf1

Create mandate pdfcreateMandatePdf POST Generates a PDF mandate and returns its temporary URL.

Negative balance limit1

List negative balance limitslistNegativeBalanceLimits GET Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of negative balance limits.

Outbound payment8

Approve outbound payment`approveOutboundPayment`	POST	Approves an outbound payment.
Cancel outbound payment`cancelOutboundPayment`	POST	Cancels an outbound payment.
Create outbound payment`createOutboundPayment`	POST	Create outbound payment
Get outbound payment`getOutboundPayment`	GET	Fetches an outbound payment by ID
List outbound payments`listOutboundPayments`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of outbound payments.
Stats outbound payment`statsOutboundPayment`	GET	Retrieve aggregate statistics on outbound payments.
Update outbound payment`updateOutboundPayment`	PUT	Updates an outbound payment object.
Withdraw outbound payment`withdrawOutboundPayment`	POST	Creates an outbound payment to your verified business bank account as the recipient.

Outbound payment import3

Create outbound payment import`createOutboundPaymentImport`	POST	Create outbound payment import
Get outbound payment import`getOutboundPaymentImport`	GET	Returns a single outbound payment import.
List outbound payment imports`listOutboundPaymentImports`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your outbound payment imports.

Outbound payment import entry1

List outbound payment import entrieslistOutboundPaymentImportEntries GET Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of the entries for a given outbound payment import.

Payer authorisation5

Confirm payer authorisation`confirmPayerAuthorisation`	POST	Confirms the Payer Authorisation, indicating that the resources are ready to be created.
Create payer authorisation`createPayerAuthorisation`	POST	Creates a Payer Authorisation.
Get payer authorisation`getPayerAuthorisation`	GET	Retrieves the details of a single existing Payer Authorisation.
Submit payer authorisation`submitPayerAuthorisation`	POST	Submits all the data previously pushed to this PayerAuthorisation for verification.
Update payer authorisation`updatePayerAuthorisation`	PUT	Updates a Payer Authorisation.

Payer theme1

Create payer theme for creditorcreateForCreditorPayerTheme POST Creates a new payer theme associated with a creditor.

Payment6

Cancel payment`cancelPayment`	POST	Cancels the payment if it has not already been submitted to the banks.
Create payment`createPayment`	POST	Creates a new payment object.
Get payment`getPayment`	GET	Retrieves the details of a single existing payment.
List payments`listPayments`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your payments.
Retry payment`retryPayment`	POST	Retries a failed payment if the underlying mandate is active.
Update payment`updatePayment`	PUT	Updates a payment object.

Payment account2

Get payment account`getPaymentAccount`	GET	Retrieves the details of an existing payment account.
List payment accounts`listPaymentAccounts`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your payment accounts.

Payment account transaction2

Get payment account transaction`getPaymentAccountTransaction`	GET	Retrieves the details of an existing payment account transaction.
List payment account transactions`listPaymentAccountTransactions`	GET	List transactions for a given payment account.

Payout3

Get payout`getPayout`	GET	Retrieves the details of a single payout.
List payouts`listPayouts`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your payouts.
Update payout`updatePayout`	PUT	Updates a payout object.

Payout item1

List payout itemslistPayoutItems GET Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of items in the payout.

Redirect flow3

Complete redirect flow`completeRedirectFlow`	POST	This creates a customer (https://developer.gocardless.com/api-reference/ core-endpoints-customers), customer bank account (https://developer.gocardless.com/api-reference/...
Create redirect flow`createRedirectFlow`	POST	Creates a redirect flow object which can then be used to redirect your customer to the GoCardless hosted payment pages.
Get redirect flow`getRedirectFlow`	GET	Returns all details about a single redirect flow

Refund4

Create refund`createRefund`	POST	Creates a new refund object.
Get refund`getRefund`	GET	Retrieves all details for a single refund
List refunds`listRefunds`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your refunds.
Update refund`updateRefund`	PUT	Updates a refund object.

Scenario simulator1

Run scenario simulatorrunScenarioSimulator POST Runs the specific scenario simulator against the specific resource

Scheme identifier3

Create scheme identifier`createSchemeIdentifier`	POST	Creates a new scheme identifier.
Get scheme identifier`getSchemeIdentifier`	GET	Retrieves the details of an existing scheme identifier.
List scheme identifiers`listSchemeIdentifiers`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your scheme identifiers.

Subscription7

Cancel subscription`cancelSubscription`	POST	Immediately cancels a subscription; no more payments will be created under it.
Create subscription`createSubscription`	POST	Creates a new subscription object
Get subscription`getSubscription`	GET	Retrieves the details of a single subscription.
List subscriptions`listSubscriptions`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your subscriptions.
Pause subscription`pauseSubscription`	POST	Pause a subscription object.
Resume subscription`resumeSubscription`	POST	Resume a subscription object.
Update subscription`updateSubscription`	PUT	Updates a subscription object.

Tax rate2

Get tax rate`getTaxRate`	GET	Retrieves the details of a tax rate.
List tax rates`listTaxRates`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of all tax rates.

Transferred mandate1

Transferred mandatestransferredMandatesTransferredMandate GET Returns new customer bank details for a mandate that's been recently transferred

Verification detail2

Create verification detail`createVerificationDetail`	POST	Creates a new verification detail
List verification details`listVerificationDetails`	GET	Returns a list of verification details belonging to a creditor.

Webhook3

Get webhook`getWebhook`	GET	Retrieves the details of an existing webhook.
List webhooks`listWebhooks`	GET	Returns a cursor-paginated (https://developer.gocardless.com/api-reference/ api-usage-cursor-pagination) list of your webhooks.
Retry webhook`retryWebhook`	POST	Requests for a previous webhook to be sent again