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

Assignment

assigneeobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

assignerobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

creatorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

firstAgentobject(InstitutionIdentification)

{
  "assignee": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "assigner": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "firstAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  }
}

VerificationOutcome

Indicates whether the information provided in the verification request was correct (PASSED) or was incorrect (FAILED). If it was incorrect, a reason is provided.

schemastring

Discriminator

reasonInfoobject(VerificationReasonInfo)

Provides detailed information on a verification reason.

{
  "schema": "FAILED",
  "reasonInfo": {
    "additionalInformation": "string",
    "reason": { … }
  }
}

ExternalVerificationReason1Code

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

string(ExternalVerificationReason1Code)[ 1 .. 4 ] characters

AC01 : Account number provided in the request is invalid or missing.
AGNT : Agent identification provided in the request is incorrect.
DUPL : Request is a duplicate of another request.
AG01 : Transaction forbidden on this type of account (Payment cannot be made to this account for example not open for deposits, blocked, closed).
BNOR : PSP is not registered under this Scheme.
DS28 : Return following technical problems resulting in erroneous transaction.
FF01 : File format incomplete or invalid.
MS03 : Reason has not been specified by agent.
NORR : No response on request within timeframe.
NR01 : PSP not able to confirm details and no reason is stated.
RC03 : Debtor bank identifier is invalid or missing.
RC04 : Creditor bank identifier is invalid or missing.
TM01 : Associated message was received after agreed processing cut-off time.
PN01 : Account Owner name and Payment Account number do not match.
PN02 : Account Owner name and Payment Account number is a close match.
PI01 : Account Owner Identification and Payment Account number do not match.

Enum"AC01""AGNT""DUPL""AG01""BNOR""DS28""FF01""MS03""NORR""NR01"

"AC01"

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations