Electrum Regulated Payments Partner API (17.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.

Download OpenAPI description

elpapi-partner.json

elpapi-partner.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/

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

Schema

RequestToPayInitiationResponse

An extension of BaseMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

bulkPaymentSchemeNamestring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

numberOfTransactionsinteger>= 1

The total amount of transactions in the bulk.

requestToPayInformationIdstring(UUID)required

Universally unique identifier to identify the bulk collection itself.

requestToPayInitiationStatusobject(InitiationStatus)required

requestToPayInitiationStatus.outcomestringrequired

RECEIVED: The bulk initiation has been received.
PENDING: The bulk initiation is undergoing pre-checks.
ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.
COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.
REJECTED: The bulk initiation has been rejected.

Enum"RECEIVED""PENDING""ACCEPTED""COMPLETED""REJECTED"

requestToPayInitiationStatus.reasonInfoArray of objects(StatusReasonInfo)non-empty

A list of StatusReasonInfo values providing detailed reason information for the outcome.

requestToPayInstructionStatusReportsArray of objects(RequestToPayInstructionStatusReport)>= 0 items

List of RequestToPayInstructionStatusReports relating to each request to pay initiation instruction received and actioned. Unsubmitted transactions will not be in this list.

schemastringrequired

Value"RequestToPayInitiationStatusRequest"

transactionStatisticsobject(RequestToPayTransactionStatistics)required

A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

transactionStatistics.numberOfAcceptedTransactionsintegerrequired

Count of transactions with the ACCEPTED status.

transactionStatistics.numberOfCancelledTransactionsintegerrequired

Count of transactions with the CANCELLED status.

transactionStatistics.numberOfExpiredTransactionsintegerrequired

Count of transactions with the EXPIRED status.

transactionStatistics.numberOfPaidTransactionsintegerrequired

Count of transactions with the PAID status.

transactionStatistics.numberOfPendingTransactionsintegerrequired

Count of transactions with the PENDING status.

transactionStatistics.numberOfPresentedTransactionsintegerrequired

Count of transactions with the PRESENT status.

transactionStatistics.numberOfRejectedTransactionsintegerrequired

Count of transactions with the REJECTED status.

transactionStatistics.numberOfUnsubmittedTransactionsintegerrequired

number of transactions not yet sent to industry, and thus do not yet have an official RTP state.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "bulkPaymentSchemeName": "ZA_RTC",
  "numberOfTransactions": 1,
  "requestToPayInformationId": "string",
  "requestToPayInitiationStatus": {
    "outcome": "RECEIVED",
    "reasonInfo": [ … ]
  },
  "requestToPayInstructionStatusReports": [
    { … }
  ],
  "schema": "RequestToPayInitiationStatusRequest",
  "transactionStatistics": {
    "numberOfAcceptedTransactions": 0,
    "numberOfCancelledTransactions": 0,
    "numberOfExpiredTransactions": 0,
    "numberOfPaidTransactions": 0,
    "numberOfPendingTransactions": 0,
    "numberOfPresentedTransactions": 0,
    "numberOfRejectedTransactions": 0,
    "numberOfUnsubmittedTransactions": 0
  }
}

DeterminationRequest

A request providing information for the lookup of a proxy or account in the context of the ZA RPP Payment Scheme:

If the identifier schema is either MOBILE or CUSTOM, proxy resolution will be performed. In this case, the identifier.namespace field is required.
If the identifier schema is GENERIC, account resolution will be performed. In this case, the accountAgent.bicfi field is required.

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

Discriminator

accountAgentobject(InstitutionIdentification)

identifierany(ZaRppIdentifier)required

identifier.namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

ZA_RPP

identifier.schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

identifier.valuestring[ 1 .. 2048 ] charactersrequired

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

requestorobject(ZaRppRequestor)

uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference. This identifier remains the same for all messages related to the same transaction.

verificationIdentificationstring[ 1 .. 35 ] charactersrequired

Unique identifier for this specific verification request.

{
  "schema": "ZA_RPP",
  "accountAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "identifier": {
    "namespace": "string",
    "schema": "string",
    "value": "string"
  },
  "instructedAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "instructingAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "requestor": {
    "schema": "string"
  },
  "uetr": "string",
  "verificationIdentification": "string"
}

ZaRppIdentifier

namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

valuestring[ 1 .. 2048 ] charactersrequired

{
  "namespace": "string",
  "schema": "CUSTOM",
  "value": "string"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations