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

Languages
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

Receive the response to an outbound customer credit transfer request

Request

This operation is asynchronous. It starts with the outboundCreditTransfer operation

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

SchemeApplicable
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

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.

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.

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-partner/transactions/outbound/credit-transfer-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_RTC",
      "schemeData": {
        "beneficiaryEchoData": "Ab1 xxxxxxxxxxxxxxxx",
        "authorisationId": "Ab1 xx"
      },
      "originalSchemeData": {
        "userReference": "Ab1 xxxxxxxxxxxxxxxx",
        "originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
        "businessReference": "11Ab1xxxxx"
      }
    },
    "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": {
      "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"
            ]
          }
        }
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response
No content

Receive the response to an outbound FI-to-FI credit transfer request

Request

This operation is asynchronous. It starts with the outboundFiToFiCreditTransfer operation or getOutboundCreditTransferStatus operation.

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

See the outboundCreditTransferResponse operation for responses to outbound FI-to-FI-customer credit transfers.

SchemeApplicable
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

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.

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.

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(FiToFiOriginalTransactionData)

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

paymentSchemeobject(FiToFiPaymentStatusReportPaymentScheme)required

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

paymentScheme.​schemastringrequired
Discriminator
schemastringrequired
Value"FiToFiPaymentStatusReport"
curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/outbound/fi-to-fi-credit-transfer-response \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "FiToFiPaymentStatusReport",
    "messageIdentifiers": {
      "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
      "creationDateTime": "2022-05-04T03:22:11Z"
    },
    "originalMessageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "paymentScheme": {
      "schema": "CBPR_PLUS"
    },
    "transactionIdentifiers": {
      "instructionIdentification": "a1db-0181ab0897d2",
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "status": {
      "outcome": "PENDING",
      "reasonInfo": [
        {
          "reason": {
            "schema": "CODE",
            "value": "ACSP"
          },
          "additionalInformation": "Accepted settlement in process"
        }
      ]
    },
    "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": {
        "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
            ]
          }
        }
      },
      "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": {
        "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
            ]
          }
        }
      },
      "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"
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response
No content

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.

SchemeApplicable
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

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.

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

Perform an inbound customer credit transfer

Request

This operation is asynchronous. It is responded to by invoking the inboundCreditTransferResponse operation.

The inbound customer credit transfer operation is called when a credit transfer to one of your account holders is received. This event must be followed by a call to the inboundCreditTransferResponse operation to indicate whether the credit payment was actioned or not. Note that the payment is expected to have immediate financial impact if approved; there is no completion leg such as for credit transfers carried out via the inboundCreditTransferAuthorisation operation.

This operation must be idempotent, i.e. no action should be taken if the operation is received more than once with an identical request body. This allows Electrum to retry the request if the initial request fails. An identical HTTP response is expected to be returned for each retry.

Note: | This operation differs from the inboundCreditTransferAuthorisation operation as this operation has immediate | financial impact and does not include a completion leg.

SchemeApplicable
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 CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.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)required

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

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

Identification of the currency in which the account is held.

creditorAccount.​identificationobject(BankingIdentifier)
creditorAccount.​namestring<= 70 characters

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

creditorAccount.​proxyobject(NonBankingIdentifier)
creditorAccount.​typeobject(AccountType)
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

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.

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)

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

debtorAgentobject(InstitutionIdentification)required
debtorAgent.​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.

instructedAgentobject(InstitutionIdentification)
instructingAgentobject(InstitutionIdentification)
instructionForCreditorAgentArray of objects(CreditorAgentInstruction)>= 0 items

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

paymentSchemeobject(CreditTransferPaymentScheme)required

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

paymentScheme.​schemastringrequired
Discriminator
paymentScheme.​schemeDataobject(CbprPlusCustomerCreditSchemeData)required

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

paymentScheme.​schemeData.​chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
paymentScheme.​schemeData.​chargesArray of objects(Charge)
paymentScheme.​schemeData.​exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

paymentScheme.​schemeData.​regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
paymentTypeInformationobject(PaymentTypeInformation)
previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

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

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)
schemastringrequired
Value"CreditTransfer"
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.

taxobject(TaxInformation)
curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/inbound/credit-transfer \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "paymentScheme": {
      "schema": "ZA_EFT",
      "schemeData": {
        "userReference": "REF 1234"
      }
    },
    "amounts": {
      "bankSettlementAmount": {
        "value": 1,
        "currency": "ZAR"
      },
      "instructedAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "paymentTypeInformation": {
      "localInstrument": {
        "schema": "CODE",
        "value": "BTR"
      }
    },
    "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"
          ]
        }
      }
    },
    "instructedAgent": {
      "bicfi": "RY8PEG0L",
      "memberId": "AmazingBankId",
      "name": "Amazing Bank Inc",
      "branch": {
        "identification": "210514",
        "name": "ABC Plettenberg Bay",
        "address": {
          "addressType": "ADDR",
          "department": "Department of Mysteries",
          "streetName": "Street of Mysteries",
          "buildingNumber": "42",
          "buildingName": "Mysterious Building",
          "floor": "42",
          "postBox": "1024",
          "postCode": "4242",
          "townName": "Mysty Town",
          "townLocationName": "Mysty Location",
          "districtName": "Mysty District",
          "countrySubDivision": "Mysterious Cape",
          "country": "ZA",
          "addressLine": [
            "16A",
            "New market street",
            "Foreshore",
            "Cape Town",
            "ZA",
            "8001"
          ]
        }
      }
    },
    "instructingAgent": {
      "bicfi": "RY8PEG0L",
      "memberId": "AmazingBankId",
      "name": "Amazing Bank Inc",
      "branch": {
        "identification": "210514",
        "name": "ABC Plettenberg Bay",
        "address": {
          "addressType": "ADDR",
          "department": "Department of Mysteries",
          "streetName": "Street of Mysteries",
          "buildingNumber": "42",
          "buildingName": "Mysterious Building",
          "floor": "42",
          "postBox": "1024",
          "postCode": "4242",
          "townName": "Mysty Town",
          "townLocationName": "Mysty Location",
          "districtName": "Mysty District",
          "countrySubDivision": "Mysterious Cape",
          "country": "ZA",
          "addressLine": [
            "16A",
            "New market street",
            "Foreshore",
            "Cape Town",
            "ZA",
            "8001"
          ]
        }
      }
    },
    "instructionForCreditorAgent": [
      {
        "code": "TELB",
        "information": "Please email example@example.com"
      }
    ],
    "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"
            ]
          }
        }
      }
    ],
    "previousInstructingAgents": [
      {
        "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"
            ]
          }
        }
      }
    ],
    "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"
          ]
        }
      ]
    },
    "tax": {
      "totalAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "schema": "CreditTransfer",
    "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

Authorise an inbound customer credit transfer

Request

This operation is asynchronous. It is responded to by invoking the inboundCreditTransferAuthorisationResponse operation.

The inbound customer credit transfer authorisation operation is called when a payment authorisation to one of your account holders is received. This event must be followed by a call to the inboundCreditTransferAuthorisationResponse operation to indicate whether the payment will be allowed or not. No funds should be credited at this point; only if a subsequent onInboundCreditTransferCompletion operation is invoked should funds be credited. Note, though, that a completion containing successful response code (e.g. ACCP) may not be rejected if the authorisation was approved. Any completions that cannot be applied should be treated as exception cases that require manual intervention by your operational teams.

Note: | This operation differs from the inboundCreditTransfer operation which has immediate financial impact and | does not include a completion leg. Typically, inboundCreditTransfer is used for delayed payments while | inboundCreditTransferAuthorisation is used for immediate payments.

SchemeApplicable
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 CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.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)required

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

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

Identification of the currency in which the account is held.

creditorAccount.​identificationobject(BankingIdentifier)
creditorAccount.​namestring<= 70 characters

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

creditorAccount.​proxyobject(NonBankingIdentifier)
creditorAccount.​typeobject(AccountType)
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

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.

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)

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

debtorAgentobject(InstitutionIdentification)required
debtorAgent.​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.

instructedAgentobject(InstitutionIdentification)
instructingAgentobject(InstitutionIdentification)
instructionForCreditorAgentArray of objects(CreditorAgentInstruction)>= 0 items

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

paymentSchemeobject(CreditTransferPaymentScheme)required

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

paymentScheme.​schemastringrequired
Discriminator
paymentScheme.​schemeDataobject(CbprPlusCustomerCreditSchemeData)required

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

paymentScheme.​schemeData.​chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
paymentScheme.​schemeData.​chargesArray of objects(Charge)
paymentScheme.​schemeData.​exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

paymentScheme.​schemeData.​regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
paymentTypeInformationobject(PaymentTypeInformation)
previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

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

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)
schemastringrequired
Value"CreditTransfer"
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.

taxobject(TaxInformation)
curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/inbound/credit-transfer-authorisation \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "CreditTransfer",
    "messageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "paymentScheme": {
      "schema": "ZA_RTC",
      "schemeData": {
        "userReference": "Ab1 xxxxxxxxxxxxxxxx",
        "originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
        "businessReference": "11Ab1xxxxx"
      }
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "amounts": {
      "bankSettlementAmount": {
        "value": 1,
        "currency": "ZAR"
      },
      "instructedAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "paymentTypeInformation": {
      "localInstrument": {
        "schema": "CODE",
        "value": "BTR"
      }
    },
    "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",
            "issuer": "Dept of Home Affairs",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            }
          }
        ]
      }
    },
    "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",
            "issuer": "Dept of Home Affairs",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            }
          }
        ]
      }
    },
    "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"
          ]
        }
      }
    },
    "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"
          ]
        }
      }
    },
    "instructionForCreditorAgent": [
      {
        "code": "TELB",
        "information": "Please email example@example.com"
      }
    ],
    "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"
            ]
          }
        }
      }
    ],
    "previousInstructingAgents": [
      {
        "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"
            ]
          }
        }
      }
    ],
    "purpose": {
      "schema": "CODE",
      "value": "BKDF"
    },
    "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"
          ]
        }
      ]
    },
    "tax": {
      "totalAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "supplementaryData": {
      "customData1": "My custom data 1",
      "customData2": "My custom data 2"
    }
  }'

Responses

Accepted. RFC9110 - 202

Response
No content

Authorise an inbound customer credit transfer synchronously

Request

This operation is synchronous.

The inbound synchronous credit transfer authorisation operation is called when a payment authorisation to one of your account holders is received and should be accompanied by a response to approve or decline the authorisation request. No funds should be credited at this point; only if a successful subsequent onInboundCreditTransferCompletion operation is invoked should funds be credited. Note, though, that a completion containing a successful response code (e.g. ACCP) cannot be rejected if the authorisation was approved. Any completions that cannot be applied should be treated as exception cases that require manual intervention by your operational teams.

Note: | This operation differs from the inboundCreditTransfer operation which has immediate financial impact and | does not include a completion leg. Typically, inboundCreditTransfer is used for delayed payments while | inboundSynchronousCreditTransferAuthorisation is used for immediate payments.

SchemeApplicable
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 CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.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)required

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

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

Identification of the currency in which the account is held.

creditorAccount.​identificationobject(BankingIdentifier)
creditorAccount.​namestring<= 70 characters

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

creditorAccount.​proxyobject(NonBankingIdentifier)
creditorAccount.​typeobject(AccountType)
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

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.

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)

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

debtorAgentobject(InstitutionIdentification)required
debtorAgent.​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.

instructedAgentobject(InstitutionIdentification)
instructingAgentobject(InstitutionIdentification)
instructionForCreditorAgentArray of objects(CreditorAgentInstruction)>= 0 items

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

paymentSchemeobject(CreditTransferPaymentScheme)required

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

paymentScheme.​schemastringrequired
Discriminator
paymentScheme.​schemeDataobject(CbprPlusCustomerCreditSchemeData)required

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

paymentScheme.​schemeData.​chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
paymentScheme.​schemeData.​chargesArray of objects(Charge)
paymentScheme.​schemeData.​exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

paymentScheme.​schemeData.​regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
paymentTypeInformationobject(PaymentTypeInformation)
previousInstructingAgentsArray of objects(InstitutionIdentification)<= 3 items

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

purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)
schemastringrequired
Value"CreditTransfer"
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.

taxobject(TaxInformation)
curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/transactions/inbound/credit-transfer-authorisation-sync \
  -H 'Content-Type: application/json' \
  -H 'traceparent: string' \
  -H 'tracestate: string' \
  -d '{
    "schema": "CreditTransfer",
    "messageIdentifiers": {
      "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
      "creationDateTime": "2022-05-04T03:02:01Z"
    },
    "paymentScheme": {
      "schema": "ZA_RTC",
      "schemeData": {
        "userReference": "Ab1 xxxxxxxxxxxxxxxx",
        "originatorEchoData": "Ab1 xxxxxxxxxxxxxxxx",
        "businessReference": "11Ab1xxxxx"
      }
    },
    "transactionIdentifiers": {
      "endToEndIdentification": "6249118655591098",
      "transactionIdentification": "RRN000000001",
      "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
    },
    "amounts": {
      "bankSettlementAmount": {
        "value": 1,
        "currency": "ZAR"
      },
      "instructedAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "paymentTypeInformation": {
      "localInstrument": {
        "schema": "CODE",
        "value": "BTR"
      }
    },
    "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",
            "issuer": "Dept of Home Affairs",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            }
          }
        ]
      }
    },
    "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",
            "issuer": "Dept of Home Affairs",
            "scheme": {
              "schema": "CODE",
              "value": "NIDN"
            }
          }
        ]
      }
    },
    "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"
          ]
        }
      }
    },
    "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"
          ]
        }
      }
    },
    "instructionForCreditorAgent": [
      {
        "code": "TELB",
        "information": "Please email example@example.com"
      }
    ],
    "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"
            ]
          }
        }
      }
    ],
    "previousInstructingAgents": [
      {
        "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"
            ]
          }
        }
      }
    ],
    "purpose": {
      "schema": "CODE",
      "value": "BKDF"
    },
    "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"
          ]
        }
      ]
    },
    "tax": {
      "totalAmount": {
        "value": 1,
        "currency": "ZAR"
      }
    },
    "supplementaryData": {
      "customData1": "My custom data 1",
      "customData2": "My custom data 2"
    }
  }'

Responses

OK. RFC9110 - 200

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

Bodyapplication/json
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

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.

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.

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"
Response
application/json
{
  "schema": "PaymentStatusReport",
  "messageIdentifiers": {
    "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
    "creationDateTime": "2022-05-04T03:22:11Z"
  },
  "originalMessageIdentifiers": {
    "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
    "creationDateTime": "2022-05-04T03:02:01Z"
  },
  "paymentScheme": {
    "schema": "ZA_RTC",
    "schemeData": { … },
    "originalSchemeData": { … }
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "6249118655591098",
    "transactionIdentification": "RRN000000001",
    "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
  },
  "status": {
    "outcome": "APPROVED",
    "reasonInfo": [ … ]
  },
  "instructingAgent": {
    "bicfi": "RY8PEG0L",
    "memberId": "AmazingBankId",
    "name": "Amazing Bank Inc",
    "branch": { … }
  },
  "instructedAgent": {
    "bicfi": "RY8PEG0L",
    "memberId": "AmazingBankId",
    "name": "Amazing Bank Inc",
    "branch": { … }
  },
  "originalTransactionData": {
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "amounts": { … },
    "remittanceInformation": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … }
  }
}

Complete an inbound customer credit transfer

Request

This operation is invoked to complete a successful inbound customer credit transfer that was authorized by an earlier call to the inboundCreditTransferAuthorisation operation.

SchemeApplicable
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

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.

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.

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-partner/transactions/inbound/credit-transfer-completion \
  -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_RPP"
    },
    "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": {
      "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": 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"
        },
        "proxy": {
          "namespace": "NeoBank",
          "schema": "MOBILE",
          "value": "+27-0214620000"
        },
        "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"
            ]
          }
        }
      }
    }
  }'

Responses

Accepted. RFC9110 - 202

Response
No content

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

request-to-pay

Operations

refund

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd