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

funds-management

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

Operations

Schema

bulk

Operations

request-to-pay

Operations

Request a payment to an account

Request

A request from an Industry Participant to credit an account held at the participant.

This request should be shown to the debtor (i.e. the partner's customer). An initial inboundRequestToPayResponse operation must be sent to indicate that the request to pay has been accepted by the partner and to confirm it will be displayed to the debtor.

If the debtor agrees, an outboundCreditTransfer operation may be performed to credit the account i.e. it is not necessary to send another inboundRequestToPayResponse operation to indicate that the debtor has accepted the request to pay. But, if the debtor rejects the request, this must be communicated via an inboundRequestToPayResponse operation.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗

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/transactions/inbound/request-to-pay \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "paymentScheme": {
      "schema": "ZA_RPP"
    },
    "amounts": {
      "bankSettlementAmount": {
        "value": 100,
        "currency": "ZAR"
      }
    },
    "paymentTypeInformation": {
      "localInstrument": {
        "schema": "PROPRIETARY",
        "value": "PBPX"
      }
    },
    "expiryDateTime": "2024-04-09T09:32:51.395+02:00",
    "requestToPayConditions": {
      "minAmount": {
        "value": 100,
        "currency": "ZAR"
      },
      "maxAmount": {
        "value": 100,
        "currency": "ZAR"
      }
    },
    "creditor": {
      "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"
        ]
      },
      "contactDetails": {
        "phoneNumber": "+27-0214620000",
        "mobileNumber": "+27-08230000000",
        "emailAddress": "developer.dave@electrum.com"
      },
      "countryOfResidence": "ZA",
      "identification": {
        "schema": "PERSON",
        "identifiers": [
          {
            "identification": "90001236549870",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            },
            "issuer": "Dept of Home Affairs"
          }
        ]
      }
    },
    "creditorAccount": {
      "identification": {
        "schema": "GENERIC",
        "scheme": {
          "schema": "PROPRIETARY",
          "value": "AProprietaryCode123"
        },
        "issuer": "Amazing Bank",
        "value": "abcdef987654"
      },
      "type": {
        "schema": "CODE",
        "value": "CACC"
      },
      "currency": "ZAR"
    },
    "creditorAgent": {
      "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"
          ]
        }
      }
    },
    "debtor": {
      "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"
        ]
      },
      "contactDetails": {
        "phoneNumber": "+27-0214620000",
        "mobileNumber": "+27-08230000000",
        "emailAddress": "developer.dave@electrum.com"
      },
      "countryOfResidence": "ZA",
      "identification": {
        "schema": "PERSON",
        "identifiers": [
          {
            "identification": "90001236549870",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            },
            "issuer": "Dept of Home Affairs"
          }
        ]
      }
    },
    "debtorAccount": {
      "proxy": {
        "schema": "MOBILE",
        "value": "+27-721234567",
        "namespace": "amazebank"
      },
      "type": {
        "schema": "CODE",
        "value": "CACC"
      },
      "currency": "ZAR"
    },
    "debtorAgent": {
      "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"
          ]
        }
      }
    },
    "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"
          ]
        }
      }
    },
    "remittanceInformation": {
      "unstructured": [
        "some",
        "unstructured",
        "information"
      ],
      "structured": [
        {
          "creditorReference": {
            "reference": "ABC123XYZ999"
          },
          "additionalRemittanceInformation": [
            "Some",
            "Additional",
            "Information"
          ]
        }
      ]
    },
    "schema": "RequestToPay",
    "messageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Response to a prior request to pay or status request

Request

Communicates the status of a prior request to pay initiated by a customer of the partner.

An outboundRequestToPayResponse may indicate that a request to pay, sent to Electrum by the partner on behalf of a partner's customer, will be presented to the debtor, has already been paid or has failed for some reason. A new unsolicited outboundRequestToPayResponse may be received for each status update of the request to pay.

