Request a payment to an account

A request from an Industry Participant to credit an account held at the participant.

This request should be shown to the debtor (i.e. the partner's customer). An initial inboundRequestToPayResponse operation must be sent to indicate that the request to pay has been accepted by the partner and to confirm it will be displayed to the debtor.

If the debtor agrees, an outboundCreditTransfer operation may be performed to credit the account i.e. it is not necessary to send another inboundRequestToPayResponse operation to indicate that the debtor has accepted the request to pay. But, if the debtor rejects the request, this must be communicated via an inboundRequestToPayResponse operation.

Scheme Applicable
ZA_RPP ✓
ZA_EFT ✗
ZA_RTC ✗
Request
header Parameters
traceparent
string (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 (V2))[https://www.w3.org/TR/trace-context-2/].

tracestate
string (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 (V2))[https://www.w3.org/TR/trace-context-2/].

Request Body schema: application/json
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 characters

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 characters

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)
Responses
202

Accepted. RFC9110 - 202

400

Bad request. RFC9110 - 400

401

Unauthorized. RFC9110 - 401

403

Forbidden. RFC9110 - 403

405

Method not allowed. RFC9110 - 405

422

Unprocessable content. RFC9110 - 422

429

Too Many Requests. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/transactions/inbound/request-to-pay
Request samples
application/json
{
  • "paymentScheme": {
    },
  • "amounts": {
    },
  • "paymentTypeInformation": {
    },
  • "expiryDateTime": "2024-04-09T09:32:51.395+02:00",
  • "requestToPayConditions": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "instructedAgent": {
    },
  • "instructingAgent": {
    },
  • "remittanceInformation": {
    },
  • "schema": "RequestToPay",
  • "messageIdentifiers": {
    },
  • "transactionIdentifiers": {
    }
}
Response samples
application/json
{
  • "detail": "string",
  • "message": "string",
  • "schema": "ErrorDetail"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.