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/
Provides details on the type of mandate.
{ "categoryPurpose": { "schema": "string", "value": "BONU" }, "classification": { "schema": "string", "value": "FIXE" }, "localInstrument": { "schema": "string", "value": "0000" }, "serviceLevel": { "schema": "string", "value": "BKTR" } }
Core mandate data structure containing all the details of a direct debit mandate.
Identifies the specific mechanism or channel that the Paying Bank (Debtor Bank) uses to communicate with the Payer (Debtor) to obtain their authorisation for a mandate. This field may be missing on mandate initiation/amendment and should be populated by the debtor bank upon acceptance of the mandate
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Unique identification of the mandate, as assigned by the creditor. This field is used strictly by the Creditor for their own internal referencing and may be used to link collections to their related mandate. This is required for mandate initiations and cancellations.
Reference assigned to the mandate by the mandate management application. This is distinct from mandateIdentification (creditor's ID) and ZaMandatePaymentSchemeSupplementaryData.debtorBankMandateReference (debtor bank's reference).
Unique identification of the mandate request, as assigned by the creditor to the debtor when the underlying contract is concluded between the two parties. This field represents the Contract Reference Number. It appears on the debtor's bank statement to help them identify the deductions. This is required for mandate initiations and mandate cancellations.
Specifies the reason for a mandate action (amendment, cancellation, rejection).
Provides information to identify the underlying documents associated with the mandate
Indicates whether the mandate permits tracking for future collection instructions. Its exact meaning and relevance depend strictly on the mandate-management operation being performed:
1. Mandate Initiation & Amendment Requests
true) or revoked (false) for future collections against this mandate.2. Mandate Cancellation Requests
true: Instructs the clearing house to immediately cancel any active tracking records currently in the tracking queue for this mandate.false: Instructs the clearing house NOT to cancel records in tracking, allowing them to finish their tracking cycle despite the mandate being cancelled.3. Mandate Acceptance Reports
true or false) that was successfully saved to the Debtor Bank's Mandate Register.4. Mandate Suspensions & Information Requests
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
{ "adjustment": { "adjustmentAmount": { … }, "adjustmentRate": 0.1, "category": { … }, "dateAdjustmentRuleIndicator": true }, "authentication": { "channel": { … }, "date": "2019-08-24", "messageAuthenticationCode": "string" }, "collectionAmount": { "currency": "string", "value": 0.1 }, "creditor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "creditorAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "creditorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "creditorSchemeIdentification": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "debtor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "debtorAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "debtorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "firstCollectionAmount": { "currency": "string", "value": 0.1 }, "mandateIdentification": "string", "mandateReference": "string", "mandateRequestIdentification": "string", "maximumAmount": { "currency": "string", "value": 0.1 }, "occurrences": { "finalCollectionDate": "2019-08-24", "firstCollectionDate": "2019-08-24", "frequency": { … }, "sequenceType": "FRST", "validFrom": "2019-08-24", "validTo": "2019-08-24" }, "reason": { "schema": "string", "value": "AC01" }, "referredDocument": [ { … } ], "trackingIndicator": true, "type": { "categoryPurpose": { … }, "classification": { … }, "localInstrument": { … }, "serviceLevel": { … } }, "ultimateCreditor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "ultimateDebtor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" } }
Mandate Request Transaction Identifier (MRTI) A unique transaction identifier used for matching multiple messages to a single transaction. This identifier is created for each new mandate request to uniquely identify the transaction within the Authenticated Collections scheme.
Important: Usage of mandateRequestTransactionIdentifier**.
MRTI. The format is validated and the provided MRTI is used by Electrum.MRTI should not be provided by the client when initiating new mandate transactions; Electrum will generate a compliant MRTI automatically which will be echoed back to the client.Structure (23 characters):
YYYY-MM-DD. Must be a valid date.Lifecycle behaviour:
MRTI for the initiation request. If not provided by the client, Electrum generates one automatically.MRTI is required for the amendment request. If not provided by the client, Electrum generates one automatically. The amendment is linked back to the original mandate using the Mandate Reference Number (MRN).MRTI must exactly match the MRTI of the in-flight request being cancelled. If not provided, Electrum handles this automatically by retrieving the MRTI of the in-flight transaction.MRTI must be issued for the cancellation request. If not provided, Electrum determines the mandate state and applies the correct rule automatically.MRTI from the request being responded to. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.MRTI from the request being reported on. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.Validation rules enforced by the scheme:
Mandate Request Transaction Identifier (MRTI) A unique transaction identifier used for matching multiple messages to a single transaction. This identifier is created for each new mandate request to uniquely identify the transaction within the Authenticated Collections scheme.
Important: Usage of mandateRequestTransactionIdentifier**.
MRTI. The format is validated and the provided MRTI is used by Electrum.MRTI should not be provided by the client when initiating new mandate transactions; Electrum will generate a compliant MRTI automatically which will be echoed back to the client.Structure (23 characters):
YYYY-MM-DD. Must be a valid date.Lifecycle behaviour:
MRTI for the initiation request. If not provided by the client, Electrum generates one automatically.MRTI is required for the amendment request. If not provided by the client, Electrum generates one automatically. The amendment is linked back to the original mandate using the Mandate Reference Number (MRN).MRTI must exactly match the MRTI of the in-flight request being cancelled. If not provided, Electrum handles this automatically by retrieving the MRTI of the in-flight transaction.MRTI must be issued for the cancellation request. If not provided, Electrum determines the mandate state and applies the correct rule automatically.MRTI from the request being responded to. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.MRTI from the request being reported on. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.Validation rules enforced by the scheme:
"string"