Electrum Regulated Payments API (17.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

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 this document.
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 the Electrum Regulated Payments Partner API.

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. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.

Download OpenAPI description

elpapi.json

elpapi.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Mock server

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

Payments API sandbox

https://example.com/path/payments/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

Perform a customer direct debit against a scheme

Request

This operation is asynchronous. It is responded to by the outboundDirectDebitResponse operation.

Instructs Electrum to execute an outbound FI-to-FI-customer direct debit transaction that will debit funds from a debtor at another financial institution using the indicated scheme.

Scheme	Applicable
ZA_EFT	✓
ZA_RPP	✗
ZA_RTC	✗
CBPR+	✗

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

messageIdentifiersobject(MessageIdentifiers)required

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

messageIdentifiers.creationDateTimestring(date-time)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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

supplementaryDataobject(SupplementaryData)

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

transactionIdentifiersobject(TransactionIdentifiers)required

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

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

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

transactionIdentifiers.instructionIdentificationstring<= 35 characters

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

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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

transactionIdentifiers.uetrstring(UUID)required

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

amountsobject(TransactionAmounts)required

amounts.bankSettlementAmountobject(Amount)required

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

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

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.instructedAmountobject(Amount)

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

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

creditorAccountobject(PaymentAccount)

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

creditorAgentobject(InstitutionIdentification)required

creditorAgent.additionalIdentificationsArray of objects(AccountIdentification)

creditorAgent.addressobject(PostalAddress)

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.branchobject(BranchIdentification)

creditorAgent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

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.namestring<= 140 characters

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

creditorAgent.companyRegistrationstring<= 35 charactersDeprecated

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

creditorAgent.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

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

debtor.knownAsNamestring[ 1 .. 140 ] characters

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

debtorAccountobject(PaymentAccount)required

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

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

Identification of the currency in which the account is held.

debtorAccount.identificationobject(BankingIdentifier)

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

debtorAccount.proxyobject(NonBankingIdentifier)

debtorAccount.typeobject(AccountType)

debtorAgentobject(InstitutionIdentification)required

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorAgent.addressobject(PostalAddress)

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

debtorAgent.branchobject(BranchIdentification)

debtorAgent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

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.namestring<= 140 characters

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

debtorAgent.companyRegistrationstring<= 35 charactersDeprecated

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

debtorAgent.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

mandateInformationobject(MandateInformation)

Provides details of the direct debit mandate signed between the creditor and the debtor.

NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).

paymentSchemeobject(DirectDebitPaymentScheme)required

Designates which scheme a direct debit is associated with and describes scheme-specific information for the direct debit.

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.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

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

Discriminator

paymentScheme.schemeDataobject(ZaEftSchemeData)required

paymentScheme.schemeData.shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

paymentScheme.schemeData.shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

paymentScheme.schemeData.userReferencestring<= 30 charactersrequired

An explanation of an EFT transaction, which will be printed on the debtor's statement for direct debits or the creditor's statement for credit transfers. Note that when populating a value for a direct debit, the first 10 characters must contain the Banks user code as configured at Bankserv. If configured, Electrum will populate this value automatically, in which case at most 20 characters should be used as a reference to avoid truncation.

paymentTypeInformationobject(PaymentTypeInformation)

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)

requestedCollectionDatestring(date)

Date and time at which the creditor requests that the amount of money is to be collected from the debtor.

schemastringrequired

Value"DirectDebit"

sequenceTypestring(SequenceTypeCode)

Identifies the direct debit sequence:

FRST : First collection of a series of direct debit instructions.
RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.
FNAL : Final collection of a series of direct debit instructions.
OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.
RPRE : Collection used to represent previously reversed or returned direct debit transactions.

Enum"FRST""RCUR""FNAL""OOFF""RPRE"

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.

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/transactions/outbound/direct-debit \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "paymentScheme": {
      "schema": "ZA_EFT",
      "schemeData": {
        "userReference": "REF 1234"
      }
    },
    "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"
          ]
        }
      }
    },
    "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"
          ]
        }
      }
    },
    "paymentTypeInformation": {
      "localInstrument": {
        "schema": "CODE",
        "value": "BTR"
      }
    },
    "sequenceType": "FRST",
    "amounts": {
      "bankSettlementAmount": {
        "value": 1,
        "currency": "ZAR"
      },
      "instructedAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "purpose": {
      "schema": "CODE",
      "value": "BKDF"
    },
    "remittanceInformation": {
      "unstructured": [
        "some",
        "unstructured",
        "information"
      ],
      "structured": [
        {
          "referredDocuments": [
            {
              "type": {
                "value": "CINV",
                "schema": "CODE",
                "issuer": "AmazeBank123456"
              },
              "documentIdentifier": "A0123456789"
            }
          ],
          "referredDocumentAmount": {
            "duePayableAmount": {
              "value": 1,
              "currency": "ZAR"
            },
            "remittedAmount": {
              "value": 1,
              "currency": "ZAR"
            }
          },
          "creditorReference": {
            "type": {
              "value": "RADM",
              "schema": "CODE",
              "issuer": "AnotherAmazeBank1234"
            },
            "reference": "ABC123XYZ999"
          },
          "additionalRemittanceInformation": [
            "Some",
            "Additional",
            "Information"
          ]
        }
      ]
    },
    "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": {
      "identification": {
        "schema": "GENERIC",
        "scheme": {
          "schema": "PROPRIETARY",
          "value": "AProprietaryCode123"
        },
        "issuer": "Amazing Bank",
        "value": "abcdef987654"
      },
      "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"
          ]
        }
      }
    },
    "intermediaryAgents": [
      {
        "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"
            ]
          }
        }
      }
    ],
    "requestedCollectionDate": "2022-05-04",
    "mandateInformation": {
      "mandateIdentification": "A mandate ID",
      "dateOfSignature": "2022-05-04",
      "electronicSignature": "A digital signature",
      "firstCollectionDate": "2022-05-04",
      "finalCollectionDate": "2022-06-04",
      "frequency": {
        "schema": "MonthlyFrequency",
        "dayOfMonth": 4
      },
      "reason": {
        "schema": "CODE",
        "value": "ABCD"
      },
      "trackingDays": 4
    },
    "schema": "DirectDebit",
    "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

