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/
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
Represents the exact date on which the mandate authentication process was completed by the Paying Bank (Debtor Bank)
Message authentication code for the mandate.
mandate-management message types, if the mandate is PREAUTH using a card (Local Instrument 0228), this property must strictly be populated with the actual 8-character MAC string generated during the upfront card-and-PIN authentication.{ "channel": { "schema": "string", "value": "ATMA" }, "date": "2019-08-24", "messageAuthenticationCode": "string" }