Electrum Regulated Payments Partner API (31.2.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-redoc.json

elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

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

RequestToPayStatusCode

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an initial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

string(RequestToPayStatusCode)

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an initial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

Enum"PAID""ACCEPTED""CANCELLED""EXPIRED""PENDING""PRESENTED""REJECTED""REFUND_IN_PROGRESS""REFUNDED"

"PAID"

RequestToPayStatus

reasonInfoArray of objects(RequestToPayStatusReasonInfo)non-empty

A list of RequestToPayStatusReasonInfo values providing detailed reason information for the status.

statusstring(RequestToPayStatusCode)required

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an initial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

Enum"PAID""ACCEPTED""CANCELLED""EXPIRED""PENDING""PRESENTED""REJECTED""REFUND_IN_PROGRESS""REFUNDED"

{
  "reasonInfo": [
    { … }
  ],
  "status": "PAID"
}

RequestToPayResponse

An extension of BaseTransactionMessage 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

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

transactionIdentifiers.uetrstring(UUID)required

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

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

originalRequestToPayDataobject(OriginalRequestToPayData)

Contains key elements related to the original request to pay that is being referred to.

requestToPayConditionsobject(RequestToPayConditions)

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

schemastringrequired

Value"RequestToPayResponse"

statusobject(RequestToPayStatus)required

status.reasonInfoArray of objects(RequestToPayStatusReasonInfo)non-empty

A list of RequestToPayStatusReasonInfo values providing detailed reason information for the status.

status.statusstring(RequestToPayStatusCode)required

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an initial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

Enum"PAID""ACCEPTED""CANCELLED""EXPIRED""PENDING""PRESENTED""REJECTED""REFUND_IN_PROGRESS""REFUNDED"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "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"
  },
  "originalRequestToPayData": {
    "amounts": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "requestToPayConditions": { … }
  },
  "requestToPayConditions": {
    "maxAmount": { … },
    "minAmount": { … }
  },
  "schema": "RequestToPayResponse",
  "status": {
    "reasonInfo": [ … ],
    "status": "PAID"
  }
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations