GoCardless

FinanceOAuth 2.0Credentials form

Collect Direct Debit and bank payments in GoCardless: manage customers, mandates, payments, refunds, subscriptions and payouts.

14 actions

ActionEffectData handledScope
gocardless_list_customersLists customers, newest first, with name, email and addressreadPersonal dataread_only
gocardless_get_customerReturns one customer with contact details, address and metadatareadPersonal dataread_only
gocardless_create_customerCreates a customer recordwritePersonal dataread_write
gocardless_list_mandatesLists Direct Debit mandates, filtered by customer or status, with scheme, reference and next possible charge datereadPersonal dataread_only
gocardless_list_paymentsLists payments, newest first, filtered by customer, mandate, subscription, status or creation datereadGeneralread_only
gocardless_get_paymentReturns one payment's amount, charge date, status, reference and linked mandate, subscription and payoutreadGeneralread_only
gocardless_create_paymentCollects a one-off payment against an active mandatewriteGeneralread_write
gocardless_cancel_paymentCancels a payment that has not been submitted to the banks yetwriteGeneralread_write
gocardless_retry_paymentRetries a failed payment, optionally on a later charge datewriteGeneralread_write
gocardless_create_refundRefunds part or all of a confirmed or paid-out paymentwriteGeneralread_write
gocardless_list_subscriptionsLists subscriptions, filtered by customer, mandate or status, with amount, interval and upcoming paymentsreadGeneralread_only
gocardless_create_subscriptionCreates recurring payments against a mandate: an amount in minor units every interval of weeks, months or yearswriteGeneralread_write
gocardless_cancel_subscriptionCancels a subscription and any of its payments not yet submittedwriteGeneralread_write
gocardless_list_payoutsLists payouts to the merchant's bank account, newest first, with amount, fees, status and arrival datereadGeneralread_only