Docs

API Explorer

Regular Payments

1.0

Manages Regular Payments features including setting up a new or change an existing direct debit for a given account.

Endpoints

get
/regular-payments/{accountId}/configuration
post
/regular-payments/{accountId}
put
/regular-payments/{accountId}
get
/regular-payments/{accountId}
post
/regular-payments/{accountId}/cancel

GetPaymentConfiguration

Returns configured regular payment options (e.g. Full, Percentage, Fixed etc.), and payment scheme required fields (sort code and account for BACS), for a given account/tenant.

get

/regular-payments/{accountId}/configuration

SetupRegularPayment

Setup a new regular payment (e.g. direct debit) for the given account.

post

/regular-payments/{accountId}

UpdateRegularPayment

Make changes to an existing regular payment for the given account.

put

/regular-payments/{accountId}

GetRegularPayment

Returns regular payment details (e.g. direct debit) for the given account.

get

/regular-payments/{accountId}

CancelRegularPayment

Cancels the existing regular payment for the given account.

post

/regular-payments/{accountId}/cancel

Models

Amount

Bank Details that are required for the given scheme (Dynamic Properties)

Collection options

Collection Options to be set for the regular payment

EmptyResult•
object

ExtraPaymentOptions•
string enum

Get Regular Payment Response

Regular payment Scheme details for the given account/tenant

New regular payment that is planned on the given account (available only if applicable)

Projected Payment for last completed Billing Period

Regular payment collection attributes

Regular payment option to be applied on the regular payment

Regular payment option to applied on the regular payment

Status indicating current state for this regular payment

Regular Payment Setup or Update Request

Setup or Update Regular Payment Response

Was this page helpful?