DirectDebit

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

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.

required
object (TransactionAmounts)
required
object (Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

object (PaymentAccount)

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

required
object (InstitutionIdentification)
required
object (Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

required
object (PaymentAccount)

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

required
object (InstitutionIdentification)
object (InstitutionIdentification)
object (InstitutionIdentification)
Array of objects (InstitutionIdentification) <= 3 items

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

object (MandateInformation)

Provides details of the direct debit mandate signed between the creditor and the debtor.

NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).

required
object (DirectDebitPaymentScheme)

Designates which scheme a direct debit is associated with and describes scheme-specific information for the direct debit.

object (PaymentTypeInformation)
object (PurposeType)

Specifies the underlying reason for the payment transaction

object (RemittanceInformation)
requestedCollectionDate
string <date>

Date and time at which the creditor requests that the amount of money is to be collected from the debtor.

schema
required
string
Value: "DirectDebit"
sequenceType
string (SequenceTypeCode)

Identifies the direct debit sequence:

  • FRST : First collection of a series of direct debit instructions.
  • RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.
  • FNAL : Final collection of a series of direct debit instructions.
  • OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.
  • RPRE : Collection used to represent previously reversed or returned direct debit transactions.
Enum: "FRST" "RCUR" "FNAL" "OOFF" "RPRE"
settlementDate
string <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.

{
  • "messageIdentifiers": {
    },
  • "supplementaryData": {
    },
  • "transactionIdentifiers": {
    },
  • "amounts": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "instructedAgent": {
    },
  • "instructingAgent": {
    },
  • "intermediaryAgents": [
    ],
  • "mandateInformation": {
    },
  • "paymentScheme": {
    },
  • "paymentTypeInformation": {
    },
  • "purpose": {
    },
  • "remittanceInformation": {
    },
  • "requestedCollectionDate": "2019-08-24",
  • "schema": "DirectDebit",
  • "sequenceType": "FRST",
  • "settlementDate": "2019-08-24"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.