Available GoCardless APis

Tanisha Ray

Updated April 17, 2025 10:46

When you configure an export, import, or other type of flow step using the prebuilt GoCardless connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the GoCardless API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Blocks	Get a single block	X
	List multiple blocks	X
	Create a block		X
	Disable a block		X
	Enable a block		X
	Create blocks by reference		X
Creditor bank accounts	List creditor bank accounts	X
	Get a single-creditor bank account	X
	Create a creditor bank account		X
	Disable a creditor bank account		X
Creditors	List creditors	X
	Get a single creditor	X
	Create a creditor		X
	Update a creditor		X
Currency exchange rates	List exchange rates	X
Customer bank accounts	List customer bank accounts	X
	Get a single-customer bank account	X
	Create a customer bank account		X
	Update a customer bank account		X
	Disable customer bank account		X
Customer notifications	Handle customer notification		X
Customers	List customers	X
	Get a single customer	X
	Create a customer		X
	Update a customer		X
	Remove a customer		X
Events	List events	X
	Get a single event	X
	Reconciling payouts with events	X
Exports	Get a single export	X
Exports	List exports	X
Instalment schedules	List instalment schedules	X
	Get a single instalment schedule	X
	Create instalment schedule		X
	Create instalment schedule		X
	Update an instalment schedule		X
	Cancel an instalment schedule		X
Logos	Create a logo associated with a creditor		X
Mandate import entries	List all mandate import entries	X
Mandate import entries	Add a mandate import entry		X
Mandate imports	Get a mandate import	X
	Create a new mandate import		X
	Submit a mandate import		X
	Cancel a mandate import		X
Mandates	List mandates	X
	Get a single mandate	X
	Create a mandate		X
	Update a mandate		X
	Cancel a mandate		X
	Reinstate a mandate		X
Negative balance limits	List negative balance limits	X
Negative balance limits	Create a negative balance limit		X
Payer authorisations	Get a single-payer authorisation	X
	Create payer authorisation		X
	Update a payer authorisation		X
	Submit a payer authorisation		X
	Confirm a payer authorisation		X
Payer themes	Create a payer theme associated with a creditor		X
Payments	List payments	X
	Get a single payment	X
	Create a payment		X
	Update a payment		X
	Cancel a payment		X
	Retry a payment		X
Payout items	Get all payout items in a single payout	X
Payouts	List payouts	X
	Get a single payout	X
	Update a payout		X
Redirect flows	Get a single redirect flow	X
	Create redirect flow		X
	Complete a redirect flow		X
Refunds	List refunds	X
	Get a single refund	X
	Create a refund		X
	Update a refund		X
Scenario simulators	Run scenario simulator		X
Scheme identifiers	List scheme identifiers	X
	Get a single scheme identifier	X
	Create a scheme identifier		X
Subscriptions	Webhook information retrieval	X
	List subscriptions	X
	Get a single subscription	X
	Create a subscription		X
	Update a subscription		X
	Pause a subscription		X
	Resume subscription		X
	Cancel a subscription		X
Tax rates	List tax rates	X
Tax rates	Get a single tax rate	X
Verification details	List verification details	X
Verification details	Create a verification detail		X
Webhooks	List webhooks	X
	Get a single webhook	X
	Retry a webhook		X

Note

Can't find what you're looking for?