Specifies the frequency of the payment transaction.
{ "schema": "AdHocFrequency" }
The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.
https://example.com/path/payments/api/v1/
Defines the frequency and duration of mandate collections.
Identifies the direct debit sequence:
FRST : First collection of a series of direct debit instructions.RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.FNAL : Final collection of a series of direct debit instructions.OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.RPRE : Collection used to represent previously reversed or returned direct debit transactions.{ "finalCollectionDate": "2019-08-24", "firstCollectionDate": "2019-08-24", "frequency": { "dayOfMonth": 1, "schema": "MonthlyFrequency" }, "sequenceType": "FRST", "validFrom": "2019-08-24", "validTo": "2019-08-24" }
AC01 - IncorrectAccountNumberAC04 - ClosedAccountNumberAC06 - BlockedAccountAG01 - TransactionForbiddenAG02 - InvalidBankOperationCodeAM02 - NotAllowedAmountAM03 - NotAllowedCurrencyAM05 - DuplicationBE01 - InconsistenWithEndCustomerBE04 - MissingCreditorAddressBE05 - UnrecognisedInitiatingPartyBE06 - UnknownEndCustomerBE07 - MissingDebtorAddressDT01 - InvalidDateFF01 - InvalidFileFormatMD01 - NoMandateMD02 - MissingMandatoryInformationInMandateMD07 - EndCustomerDeceasedMD08 - NoMandateServiceByAgentMD09 - NoMandateServiceOnCustomerMD10 - NoMandateServiceForSpecifiedMD11 - UnrecognisedAgentMD12 - NotUniqueMandateReferenceMD13 - IncorrectCustomerAuthenticationMD14 - IncorrectAgentMD15 - IncorrectCurrencyMD16 - RequestedByCustomerMD17 - RequestedByInitiatingPartyMD18 - RequestedByInitiatingPartyAndCustomerMD19 - MandateCancelledDueToEarlySettlementMD20 - MandateExpiredMD21 - MandateCancelledDueToFraudMD22 - MandateInitiationCancelledMD23 - MandateAmendmentCancelledMS02 - NotSpecifiedReasonCustomerGeneratedMS03 - NotSpecifiedReasonAgentGeneratedNARR - NarrativeRC01 - BankIdentifierIncorrectRF01 - NotUniqueTransactionReferenceRR01 - MissingDebtorAccountOrIdentificationRR02 - MissingDebtorNameOrAddressRR03 - MissingCreditorNameOrAddressRR04 - RegulatoryReasonSL01 - SpecificServiceOfferedByDebtorAgentSL11 - CreditorNotOnWhitelistOfDebtorSL12 - CreditorOnBlacklistOfDebtorSL13 - MaximumNumberOfDirectDebitTransactionsExceededSL14 - MaximumDirectDebitTransactionAmountExceeded{ "schema": "string", "value": "AC01" }