Electrum Regulated Payments API (21.0.2)

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

elpapi-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

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

Retrieve information about an outbound credit transfer

Request

This operation is asynchronous. It is responded to by the outboundCreditTransferResponse operation in the case of an FI-to-FI-customer credit transfer, or the outboundFiToFiCreditTransferResponse operation in the case of an FI-to-FI credit transfer.

A query for information about a previously submitted outbound credit transfer. This operation may be called at any time by the partner in order to query the state of the outbound transfer. If acknowledged by the server, the current status of the transaction will be communicated to the partner via the outboundCreditTransferResponse or outboundFiToFiCreditTransferResponse operation of the Partner API as appropriate.

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.

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

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

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.

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

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

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.

schemastringrequired

Value"CreditTransferStatusRequest"

curl -i -X POST \
  https://example.com/path/payments/api/v1/transactions/outbound/credit-transfer/status-request \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "CreditTransferStatusRequest",
    "messageIdentifiers": {
      "creationDateTime": "2022-05-04T03:01:01Z",
      "messageIdentification": "messageId"
    },
    "originalMessageIdentifiers": {
      "creationDateTime": "2022-05-04T03:02:01Z",
      "messageIdentification": "uniqueMessageId"
    },
    "originalTransactionIdentifiers": {
      "endToEndIdentification": "uniqueEndToEndId",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Request the cancellation of a prior payment instruction

Request

This operation is invoked by the partner to request the cancellation of a prior payment instruction such as a direct-debit or credit-transfer.

This operation is asynchronous. For ZA_AC cancellations of type SYSTEM_ERROR_CORRECTION_REQUEST a successful correction should result in the initiation of a financial payment return.

Otherwise, the result of the payment cancellation is delivered back to the partner by invoking the outboundPaymentCancellationResolution operation which conveys the outcome of payment cancellation request.

Scheme	Applicable
ZA_RPP	✗
ZA_EFT	✓
ZA_RTC	✗
CBPR+	✗
ZA_AC	✓

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.

assignmentobject(CaseAssignment)required

assignment.assigneeany(PartyInstitutionChoice)required

assignment.assignee.institutionobject(InstitutionIdentification)required

assignment.assignee.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignment.assignee.institution.addressobject(PostalAddress)

assignment.assignee.institution.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)

assignment.assignee.institution.branchobject(BranchIdentification)

assignment.assignee.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignment.assignee.institution.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).

assignment.assignee.institution.namestring<= 140 characters

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

assignment.assignee.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assignment.assignee.institution.memberIdstring<= 35 charactersDeprecated

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

assignment.assignee.schemastringrequired

Value"INSTITUTION"

Discriminator

assignment.assignerany(PartyInstitutionChoice)required

assignment.assigner.institutionobject(InstitutionIdentification)required

assignment.assigner.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignment.assigner.institution.addressobject(PostalAddress)

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

assignment.assigner.institution.branchobject(BranchIdentification)

assignment.assigner.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignment.assigner.institution.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).

assignment.assigner.institution.namestring<= 140 characters

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

assignment.assigner.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assignment.assigner.institution.memberIdstring<= 35 charactersDeprecated

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

assignment.assigner.schemastringrequired

Value"INSTITUTION"

Discriminator

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

assignment.identificationstring<= 35 charactersrequired

Uniquely identifies a case assignment

caseobject(Case6)

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.instructionIdentificationstring<= 35 characters

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.

paymentSchemeobject(FiToFiPaymentCancellationPaymentScheme)required

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

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.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"

Discriminator

paymentScheme.schemeDataobject(ZaAcFiToFiPaymentCancellationPaymentSchemeData)required

paymentScheme.schemeData.cancellationTypestringrequired

Identifies the specific business process applicable to the cancellation request.

