Electrum Regulated Payments Partner API (26.1.1)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

  • Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
  • Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

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.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

Download OpenAPI description
Languages
Servers
Partner API sandbox

https://example.com/path/payments/partner-api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

account-management

Operations that involve customer account information.

Operations

sanctions-assessment

Operations related to the processing of sanctions assessment for payment transactions.

Operations

mandate-management

Operations related to the lifecycle management of direct debit mandates.

Operations

Schema

AuthenticationChannelCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestring(ExternalAuthenticationChannelCode)required

ATM - ATM CARD - Card INBA - InternetBanking MOBI - Mobile

Enum"ATMA""CARD""INBA""MOBI"
{ "schema": "string", "value": "ATMA" }

AuthenticationChannel

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
valuestring(ExternalAuthenticationChannelCode)required

ATM - ATM CARD - Card INBA - InternetBanking MOBI - Mobile

Enum"ATMA""CARD""INBA""MOBI"
{ "schema": "CODE", "value": "ATMA" }

MandateAuthentication

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

channelobject(AuthenticationChannel)
datestring(date)

Represents the exact date on which the mandate authentication process was completed by the Paying Bank (Debtor Bank)

messageAuthenticationCodestring<= 35 characters

Message authentication code for the mandate.

  • TT3 PREAUTH MAC Rule: Mandate Initiation & Amendment Requests & Acceptance Reports - Across 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" }

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations