EPC API for receiving Electrum calls (15.2.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Languages
Servers
Mock server
https://docs.electrumsoftware.com/_mock/openapi/epc-partner/bpp-elpapi-partner/
Partner API sandbox
https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

Complete an inbound credit transfer

Request

SchemeApplicable
ZA_EFT✗
ZA_RPP✓
ZA_RTC✓
Headers
traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

Bodyapplication/jsonrequired
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.​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)
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.​schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

  • ZA_RTC: South African Realtime Clearing scheme
  • ZA_RPP: South African Realtime Payments Platform scheme.
  • ZA_EFT: South African Electronic Funds Transfer scheme.
Enum"ZA_RTC""ZA_RPP""ZA_EFT"
Discriminator
schemastringrequired
Value"PaymentStatusReport"
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.

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/epc-partner/bpp-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

Response
No content

Authorise an inbound credit transfer

Request

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

The inbound credit transfer authorisation operation is called when a payment authorisation to one of your accountholders is received. This event must be followed by an inboundCreditTransferAuthorisationResponse operation to indicate whether the payment will be allowed or not. No funds should be credited at this point; only if a successful subsequent onInboudCreditTransferCompletion event is received should funds be credited. Note, though, that a successful (response code ACCP) completion 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✓
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.​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.​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.​companyRegistrationstring<= 35 characters

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

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

Identification of a member of a clearing system.

creditorAgent.​namestring<= 140 characters

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

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

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

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

Identification of a member of a clearing system.

debtorAgent.​namestring<= 140 characters

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

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

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

intermediaryAgentsArray of objects(InstitutionIdentification)<= 3 items

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

paymentSchemeobject(CreditTransferPaymentScheme)required

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

paymentScheme.​schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

  • ZA_RTC: South African Realtime Clearing scheme
  • ZA_RPP: South African Realtime Payments Platform scheme.
  • ZA_EFT: South African Electronic Funds Transfer scheme.
Enum"ZA_RTC""ZA_RPP""ZA_EFT"
Discriminator
paymentScheme.​schemeDataobject(ZaEftSchemeData)required
paymentScheme.​schemeData.​shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

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

paymentScheme.​schemeData.​shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

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

paymentScheme.​schemeData.​userReferencestring<= 30 charactersrequired

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

paymentTypeInformationobject(PaymentTypeInformation)
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/epc-partner/bpp-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": "TELA",
        "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

Response
No content

Receive the response to an outbound credit transfer request

Request

This operation is asynchronous. It starts with the outboundCreditTransfer operation

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

SchemeApplicable
ZA_EFT✓
ZA_RPP✓
ZA_RTC✓
Headers
traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

Bodyapplication/jsonrequired
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.​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)
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.​schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

  • ZA_RTC: South African Realtime Clearing scheme
  • ZA_RPP: South African Realtime Payments Platform scheme.
  • ZA_EFT: South African Electronic Funds Transfer scheme.
Enum"ZA_RTC""ZA_RPP""ZA_EFT"
Discriminator
schemastringrequired
Value"PaymentStatusReport"
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.

curl -i -X POST \
  https://docs.electrumsoftware.com/_mock/openapi/epc-partner/bpp-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

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✓
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.​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.​companyRegistrationstring<= 35 characters

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

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

Identification of a member of a clearing system.

debtorAgent.​namestring<= 140 characters

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

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.
Enum"ZA_RTC""ZA_RPP""ZA_EFT"
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/epc-partner/bpp-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"
    },
    "bulkPaymentSchemeName": "ZA_RPP",
    "bulkStatus": {
      "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

Response
No content

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations