RequestToPay

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.

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.

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

object (InstitutionIdentification)
expiryDateTime
required
string <date-time>

Date and time at which the request to pay expires. Some schemes may still permit a payment after the request to pay expires. Upon expiry, the following schemes will reject an associated payment: ZA_RPP. The date must be formatted as defined by date-time in RFC3339

object (InstitutionIdentification)
object (InstitutionIdentification)
Array of objects (Instruction) >= 0 items

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

Array 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

required
object (CreditTransferPaymentScheme)

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

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

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

object (PurposeType)

Specifies the underlying reason for the payment transaction

object (RemittanceInformation)
required
object (RequestToPayConditions)

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

schema
required
string
Value: "RequestToPay"
object (TaxInformation)
{
  • "messageIdentifiers": {
    },
  • "supplementaryData": {
    },
  • "transactionIdentifiers": {
    },
  • "amounts": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "expiryDateTime": "2019-08-24T14:15:22Z",
  • "instructedAgent": {
    },
  • "instructingAgent": {
    },
  • "instructionForDebtorAgent": [
    ],
  • "intermediaryAgents": [
    ],
  • "paymentScheme": {
    },
  • "paymentTypeInformation": {
    },
  • "previousInstructingAgents": [
    ],
  • "purpose": {
    },
  • "remittanceInformation": {
    },
  • "requestToPayConditions": {
    },
  • "schema": "RequestToPay",
  • "tax": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.