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

Request identifier information

Request

This operation is asynchronous. The outcome of the request is delivered by the inboundIdentifierDeterminationReport operation.

The inbound identifier determination operation can be called to resolve additional information about an identifier, for example to resolve a proxy.

In the context of an inbound payment, Electrum sends an identifier determination to the partner for processing.

Scheme	Applicable	Function Enabled
ZA_EFT	✗	N/A
ZA_RPP	✓	Proxy Resolution - Validate a proxy and return additional information for use in a subsequent credit transfer
ZA_RTC	✗	N/A

Headers

traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

Bodyapplication/jsonrequired

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

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

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.

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

supplementaryDataobject(SupplementaryData)

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

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.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.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.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.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

creditorobject(Party)required

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

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

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

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

instructionForCreditorAgentArray of objects(Instruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

Agents between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/identifiers/inbound/identifier-determination \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "messageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "schema": "IdentifierDeterminationRequest",
    "request": {
      "schema": "ZA_RPP",
      "instructedAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructingAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "requestor": {
        "schema": "INSTITUTION_IDENTIFICATION",
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "domain": "ADomain",
        "name": "Amazing Bank Inc"
      },
      "identifier": {
        "namespace": "AnotherDomain",
        "schema": "MOBILE",
        "value": "+27-0214620000"
      },
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
      "verificationIdentification": "e3360de097fe42a195cc53251d0ec839"
    },
    "supplementaryData": {
      "customData1": "My custom data 1",
      "customData2": "My custom data 2"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Deliver additional identifier information

Request

This operation is asynchronous. It communicates the outcome of an outboundIdentifierDetermination operation.

The outbound identifier determination operation can be called to determine information related to an identifier, for example to resolve a proxy. This operation is the asynchronous response to that operation.

In the context of an outbound payment, Electrum sends a response to an identifier determination previously received from the partner.

Scheme	Applicable	Function Enabled
ZA_EFT	✗	N/A
ZA_RPP	✓	Proxy Resolution - Validate a proxy and return additional information for use in a subsequent credit transfer
ZA_RTC	✗	N/A

Headers

traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

Bodyapplication/jsonrequired

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

supplementaryDataobject(SupplementaryData)

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

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

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.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.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

creditorobject(Party)required

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

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

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

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

instructionForCreditorAgentArray of objects(Instruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/identifiers/outbound/identifier-determination-report \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "IdentifierDeterminationResponse",
    "messageIdentifiers": {
      "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
      "creationDateTime": "2022-05-04T03:22:11Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "report": {
      "originalUetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
      "originalVerificationIdentification": "1001",
      "schema": "ZA_RPP",
      "reportInformation": {
        "outcome": "SUCCESSFUL",
        "transactionLimit": {
          "value": 3000,
          "currency": "ZAR"
        },
        "accountInformation": {
          "proxy": {
            "schema": "MOBILE",
            "value": "+27-812456789"
          },
          "creationDate": "2021-01-01T09:55:45.015708Z",
          "traditionalIdentifier": {
            "schema": "GENERIC",
            "value": 1234567890
          }
        },
        "accountOwner": {
          "knownAsName": "Shaun",
          "legalName": "Shaun John Smith"
        }
      },
      "instructedAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructingAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "originalRequestor": {
        "schema": "INSTITUTION_IDENTIFICATION",
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "domain": "ADomain",
        "name": "Amazing Bank Inc"
      }
    },
    "supplementaryData": {
      "customData1": "My custom data 1",
      "customData2": "My custom data 2"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Request identifier information synchronously

Request

This operation is synchronous.

The inbound identifier determination operation can be called to resolve additional information about an identifier, for example to resolve a proxy.

In the context of an inbound payment, Electrum sends an identifier determination to the partner for processing.

Scheme	Applicable	Function Enabled
ZA_EFT	✗	N/A
ZA_RPP	✓	Proxy Resolution - Validate a proxy and return additional information for use in a subsequent credit transfer
ZA_RTC	✗	N/A

Headers

traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

Bodyapplication/jsonrequired

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

supplementaryDataobject(SupplementaryData)

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

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

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.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.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

creditorobject(Party)required

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

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

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

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

instructionForCreditorAgentArray of objects(Instruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/identifiers/inbound/identifier-determination-sync \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "messageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "schema": "IdentifierDeterminationRequest",
    "request": {
      "schema": "ZA_RPP",
      "instructedAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "instructingAgent": {
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "name": "Amazing Bank Inc",
        "branch": {
          "identification": 210514,
          "name": "ABC Plettenberg Bay",
          "address": {
            "addressType": "ADDR",
            "department": "Department of Mysteries",
            "streetName": "Street of Mysteries",
            "buildingNumber": 42,
            "buildingName": "Mysterious Building",
            "floor": 42,
            "postBox": 1024,
            "postCode": 4242,
            "townName": "Mysty Town",
            "townLocationName": "Mysty Location",
            "districtName": "Mysty District",
            "countrySubDivision": "Mysterious Cape",
            "country": "ZA",
            "addressLine": [
              "16A",
              "New market street",
              "Foreshore",
              "Cape Town",
              "ZA",
              8001
            ]
          }
        }
      },
      "requestor": {
        "schema": "INSTITUTION_IDENTIFICATION",
        "bicfi": "RY8PEG0L",
        "memberId": "AmazingBankId",
        "domain": "ADomain",
        "name": "Amazing Bank Inc"
      },
      "identifier": {
        "namespace": "AnotherDomain",
        "schema": "MOBILE",
        "value": "+27-0214620000"
      },
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
      "verificationIdentification": "e3360de097fe42a195cc53251d0ec839"
    },
    "supplementaryData": {
      "customData1": "My custom data 1",
      "customData2": "My custom data 2"
    }
  }'

Responses

OK. RFC9110 - 200

Note that a response containing a 200 (OK) HTTP status does not necessarily mean that the response contains a positive outcome but rather that the Partner successfully processed the request and is providing a response. The functional outcome might still be a negative one (e.g. the identifier was not found). In the event that the partner encounters a technical error when processing a synchronous identifier determination request, the appropriate 4xx or 5xx response should be used.

Bodyapplication/json

schemastringrequired

Discriminator

messageIdentifiersobject(MessageIdentifiers)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

supplementaryDataobject(SupplementaryData)

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

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

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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.

paymentSchemeobject(CreditTransferPaymentScheme)required

Designates which scheme a credit transfer is associated with and describes scheme-specific information for the credit transfer.

paymentScheme.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.

Enum"ZA_RTC""ZA_RPP""ZA_EFT"

Discriminator

paymentScheme.schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

paymentScheme.schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

paymentScheme.schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

paymentScheme.schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

amounts.bankSettlementAmount.valuenumber(double)>= 0required

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

amounts.bankSettlementAmount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amounts.instructedAmountobject(Amount)

paymentTypeInformationobject(PaymentTypeInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

creditorobject(Party)required

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

creditor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

creditor.knownAsNamestring[ 1 .. 140 ] characters

creditor.addressobject(PostalAddress)

creditor.contactDetailsobject(ContactDetails)

creditor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

creditor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

creditorAccountobject(PaymentAccount)required

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAccount.identificationobject(BankingIdentifier)

creditorAccount.proxyobject(NonBankingIdentifier)

creditorAccount.typeobject(AccountType)

creditorAccount.namestring<= 70 characters

Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.

creditorAccount.currencystring^[A-Z]{3}$

Identification of the currency in which the account is held.

creditorAgentobject(InstitutionIdentification)required

creditorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

creditorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

creditorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

creditorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

creditorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

creditorAgent.branchobject(BranchIdentification)

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorobject(Party)required

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

debtor.legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

debtor.knownAsNamestring[ 1 .. 140 ] characters

debtor.addressobject(PostalAddress)

debtor.contactDetailsobject(ContactDetails)

debtor.countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

debtor.identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)required

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.companyRegistrationstring<= 35 characters

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 characters

Identification of a member of a clearing system.

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.branchobject(BranchIdentification)

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

instructionForCreditorAgentArray of objects(Instruction)>= 0 items

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

Agent(s) between the debtor's agent and the instructing agent.

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

taxobject(TaxInformation)

Response

application/json

{
  "schema": "IdentifierDeterminationResponse",
  "messageIdentifiers": {
    "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
    "creationDateTime": "2022-05-04T03:22:11Z"
  },
  "originalMessageIdentifiers": {
    "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
    "creationDateTime": "2022-05-04T03:02:01Z"
  },
  "report": {
    "originalUetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa",
    "originalVerificationIdentification": "1001",
    "schema": "ZA_RPP",
    "reportInformation": { … },
    "instructedAgent": { … },
    "instructingAgent": { … },
    "originalRequestor": { … }
  },
  "supplementaryData": {
    "customData1": "My custom data 1",
    "customData2": "My custom data 2"
  }
}

funds-management

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

Operations

Schema

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations

Electrum Regulated Payments Partner API (15.2.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

Request identifier information

Request

Responses

Was this page helpful?

Deliver additional identifier information

Request

Responses

Was this page helpful?

Request identifier information synchronously

Request

Responses

Was this page helpful?

funds-management

Schema

bulk

request-to-pay

refund

account-verification

Electrum Regulated Payments Partner API (15.2.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

Request identifier information

RequestExpand all

Responses

Was this page helpful?

Deliver additional identifier information

RequestExpand all

Responses

Was this page helpful?

Request identifier information synchronously

RequestExpand all

Responses

Was this page helpful?

funds-management

Schema

bulk

request-to-pay

refund

account-verification

Request

Request

Request