If the partner is unsure of the status of an outboundRequestToPay, an outboundRequestToPayStatusRequest may be used to solicit an up-to-date outboundRequestToPayResponse.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗

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/transactions/outbound/request-to-pay-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "status": {
      "status": "PRESENTED"
    },
    "schema": "RequestToPayResponse",
    "messageIdentifiers": {
      "messageIdentification": "89730ee05e184fb094cf27cec5078d6b",
      "creationDateTime": "2022-05-04T03:02:02Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "requestToPayConditions": {
      "minAmount": {
        "value": 100,
        "currency": "ZAR"
      },
      "maxAmount": {
        "value": 100,
        "currency": "ZAR"
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Cancel a prior request for a payment to an account

Request

A request from an Industry Participant that a prior inboundRequestToPay operation should be cancelled if it's not yet been completed. This does not guarantee a cancellation however as the requested payment may have already been paid or rejected or expired etc. Whether the cancellation was successful or not is communicated via an inboundRequestToPayCancellationResponse operation. If the cancellation was successful, the status will be CANCELLED. Otherwise the status will reflect the current status of the RTP.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗

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

reasonCodestringrequired

The reason the request to pay is being cancelled.

AC03: InvalidCreditorAccountNumber - Wrong account number in Credit Transfer.
AGNT: IncorrectAgent- Agent in the payment workflow is incorrect.
AM09: WrongAmount- Amount is not the amount agreed or expected.
BE16: InvalidDebtorIdentificationCode- Debtor or Ultimate Debtor identification code missing or invalid.
COVR: CoverCancelledOrReturned- Cover payments has either been returned or cancelled.
CURR: IncorrectCurrency- Currency of the payment is incorrect.
CUST: RequestedByCustomer- Cancellation requested by the Creditor.
CUTA: CancelUponUnableToApply- Cancellation requested because an investigation request has been received and no remediation is possible.
DS24: TimeOut- Cancellation requested because the original payment order expired due to time-out.
DT01: InvalidDate- Invalid date (for example, wrong or missing settlement date).
DUPL: DuplicatePayment- Payment is a duplicate of another payment.
FRAD: FraudulentOrigin- Cancellation requested following a transaction that was originated fraudulently. The use of the FraudulentOrigin code should be governed by jurisdictions.
FRNA: ForwardToNextAgent- To complement a rejection response, suggesting the request for cancelation should be forwarded to the next agent in the payment transaction chain.
FRTR: FinalResponse- Direct Debit Tracking recalled as Mandate Cancelled
INDM: IndemnityRequired- To express the wish to establish a bilateral indemnity agreement.
MODT: ModifiedTransaction- The underlying transaction in relation to an RTP was modified.
PAID: TransactionAlreadyPaid- The underlying transaction in relation to an RTP was already paid (via other means).
SVNR: ServiceNotRendered- The payment is cancelled since a cash amount rendered was not correct or goods or a service was not rendered to the customer, e.g. in an e-commerce situation.
SYAD: RequestToSettlementSystemAdministrator- Cancellation requested by System Member to Settlement System Administrator to indicate that the cancellation request must not be forwarded further in the chain.
TECH: TechnicalProblem- Cancellation requested following technical problems resulting in an erroneous transaction.
UPAY: UnduePayment- Payment is not justified.
ENUE: EndUserError- Cancellation or request for return requested by the Debtor specifically due to one or more errors by debtor in the original Credit Transfer. Usage: This code can be used for any error in the original Credit Transfer made by the Debtor. Can also be used if multiple errors were made in the original Credit Transfer.
UAPA: UnauthorizedPayment- "The Debtor is requesting a return of the payment because the payment was not properly authorized. Usage: This code can be used in the case where a Credit Transfer was made without proper authorization from the Debtor. This could be due to compromised end user credentials."
NARR: Narrative- Reason is provided as narrative information in the additional reason information.
AC02: InvalidDebtorAccountNumber- Debtor account number invalid or missing.
BIAS: BatchInstructionAlreadySettled- Process a cancellation request but batch already settled.
INCR: InvalidCancellationRequest- Process a cancellation request with incorrect reference to original batch.
DRTP: DuplicationRequestToPay- Duplication of a request-to-pay message.

Enum"AC03""AGNT""AM09""BE16""COVR""CURR""CUST""CUTA""DS24""DT01"

reasonDescriptionstring

A description of the reason the request to pay is being cancelled.

instructingAgentobject(InstitutionIdentification)

instructedAgentobject(InstitutionIdentification)

originalRequestToPayDataobject(OriginalRequestToPayData)

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

schemastringrequired

Value"RequestToPayCancellation"

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

originalMessageIdentifiersobject(MessageIdentifiers)required

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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

originalTransactionIdentifiersobject(TransactionIdentifiers)required

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

originalTransactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

originalTransactionIdentifiers.transactionIdentificationstring<= 35 characters

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

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/inbound/request-to-pay/cancellation-request \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "reasonCode": "CUST",
    "schema": "RequestToPayCancellation",
    "messageIdentifiers": {
      "messageIdentification": "336b84c5592c3ebfa5553f6e191b6eaa",
      "creationDateTime": "2022-05-04T03:05:10Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "originalTransactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

The outcome of a prior outboundRequestToPayCancellationRequest operation

Request

Communicates the outcome of a prior outboundRequestToPayCancellationRequest operation.

An outboundRequestToPayCancellationRequest operation is not guaranteed to be successful. For example, if the associated outboundRequestToPay has already been paid then it cannot be cancelled.

Note too that if the associated outboundRequestToPay was rejected or has already expired then the outboundRequestToPayCancellationRequest operation will be deemed to have failed despite the net result of no subsequent payment. This is because the final status of the outboundRequestToPay will be something other than a cancellation.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
ZA_RTC	✗

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

statusobject(RequestToPayCancellationStatus)required

status.statusstringrequired

CANCELLED: Cancelled - The cancellation was successfully processed and the request for payment has been cancelled.
REJECTED: Rejected - The cancellation was rejected. Refer to the reasonInfo for further information.

Enum"CANCELLED""REJECTED"

status.reasonInfoArray of objects(RequestToPayCancellationStatusReasonInfo)non-empty

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

instructingAgentobject(InstitutionIdentification)

instructedAgentobject(InstitutionIdentification)

originalRequestToPayDataobject(OriginalRequestToPayData)

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

schemastringrequired

Value"RequestToPayCancellationResponse"