RECALL: A request to revoke a payment instruction that has not yet settled or is currently in tracking. If successful, the instruction is cancelled without financial movement (no settlement occurs). If the partner makes use of Electrum's collections capabilities, this type is only expected for outbound use.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents the case where a bank has experienced a technical issue that resulted in settled debit collections being processed incorrectly (e.g., a batch of debits was duplicated), and the industry bank is requesting that the partner bank correct the error.
A successful correction means the partner bank initiates a financial Payment Return to recover the funds from the industry bank in order to refund the debtor.
This case is notably different from standard recalls and disputes in that: (1) This strictly requires prior industry/PASA authorisation to invoke, (2) it may be rejected by the partner bank if the correction cannot be applied (e.g., original transaction not found, or the transaction was already reversed via a customer dispute), (3) partial reversals are not permitted, and (4) the bank from industry is limited to exactly 2 (two) retry attempts for the same transaction if an earlier request was rejected.

Enum"RECALL""SYSTEM_ERROR_CORRECTION_REQUEST"

schemastringrequired

Value"FiToFiPaymentCancellationRequest"

underlyingTransactionobject(UnderlyingTransaction)required

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

underlyingTransaction.amountsobject(TransactionAmounts)

underlyingTransaction.creditorAccountobject(PaymentAccount)

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

underlyingTransaction.creditorAgentobject(InstitutionIdentification)

underlyingTransaction.creditorAgentAccountobject(PaymentAccount)

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

underlyingTransaction.debtorAccountobject(PaymentAccount)

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

underlyingTransaction.debtorAgentobject(InstitutionIdentification)

underlyingTransaction.debtorAgentAccountobject(PaymentAccount)

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

underlyingTransaction.paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

underlyingTransaction.paymentTypeInformationobject(PaymentTypeInformation)

underlyingTransaction.purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

underlyingTransaction.remittanceInformationobject(RemittanceInformation)

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

underlyingTransaction.supplementaryDataobject(SupplementaryData)

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

underlyingTransaction.creditorany(PartyInstitutionChoice)

underlyingTransaction.debtorany(PartyInstitutionChoice)

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

underlyingTransaction.cancellationIdstring<= 35 characters

underlyingTransaction.cancellationReasonInfoArray of objects(CancellationReasonInfo)

Reason information for the cancellation

curl -i -X POST \
  https://example.com/path/payments/api/v1/transactions/outbound/payment-cancellation \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "messageIdentifiers": {
      "creationDateTime": "2019-08-24T14:15:22Z",
      "messageIdentification": "string"
    },
    "supplementaryData": {
      "property1": "string",
      "property2": "string"
    },
    "assignment": {
      "assignee": {
        "party": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "contactDetails": {
            "emailAddress": "user@example.com",
            "mobileNumber": "string",
            "phoneNumber": "string"
          },
          "countryOfResidence": "string",
          "identification": {
            "identifiers": [
              {
                "identification": "string",
                "issuer": "string",
                "scheme": {}
              }
            ],
            "schema": "string"
          },
          "knownAsName": "string",
          "legalName": "string"
        },
        "schema": "PARTY"
      },
      "assigner": {
        "party": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "contactDetails": {
            "emailAddress": "user@example.com",
            "mobileNumber": "string",
            "phoneNumber": "string"
          },
          "countryOfResidence": "string",
          "identification": {
            "identifiers": [
              {
                "identification": "string",
                "issuer": "string",
                "scheme": {}
              }
            ],
            "schema": "string"
          },
          "knownAsName": "string",
          "legalName": "string"
        },
        "schema": "PARTY"
      },
      "creationDateTime": "2019-08-24T14:15:22Z",
      "identification": "string"
    },
    "case": {
      "creator": {
        "party": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "contactDetails": {
            "emailAddress": "user@example.com",
            "mobileNumber": "string",
            "phoneNumber": "string"
          },
          "countryOfResidence": "string",
          "identification": {
            "identifiers": [
              {
                "identification": "string",
                "issuer": "string",
                "scheme": {}
              }
            ],
            "schema": "string"
          },
          "knownAsName": "string",
          "legalName": "string"
        },
        "schema": "PARTY"
      },
      "identification": "string",
      "reopenCaseIndication": true
    },
    "originalTransactionIdentifiers": {
      "endToEndIdentification": "string",
      "instructionIdentification": "string",
      "transactionIdentification": "string",
      "uetr": "string"
    },
    "paymentScheme": {
      "schema": "ZA_RTC",
      "schemeData": {
        "cancellationType": "SYSTEM_ERROR_CORRECTION_REQUEST"
      }
    },
    "schema": "FiToFiPaymentCancellationRequest",
    "underlyingTransaction": {
      "amounts": {
        "bankSettlementAmount": {
          "currency": "string",
          "value": 0.1
        },
        "instructedAmount": {
          "currency": "string",
          "value": 0.1
        }
      },
      "creditorAccount": {
        "currency": "string",
        "identification": {
          "schema": "string",
          "value": "string"
        },
        "name": "string",
        "proxy": {
          "namespace": "string",
          "schema": "string"
        },
        "type": {
          "schema": "string",
          "value": "CACC"
        }
      },
      "creditorAgent": {
        "additionalIdentifications": [
          {
            "accountKnownAs": "string",
            "identifier": {
              "schema": "string",
              "value": "string"
            },
            "registeredSchemes": [
              "ZA_RTC"
            ]
          }
        ],
        "address": {
          "addressLine": [
            "string"
          ],
          "addressType": "ADDR",
          "buildingName": "string",
          "buildingNumber": "string",
          "country": "string",
          "countrySubDivision": "string",
          "department": "string",
          "districtName": "string",
          "floor": "string",
          "postBox": "string",
          "postCode": "string",
          "room": "string",
          "streetName": "string",
          "subDepartment": "string",
          "townLocationName": "string",
          "townName": "string"
        },
        "bicfi": "string",
        "branch": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "identification": "string",
          "name": "string"
        },
        "clearingSystemMemberId": {
          "clearingSystem": {
            "schema": "string",
            "value": "MA"
          },
          "memberId": "string"
        },
        "companyRegistration": "string",
        "lei": "string",
        "memberId": "string",
        "name": "string"
      },
      "creditorAgentAccount": {
        "currency": "string",
        "identification": {
          "schema": "string",
          "value": "string"
        },
        "name": "string",
        "proxy": {
          "namespace": "string",
          "schema": "string"
        },
        "type": {
          "schema": "string",
          "value": "CACC"
        }
      },
      "debtorAccount": {
        "currency": "string",
        "identification": {
          "schema": "string",
          "value": "string"
        },
        "name": "string",
        "proxy": {
          "namespace": "string",
          "schema": "string"
        },
        "type": {
          "schema": "string",
          "value": "CACC"
        }
      },
      "debtorAgent": {
        "additionalIdentifications": [
          {
            "accountKnownAs": "string",
            "identifier": {
              "schema": "string",
              "value": "string"
            },
            "registeredSchemes": [
              "ZA_RTC"
            ]
          }
        ],
        "address": {
          "addressLine": [
            "string"
          ],
          "addressType": "ADDR",
          "buildingName": "string",
          "buildingNumber": "string",
          "country": "string",
          "countrySubDivision": "string",
          "department": "string",
          "districtName": "string",
          "floor": "string",
          "postBox": "string",
          "postCode": "string",
          "room": "string",
          "streetName": "string",
          "subDepartment": "string",
          "townLocationName": "string",
          "townName": "string"
        },
        "bicfi": "string",
        "branch": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "identification": "string",
          "name": "string"
        },
        "clearingSystemMemberId": {
          "clearingSystem": {
            "schema": "string",
            "value": "MA"
          },
          "memberId": "string"
        },
        "companyRegistration": "string",
        "lei": "string",
        "memberId": "string",
        "name": "string"
      },
      "debtorAgentAccount": {
        "currency": "string",
        "identification": {
          "schema": "string",
          "value": "string"
        },
        "name": "string",
        "proxy": {
          "namespace": "string",
          "schema": "string"
        },
        "type": {
          "schema": "string",
          "value": "CACC"
        }
      },
      "paymentMethod": "CreditTransfer",
      "paymentTypeInformation": {
        "categoryPurpose": {
          "schema": "string",
          "value": "BONU"
        },
        "localInstrument": {
          "schema": "string",
          "value": "0000"
        },
        "serviceLevel": [
          {
            "schema": "string",
            "value": "BKTR"
          }
        ]
      },
      "purpose": {
        "schema": "string",
        "value": "BKDF"
      },
      "remittanceInformation": {
        "structured": [
          {
            "additionalRemittanceInformation": [
              "string"
            ],
            "creditorReference": {
              "reference": "string",
              "type": {
                "issuer": "string",
                "schema": "CODE"
              }
            },
            "invoicer": {
              "address": {
                "addressLine": [
                  null
                ],
                "addressType": "ADDR",
                "buildingName": "string",
                "buildingNumber": "string",
                "country": "string",
                "countrySubDivision": "string",
                "department": "string",
                "districtName": "string",
                "floor": "string",
                "postBox": "string",
                "postCode": "string",
                "room": "string",
                "streetName": "string",
                "subDepartment": "string",
                "townLocationName": "string",
                "townName": "string"
              },
              "contactDetails": {
                "emailAddress": "user@example.com",
                "mobileNumber": "string",
                "phoneNumber": "string"
              },
              "countryOfResidence": "string",
              "identification": {
                "identifiers": [
                  null
                ],
                "schema": "string"
              },
              "knownAsName": "string",
              "legalName": "string"
            },
            "originatorReference": "string",
            "referredDocumentAmount": {
              "duePayableAmount": {
                "currency": "string",
                "value": 0.1
              },
              "remittedAmount": {
                "currency": "string",
                "value": 0.1
              }
            },
            "referredDocuments": [
              {
                "documentIdentifier": "string",
                "relatedDate": "2019-08-24",
                "type": {}
              }
            ],
            "taxRemittance": {
              "creditor": {
                "registrationIdentification": "string",
                "taxIdentification": "string",
                "taxType": "string"
              },
              "date": "2019-08-24",
              "debtor": {
                "registrationIdentification": "string",
                "taxIdentification": "string",
                "taxType": "string",
                "authorisation": {}
              },
              "referenceNumber": "string",
              "sequenceNumber": 0,
              "totalTaxAmount": {
                "currency": "string",
                "value": 0.1
              },
              "totalTaxableBaseAmount": {
                "currency": "string",
                "value": 0.1
              },
              "ultimateDebtor": {
                "registrationIdentification": "string",
                "taxIdentification": "string",
                "taxType": "string",
                "authorisation": {}
              }
            }
          }
        ],
        "unstructured": [
          "string"
        ]
      },
      "settlementDate": "2019-08-24",
      "supplementaryData": {
        "property1": "string",
        "property2": "string"
      },
      "creditor": {
        "party": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "contactDetails": {
            "emailAddress": "user@example.com",
            "mobileNumber": "string",
            "phoneNumber": "string"
          },
          "countryOfResidence": "string",
          "identification": {
            "identifiers": [
              {
                "identification": "string",
                "issuer": "string",
                "scheme": {}
              }
            ],
            "schema": "string"
          },
          "knownAsName": "string",
          "legalName": "string"
        },
        "schema": "PARTY"
      },
      "debtor": {
        "party": {
          "address": {
            "addressLine": [
              "string"
            ],
            "addressType": "ADDR",
            "buildingName": "string",
            "buildingNumber": "string",
            "country": "string",
            "countrySubDivision": "string",
            "department": "string",
            "districtName": "string",
            "floor": "string",
            "postBox": "string",
            "postCode": "string",
            "room": "string",
            "streetName": "string",
            "subDepartment": "string",
            "townLocationName": "string",
            "townName": "string"
          },
          "contactDetails": {
            "emailAddress": "user@example.com",
            "mobileNumber": "string",
            "phoneNumber": "string"
          },
          "countryOfResidence": "string",
          "identification": {
            "identifiers": [
              {
                "identification": "string",
                "issuer": "string",
                "scheme": {}
              }
            ],
            "schema": "string"
          },
          "knownAsName": "string",
          "legalName": "string"
        },
        "schema": "PARTY"
      },
      "mandateInformation": {
        "dateOfSignature": "2019-08-24",
        "electronicSignature": "string",
        "finalCollectionDate": "2019-08-24",
        "firstCollectionDate": "2019-08-24",
        "frequency": {
          "dayOfMonth": 1,
          "schema": "MonthlyFrequency"
        },
        "mandateIdentification": "string",
        "reason": {
          "schema": "string",
          "value": "stri"
        },
        "trackingDays": 1
      },
      "cancellationId": "string",
      "cancellationReasonInfo": [
        {
          "additionalInformation": [
            "string"
          ],
          "originator": {
            "address": {
              "addressLine": [
                "string"
              ],
              "addressType": "ADDR",
              "buildingName": "string",
              "buildingNumber": "string",
              "country": "string",
              "countrySubDivision": "string",
              "department": "string",
              "districtName": "string",
              "floor": "string",
              "postBox": "string",
              "postCode": "string",
              "room": "string",
              "streetName": "string",
              "subDepartment": "string",
              "townLocationName": "string",
              "townName": "string"
            },
            "contactDetails": {
              "emailAddress": "user@example.com",
              "mobileNumber": "string",
              "phoneNumber": "string"
            },
            "countryOfResidence": "string",
            "identification": {
              "identifiers": [
                {}
              ],
              "schema": "string"
            },
            "knownAsName": "string",
            "legalName": "string"
          },
          "reason": {
            "schema": "string",
            "value": "AC02"
          }
        }
      ]
    }
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Retrieve information about an outbound bulk credit transfer initiation

Request

This operation is asynchronous. It is responded to by the [outboundBulkCreditTransferResponse operation] (https://docs.electrumsoftware.com/openapi/elpapi-cicd/elpapi-partner-redoc/bulk/outboundbulkcredittransferresponse).

A query for information about a previously submitted outbound bulk credit transfer initiation. This operation may be called at any time by the partner in order to query the state of the outbound request. If acknowledged by the server, the current status of the 'bulk' will be communicated to the partner via the outboundBulkCreditTransferResponse operation of the Partner API.

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.

includeIndividualCreditsStatusesboolean

A flag to indicate if the status of each individual credit transfer, as per Electrum's view, should be reflected in the response

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

paymentInformationIdstring(UUID)required

Universally unique identifier to provide an end-to-end reference to the bulk initiation. This identifier remains the same for all messages related to the bulk transaction. Note: this is distinct from the UETR's of the individual transactions.

schemastringrequired

Value"CreditTransferInitiationStatusRequest"

curl -i -X POST \
  https://example.com/path/payments/api/v1/transactions/outbound/bulk/credit-transfer/status-request \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "CreditTransferInitiationStatusRequest",
    "messageIdentifiers": {
      "creationDateTime": "2024-05-04T03:03:01Z",
      "messageIdentification": "messageId"
    },
    "originalMessageIdentifiers": {
      "creationDateTime": "2024-05-04T03:02:01Z",
      "messageIdentification": "uniqueMessageId"
    },
    "paymentInformationId": "uniqueUUID",
    "includeIndividualCreditsStatuses": false
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

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

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

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

Schema

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations

Electrum Regulated Payments API (21.0.2)

transactional

Retrieve information about an outbound credit transfer

Request

Responses

Was this page helpful?

Request the cancellation of a prior payment instruction

Request

Responses

Was this page helpful?

Retrieve information about an outbound bulk credit transfer initiation

Request

Responses

Was this page helpful?

financial

credit-transfer

direct-debit

payment-return

account-management

proxy

scheme-inquiry

identifier-determination

identifier-verification

request-to-pay

funds-management

refund

risk-assessment

fraud-assessment

Schema

operational

bulk

accounts

account-verification

Electrum Regulated Payments API (21.0.2)

transactional

Retrieve information about an outbound credit transfer

RequestExpand all

Responses

Was this page helpful?

Request the cancellation of a prior payment instruction

RequestExpand all

Responses

Was this page helpful?

Retrieve information about an outbound bulk credit transfer initiation

RequestExpand all

Responses

Was this page helpful?

financial

credit-transfer

direct-debit

payment-return

account-management

proxy

scheme-inquiry

identifier-determination

identifier-verification

request-to-pay

funds-management

refund

risk-assessment

fraud-assessment

Schema

operational

bulk

accounts

account-verification

Request

Request

Request