Electrum Regulated Payments Partner API (17.1.0)

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

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

Download OpenAPI description

elpapi-partner.json

elpapi-partner.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

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

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

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

Operations

Schema

operational

Operations

bulk

Operations

Receive the response to an outbound bulk credit transfer request

Request

This operation is asynchronous. It starts with the outboundBulkCreditTransfer operation

Invoked when a response to an outbound bulk credit transfer is available. The response will indicate the success or failure of the outbound bulk credit transfer.

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

controlSumobject(Amount)

creditorAgentobject(InstitutionIdentification)

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

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)

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.

numberOfTransactionsinteger

Number of individual credit transfer instructions within the bulk that should be initiated.

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

paymentInitiationStatusobject(InitiationStatus)required

paymentInitiationStatus.outcomestringrequired

RECEIVED: The bulk initiation has been received.
PENDING: The bulk initiation is undergoing pre-checks.
ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.
COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.
REJECTED: The bulk initiation has been rejected.

Enum"RECEIVED""PENDING""ACCEPTED""COMPLETED""REJECTED"

paymentInitiationStatus.reasonInfoArray of objects(StatusReasonInfo)non-empty

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

paymentInstructionStatusReportsArray of objects(PaymentInstructionStatusReport)

List of payment status reports relating to each credit initiation instruction received and actioned

paymentSchemeNamestring(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"

schemastringrequired

Value"PaymentInitiationStatusReport"

transactionStatisticsobject(TransactionStatistics)required

A detailed breakdown of the number of transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

transactionStatistics.numberOfApprovedTransactionsintegerrequired

Count of transactions with the APPROVED status.

transactionStatistics.numberOfCancelledTransactionsintegerrequired

Count of transactions with the CANCELLED status.

transactionStatistics.numberOfPendingTransactionsintegerrequired

Count of transactions with the PENDING status.

transactionStatistics.numberOfRejectedTransactionsintegerrequired

Count of transactions with the REJECTED status.

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/outbound/bulk/credit-transfer-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "PaymentInitiationStatusReport",
    "paymentInformationId": "uniqueUUID",
    "messageIdentifiers": {
      "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
      "creationDateTime": "2024-05-04T03:22:11Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2024-05-04T03:02:01Z"
    },
    "paymentSchemeName": "ZA_RPP",
    "paymentInitiationStatus": {
      "outcome": "COMPLETED",
      "reasonInfo": [
        {
          "reason": {
            "schema": "CODE",
            "value": "ACSC"
          },
          "additionalInformation": "Settlement completed on debtor account"
        }
      ]
    },
    "transactionStatistics": {
      "numberOfApprovedTransactions": 2,
      "numberOfPendingTransactions": 0,
      "numberOfCancelledTransactions": 0,
      "numberOfRejectedTransactions": 0
    },
    "numberOfTransactions": 2,
    "controlSum": {
      "amount": {
        "value": 200,
        "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"
          ]
        }
      }
    },
    "paymentInstructionStatusReports": [
      {
        "transactionIdentifiers": {
          "endToEndIdentification": "6249118655591098",
          "transactionIdentification": "RRN000000001",
          "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
        },
        "paymentScheme": {
          "schema": "ZA_RPP"
        },
        "status": {
          "outcome": "APPROVED",
          "reasonInfo": [
            {
              "reason": {
                "schema": "CODE",
                "value": "ACSC"
              },
              "additionalInformation": "Settlement completed on debtor account"
            }
          ]
        },
        "originalTransactionData": {
          "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"
            },
            "proxy": {
              "namespace": "NeoBank",
              "schema": "MOBILE",
              "value": "+27-0214620000"
            },
            "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": 100,
              "currency": "ZAR"
            },
            "instructedAmount": {
              "value": 100,
              "currency": "ZAR"
            }
          },
          "remittanceInformation": {
            "unstructured": [
              "some",
              "unstructured",
              "information"
            ],
            "structured": [
              {
                "referredDocuments": [
                  {
                    "type": {
                      "issuer": "AmazeBank123456",
                      "schema": "CODE",
                      "value": "CINV"
                    },
                    "documentIdentifier": "A0123456789"
                  }
                ],
                "referredDocumentAmount": {
                  "duePayableAmount": {
                    "value": 100,
                    "currency": "ZAR"
                  },
                  "remittedAmount": {
                    "value": 100,
                    "currency": "ZAR"
                  }
                },
                "creditorReference": {
                  "type": {
                    "issuer": "AnotherAmazeBank1234",
                    "schema": "CODE",
                    "value": "RADM"
                  },
                  "reference": "ABC123XYZ999"
                },
                "additionalRemittanceInformation": [
                  "Some",
                  "Additional",
                  "Information"
                ]
              }
            ]
          }
        }
      },
      {
        "transactionIdentifiers": {
          "endToEndIdentification": "1234118655591098",
          "transactionIdentification": "RRN000000002",
          "uetr": "a65a34ad-c5ab-4b70-a3f9-946d743eaeaa"
        },
        "paymentScheme": {
          "schema": "ZA_RPP"
        },
        "status": {
          "outcome": "APPROVED",
          "reasonInfo": [
            {
              "reason": {
                "schema": "CODE",
                "value": "ACSC"
              },
              "additionalInformation": "Settlement completed on debtor account"
            }
          ]
        },
        "originalTransactionData": {
          "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"
            },
            "proxy": {
              "namespace": "NeoBank",
              "schema": "MOBILE",
              "value": "+27-0214620000"
            },
            "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": 100,
              "currency": "ZAR"
            },
            "instructedAmount": {
              "value": 100,
              "currency": "ZAR"
            }
          },
          "remittanceInformation": {
            "unstructured": [
              "some",
              "unstructured",
              "information"
            ],
            "structured": [
              {
                "referredDocuments": [
                  {
                    "type": {
                      "issuer": "AmazeBank123456",
                      "schema": "CODE",
                      "value": "CINV"
                    },
                    "documentIdentifier": "A0123456789"
                  }
                ],
                "referredDocumentAmount": {
                  "duePayableAmount": {
                    "value": 100,
                    "currency": "ZAR"
                  },
                  "remittedAmount": {
                    "value": 100,
                    "currency": "ZAR"
                  }
                },
                "creditorReference": {
                  "type": {
                    "issuer": "AnotherAmazeBank1234",
                    "schema": "CODE",
                    "value": "RADM"
                  },
                  "reference": "ABC123XYZ999"
                },
                "additionalRemittanceInformation": [
                  "Some",
                  "Additional",
                  "Information"
                ]
              }
            ]
          }
        }
      }
    ]
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

