PostingRequest

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

required
object (MessageIdentifiers)

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

object

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

required
object (TransactionIdentifiers)

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

aggregatedTransactionCount
required
integer

A count of how many payments are aggregated into this posting

required
object (Amount)
object (PaymentAccount)

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

creditorAccountReference
string

An explanation of the transaction, e.g. to be printed on the creditor account holder's statement.

object (InstitutionIdentification)
object (PaymentAccount)

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

debtorAccountReference
string

An explanation of the transaction, e.g. to be printed on the debtor account holder's statement.

object (InstitutionIdentification)
direction
string (TransactionDirection)

Indicates the direction of the original payment, from the perspective of Electrum and the Partner.

Enum: "INBOUND" "OUTBOUND" "ON_US"
effectiveDateTime
required
string <date-time>

The effective action date-time of the posting.

initiationSource
string

Free text field used to inform the core banking system of which system is initiating the posting.

object (LocalInstrumentType)
paymentMethod
required
string

Specifies the means of payment for the original transaction.

Enum: "CreditTransfer" "DirectDebit"
paymentScheme
required
string (PaymentSchemeName)

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"
paymentUetr
required
string <UUID>

UUID which links the posting to a payment instruction.

schema
required
string
Value: "PostingRequest"
{
  • "messageIdentifiers": {
    },
  • "supplementaryData": {
    },
  • "transactionIdentifiers": {
    },
  • "aggregatedTransactionCount": 0,
  • "amount": {
    },
  • "creditorAccount": {
    },
  • "creditorAccountReference": "string",
  • "creditorAgent": {
    },
  • "debtorAccount": {
    },
  • "debtorAccountReference": "string",
  • "debtorAgent": {
    },
  • "direction": "INBOUND",
  • "effectiveDateTime": "2019-08-24T14:15:22Z",
  • "initiationSource": "string",
  • "localInstrument": {
    },
  • "paymentMethod": "CreditTransfer",
  • "paymentScheme": "ZA_RTC",
  • "paymentUetr": "string",
  • "schema": "PostingRequest"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.