IGoCardless Interface

Payment communication interface. UK Online Direct Debit provider.

Links to GoCardless' documentation:

API reference: https://developer.gocardless.com/api-reference/#api-usage-making-requests.
Testing scenarios: https://developer.gocardless.com/getting-started/developer-tools/scenario-simulators/.
Errors: https://developer.gocardless.com/api-reference/#api-usage-errors.
Webhooks: https://developer.gocardless.com/api-reference/#events-mandate-actions.

Namespace: NetQuarry.Services.Payment
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

public interface IGoCardless

Public Interface IGoCardless

The IGoCardless type exposes the following members.

Methods

	Name	Description
	CancelMandate	Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.
	CancelPayment	Cancels the payment if it has not already been submitted to the banks. Any metadata supplied to this endpoint will be stored on the payment cancellation event it causes.
	CompleteRedirectFlow	This should be called after user gets redirect back to our site.
	CreateBankAccount	Creates a new customer bank account object. RESTRICTED: this endpoint is restricted to GoCardless Pro accounts with approved payment pages. To instead use the GoCardless hosted payment pages, see GoCardless.Create function for redirect flows.
	CreateCustomer	Creates a new customer object. RESTRICTED: this endpoint is restricted to GoCardless accounts with approved payment pages. To instead use the GoCardless hosted payment pages, see GoCardless.Create function for redirect flows.
	CreateMandate	Creates a new mandate object. RESTRICTED: this endpoint is restricted to GoCardless Pro accounts with approved payment pages. To instead use the GoCardless hosted payment pages, see GoCardless.Create function for redirect flows.
	CreatePayment	Creates a new payment object.
	CreateRedirectFlow	For creating a customer, account + mandate.
	CreateRefund	Creates a new refund object. DISABLED by default - contact GCL to enable
	DisableBankAccount	Immediately cancels all associated mandates and cancellable payments. A disabled bank account can be re-enabled by creating a new bank account resource with the same details.
	GetBankAccountDetail	Retrieves the details of an existing bank account.
	GetBankAccountList	Returns a cursor-paginated list of your bank accounts.
	GetCustomerDetail	Retrieves the details of an existing customer.
	GetCustomerList	Returns a cursor-paginated list of your customers.
	GetEventDetail	Retrieves the details of a single event.
	GetEventList	Returns a cursor-paginated list of your events.
	GetMandateDetail	Retrieves the details of an existing mandate.
	GetMandateList	Returns a cursor-paginated list of your mandates.
	GetPaymentDetail	Retrieves the details of a single existing payment.
	GetPaymentList	Returns a cursor-paginated list of your payments.
	GetRedirectFlowDetail	Gets all details about a single redirect flow
	GetRefundDetail	Retrieves all details for a single refund
	GetRefundList	Returns a cursor-paginated list of your refunds.
	ReinstateMandate	Reinstates a cancelled or expired mandate to the banks. RESTRICTED: this endpoint is restricted to accounts with approved payment pages. To instead use the GoCardless hosted payment pages, see GoCardless.Create function for redirect flows.
	RetryPayment	Retries a failed payment if the underlying mandate is active.
	UpdateBankAccount	Updates a customer bank account object. Only the metadata parameter is allowed.
	UpdateCustomer	Updates a customer object. Supports all of the fields supported when creating a customer.
	UpdateMandate	Updates a mandate object. This accepts only the metadata parameter.
	UpdatePayment	Updates a payment object. This accepts only the metadata parameter.
	UpdateRefund	Updates a refund object.
	WebhookNotify	Handles GoCardless webhook notifications. Once application event is fired, app is responsible for ensuring that the event wasn't already processed (webhooks could arrive out of order)

Top

Remarks

Overview of some GoCardless objects:

A customer may have multiple customer bank accounts.
A customer bank account may have multiple mandates but we almost always only want one per account.
Multiple payments can be taken through a mandate.

Notes regarding some APIs:

The following APIs can't be used unless GoCardless approves their pages; asterisked APIs also require the GoCardless Pro package:
customers create*, bank accounts create*, mandates create*, mandates reinstate.
A redirect flow can be used to create a customer, customer bank account and mandate without needing pages approved or the GoCardless Pro Package.
To use the refunds create API, GoCardless needs to be contacted to enable it.
An "Idempotency-Key" prevents duplication of successful payments over short periods of time.

Reference

NetQuarry.Services.Payment Namespace