Receive the response to an outbound bulk request to pay

Request

This operation is asynchronous. It starts with the outboundBulkRequestToPay operation orgetOutboundBulkRequestToPayStatus operation

Communicates the bulk status of a prior bulk request to pay.

An outboundBulkRequestToPayResponse contains the information indicating the state of the bulk as a whole and the status of the individual request to pay transactions

If the partner is unsure of the status of an outboundBulkRequestToPay, an getOutboundBulkRequestToPayStatus may be used to solicit an up-to-date outboundBulkRequestToPayResponse.

Scheme	Applicable
ZA_RPP	✓
ZA_EFT	✗
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

bulkPaymentSchemeNamestring(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"

numberOfTransactionsinteger>= 1

The total amount of transactions in the bulk.

requestToPayInformationIdstring(UUID)required

Universally unique identifier to identify the bulk collection itself.

requestToPayInitiationStatusobject(InitiationStatus)required

requestToPayInitiationStatus.outcomestringrequired

RECEIVED: The bulk initiation has been received.
PENDING: The bulk initiation is undergoing pre-checks.
ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.
COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.
REJECTED: The bulk initiation has been rejected.

Enum"RECEIVED""PENDING""ACCEPTED""COMPLETED""REJECTED"

requestToPayInitiationStatus.reasonInfoArray of objects(StatusReasonInfo)non-empty

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

requestToPayInstructionStatusReportsArray of objects(RequestToPayInstructionStatusReport)>= 0 items

List of RequestToPayInstructionStatusReports relating to each request to pay initiation instruction received and actioned. Unsubmitted transactions will not be in this list.

schemastringrequired

Value"RequestToPayInitiationStatusRequest"

transactionStatisticsobject(RequestToPayTransactionStatistics)required

A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

transactionStatistics.numberOfAcceptedTransactionsintegerrequired

Count of transactions with the ACCEPTED status.

transactionStatistics.numberOfCancelledTransactionsintegerrequired

Count of transactions with the CANCELLED status.

transactionStatistics.numberOfExpiredTransactionsintegerrequired

Count of transactions with the EXPIRED status.

transactionStatistics.numberOfPaidTransactionsintegerrequired

Count of transactions with the PAID status.

transactionStatistics.numberOfPendingTransactionsintegerrequired

Count of transactions with the PENDING status.

transactionStatistics.numberOfPresentedTransactionsintegerrequired

Count of transactions with the PRESENT status.

transactionStatistics.numberOfRejectedTransactionsintegerrequired

Count of transactions with the REJECTED status.

transactionStatistics.numberOfUnsubmittedTransactionsintegerrequired

number of transactions not yet sent to industry, and thus do not yet have an official RTP state.

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/outbound/bulk/request-to-pay-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "RequestToPayInitiationResponse",
    "requestToPayInformationId": "6e831b77-3e51-4a0e-a818-dc99a08f80d4",
    "messageIdentifiers": {
      "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
      "creationDateTime": "2024-05-04T03:22:11Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2024-05-04T03:02:01Z"
    },
    "bulkPaymentSchemeName": "ZA_RPP",
    "requestToPayInitiationStatus": {
      "outcome": "COMPLETED",
      "reasonInfo": [
        {
          "reason": {
            "schema": "CODE",
            "value": "ACSC"
          },
          "additionalInformation": "Settlement completed on debtor account"
        }
      ]
    },
    "transactionStatistics": {
      "numberOfPaidTransactions": 2,
      "numberOfAcceptedTransactions": 2,
      "numberOfCancelledTransactions": 0,
      "numberOfExpiredTransactions": 0,
      "numberOfPendingTransactions": 0,
      "numberOfPresentedTransactions": 0,
      "numberOfRejectedTransactions": 0,
      "numberOfUnsubmittedTransactions": 0
    },
    "numberOfTransactions": 2,
    "requestToPayInstructionStatusReports": [
      {
        "status": {
          "status": "CANCELLED",
          "reasonInfo": [
            {
              "reason": {
                "schema": "CODE",
                "value": "CUST"
              },
              "additionalInformation": "Cancellation requested by the Creditor"
            }
          ]
        },
        "originalRequestToPayData": {
          "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"
                ]
              }
            }
          },
          "amounts": {
            "bankSettlementAmount": {
              "value": 100,
              "currency": "ZAR"
            }
          },
          "remittanceInformation": {
            "unstructured": [
              "some",
              "unstructured",
              "information"
            ],
            "structured": [
              {
                "creditorReference": {
                  "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"
            },
            "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"
                ]
              }
            }
          },
          "expiryDateTime": "2024-04-09T09:32:51.395+02:00",
          "paymentTypeInformation": {
            "localInstrument": {
              "schema": "PROPRIETARY",
              "value": "PBPX"
            }
          }
        },
        "transactionIdentifiers": {
          "endToEndIdentification": "6249118655591098",
          "transactionIdentification": "RRN000000001",
          "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
        }
      }
    ]
  }'

Responses

Accepted. RFC9110 - 202

Response

No content

request-to-pay

Operations

refund

Operations

account-verification

Operations

Electrum Regulated Payments Partner API (17.1.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

Schema

operational

bulk

Receive the response to an outbound bulk credit transfer request

Request

Responses

Was this page helpful?

Receive the response to an outbound bulk request to pay

Request

Responses

Was this page helpful?

request-to-pay

refund

account-verification

Electrum Regulated Payments Partner API (17.1.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

Schema

operational

bulk

Receive the response to an outbound bulk credit transfer request

RequestExpand all

Responses

Was this page helpful?

Receive the response to an outbound bulk request to pay

RequestExpand all

Responses

Was this page helpful?

request-to-pay

refund

account-verification

Request

Request