Respond to an inbound customer direct debit request

Request

This operation is asynchronous. It starts with the inboundDirectDebit operation

Invoked when a response to an FI-to-FI-customer direct debit is available. The response will indicate the success or failure of the inbound customer direct debit.

Scheme	Applicable
ZA_EFT	✓
ZA_RPP	✗
ZA_RTC	✗
CBPR+	✗

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

messageIdentifiersobject(MessageIdentifiers)required

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

messageIdentifiers.creationDateTimestring(date-time)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

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

originalMessageIdentifiersobject(MessageIdentifiers)required

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

originalMessageIdentifiers.creationDateTimestring(date-time)required

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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

transactionIdentifiersobject(TransactionIdentifiers)required

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

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

transactionIdentifiers.instructionIdentificationstring<= 35 characters

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.

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

statusobject(Status)required

status.outcomestringrequired

APPROVED: The instruction has been approved.
CANCELLED: The instruction has been cancelled.
PENDING: The instruction is pending.
REJECTED: The instruction has been rejected.

Enum"APPROVED""CANCELLED""PENDING""REJECTED"

status.reasonInfoArray of objects(StatusReasonInfo)non-empty

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

originalTransactionDataobject(OriginalTransactionData)

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

paymentSchemeobject(PaymentStatusReportPaymentScheme)required

Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.

paymentScheme.schemastringrequired

Discriminator

schemastringrequired

Value"PaymentStatusReport"

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/transactions/inbound/direct-debit-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "PaymentStatusReport",
    "messageIdentifiers": {
      "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
      "creationDateTime": "2022-05-04T03:22:11Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "paymentScheme": {
      "schema": "ZA_EFT"
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "status": {
      "outcome": "APPROVED",
      "reasonInfo": [
        {
          "reason": {
            "schema": "CODE",
            "value": "ACSC"
          },
          "additionalInformation": "Settlement completed on debtor account"
        }
      ]
    },
    "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
          ]
        }
      }
    },
    "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
          ]
        }
      }
    },
    "originalTransactionData": {
      "paymentMethod": "CreditTransfer",
      "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"
        }
      },
      "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
            ]
          }
        }
      },
      "amounts": {
        "bankSettlementAmount": {
          "value": 1,
          "currency": "ZAR"
        },
        "instructedAmount": {
          "value": 1,
          "currency": "ZAR"
        }
      },
      "remittanceInformation": {
        "unstructured": [
          "some",
          "unstructured",
          "information"
        ],
        "structured": [
          {
            "referredDocuments": [
              {
                "type": {
                  "issuer": "AmazeBank123456",
                  "schema": "CODE",
                  "value": "CINV"
                },
                "documentIdentifier": "A0123456789"
              }
            ],
            "referredDocumentAmount": {
              "duePayableAmount": {
                "value": 1,
                "currency": "ZAR"
              },
              "remittedAmount": {
                "value": 1,
                "currency": "ZAR"
              }
            },
            "creditorReference": {
              "type": {
                "issuer": "AnotherAmazeBank1234",
                "schema": "CODE",
                "value": "RADM"
              },
              "reference": "ABC123XYZ999"
            },
            "additionalRemittanceInformation": [
              "Some",
              "Additional",
              "Information"
            ]
          }
        ]
      },
      "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": {
        "identification": {
          "schema": "GENERIC",
          "scheme": {
            "schema": "PROPRIETARY",
            "value": "AProprietaryCode123"
          },
          "issuer": "Amazing Bank",
          "value": "abcdef987654"
        },
        "type": {
          "schema": "CODE",
          "value": "CACC"
        }
      },
      "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
            ]
          }
        }
      },
      "supplementaryData": {
        "customData1": "My custom data 1",
        "customData2": "My custom data 2"
      },
      "paymentTypeInformation": {
        "localInstrument": {
          "schema": "CODE",
          "value": "BTR"
        }
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

payment-return

Operations related to payment returns.

Operations

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

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

Operations

refund

Operations related to the refund of a prior successful financial transaction.

Operations

Schema

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations

Electrum Regulated Payments API (17.1.0)

transactional

financial

credit-transfer

direct-debit

Perform a customer direct debit against a scheme

Request

Responses

Was this page helpful?

Respond to an inbound customer direct debit request

Request

Responses

Was this page helpful?

payment-return

account-management

proxy

scheme-inquiry

identifier-determination

identifier-verification

request-to-pay

funds-management

refund

Schema

operational

bulk

accounts

account-verification

Electrum Regulated Payments API (17.1.0)

transactional

financial

credit-transfer

direct-debit

Perform a customer direct debit against a scheme

RequestExpand all

Responses

Was this page helpful?

Respond to an inbound customer direct debit request

RequestExpand all

Responses

Was this page helpful?

payment-return

account-management

proxy

scheme-inquiry

identifier-determination

identifier-verification

request-to-pay

funds-management

refund

Schema

operational

bulk

accounts

account-verification

Request

Request