Electrum Regulated Payments Partner API (34.1.0)

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.

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

payment-cancellation

Operations related to the cancellation of prior payment instructions.

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

ExternalMandateClassificationCode

Classification of the mandate based on how the collection amount is determined. In the ZA_AC scheme this is the mandate's Debit Value Type, and it dictates strict interbank validation rules for how collection amounts are calculated, capped, and adjusted over the life of the mandate.

The rules for each value are:

  • FIXE (Fixed): Used for contracts where an upfront, calculated Instalment Amount is the basis for normal collections. Regular collections are strictly validated and cannot exceed this Instalment Amount. The Adjustment Category (adjustment.category) for a fixed mandate must strictly be NEVR (Never).
  • VARI (Variable): Used for contracts where an upfront Instalment Amount is calculated but can be amended by the Creditor based on pre-agreed variables, such as annual increases or interest rate changes. Regular collections cannot exceed the currently active Instalment Amount.
  • USGB (Usage-based): Used for contracts where the collection amount fluctuates depending on the Payer's usage of a product or service during the payment cycle. Unlike fixed and variable mandates, the regular Instalment Amount (collectionAmount) is optional, and interbank validation is instead performed strictly against a mandatory Maximum Collection Amount (maximumAmount).
string(ExternalMandateClassificationCode)

Classification of the mandate based on how the collection amount is determined. In the ZA_AC scheme this is the mandate's Debit Value Type, and it dictates strict interbank validation rules for how collection amounts are calculated, capped, and adjusted over the life of the mandate.

The rules for each value are:

  • FIXE (Fixed): Used for contracts where an upfront, calculated Instalment Amount is the basis for normal collections. Regular collections are strictly validated and cannot exceed this Instalment Amount. The Adjustment Category (adjustment.category) for a fixed mandate must strictly be NEVR (Never).
  • VARI (Variable): Used for contracts where an upfront Instalment Amount is calculated but can be amended by the Creditor based on pre-agreed variables, such as annual increases or interest rate changes. Regular collections cannot exceed the currently active Instalment Amount.
  • USGB (Usage-based): Used for contracts where the collection amount fluctuates depending on the Payer's usage of a product or service during the payment cycle. Unlike fixed and variable mandates, the regular Instalment Amount (collectionAmount) is optional, and interbank validation is instead performed strictly against a mandatory Maximum Collection Amount (maximumAmount).
Enum"FIXE""USGB""VARI"
"FIXE"

MandateClassificationCode

schemastringrequired

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

valuestring(ExternalMandateClassificationCode)required

Classification of the mandate based on how the collection amount is determined. In the ZA_AC scheme this is the mandate's Debit Value Type, and it dictates strict interbank validation rules for how collection amounts are calculated, capped, and adjusted over the life of the mandate.

The rules for each value are:

  • FIXE (Fixed): Used for contracts where an upfront, calculated Instalment Amount is the basis for normal collections. Regular collections are strictly validated and cannot exceed this Instalment Amount. The Adjustment Category (adjustment.category) for a fixed mandate must strictly be NEVR (Never).
  • VARI (Variable): Used for contracts where an upfront Instalment Amount is calculated but can be amended by the Creditor based on pre-agreed variables, such as annual increases or interest rate changes. Regular collections cannot exceed the currently active Instalment Amount.
  • USGB (Usage-based): Used for contracts where the collection amount fluctuates depending on the Payer's usage of a product or service during the payment cycle. Unlike fixed and variable mandates, the regular Instalment Amount (collectionAmount) is optional, and interbank validation is instead performed strictly against a mandatory Maximum Collection Amount (maximumAmount).
Enum"FIXE""USGB""VARI"
{ "schema": "string", "value": "FIXE" }

MandateClassification

schemastringrequired

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

Discriminator
valuestring(ExternalMandateClassificationCode)required

Classification of the mandate based on how the collection amount is determined. In the ZA_AC scheme this is the mandate's Debit Value Type, and it dictates strict interbank validation rules for how collection amounts are calculated, capped, and adjusted over the life of the mandate.

The rules for each value are:

  • FIXE (Fixed): Used for contracts where an upfront, calculated Instalment Amount is the basis for normal collections. Regular collections are strictly validated and cannot exceed this Instalment Amount. The Adjustment Category (adjustment.category) for a fixed mandate must strictly be NEVR (Never).
  • VARI (Variable): Used for contracts where an upfront Instalment Amount is calculated but can be amended by the Creditor based on pre-agreed variables, such as annual increases or interest rate changes. Regular collections cannot exceed the currently active Instalment Amount.
  • USGB (Usage-based): Used for contracts where the collection amount fluctuates depending on the Payer's usage of a product or service during the payment cycle. Unlike fixed and variable mandates, the regular Instalment Amount (collectionAmount) is optional, and interbank validation is instead performed strictly against a mandatory Maximum Collection Amount (maximumAmount).
Enum"FIXE""USGB""VARI"
{ "schema": "CODE", "value": "FIXE" }

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations