Receive the return for an earlier outbound direct debit or outbound credit transfer

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

Invoked when an inbound return is received for an earlier outbound direct debit or outbound credit transfer. The response to this operation will indicate the success or failure of the return. Note that some payment schemes may not support rejecting the return. In these cases, a rejected response will cause Electrum to flag the transaction as broken.

The return is expected to have immediate financial impact if approved; there is no completion leg associated with this operation.

This operation must be idempotent, i.e. no action should be taken if the operation is received more than once with an identical request body. This allows Electrum to retry the request if the initial request fails. An identical HTTP response is expected to be returned for each retry.

Scheme Applicable
ZA_EFT ✓
ZA_RPP ✗
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.

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.

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)
object (MessageIdentifiers)

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

object (OriginalTransactionData)

Contains key elements related to the original transaction that is being referred to.

required
object (PaymentReturnPaymentScheme)

Designates which scheme a payment return is associated with and describes scheme-specific information for the return.

object (PaymentTypeInformation)
Array of objects (ReturnReasonInfo) non-empty

A list of ReturnReasonInfo values providing detailed reason information for the return.

required
object (TransactionAmounts)
schema
required
string
Value: "PaymentReturn"
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.

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 Requsts. RFC6585 - 429

500

Internal server error. RFC9110 - 500

503

Service unavailable. RFC9110 - 503

post/transactions/inbound/payment-return
Request samples
application/json
{
  • "schema": "PaymentReturn",
  • "messageIdentifiers": {
    },
  • "originalMessageIdentifiers": {
    },
  • "paymentScheme": {
    },
  • "paymentTypeInformation": {
    },
  • "transactionIdentifiers": {
    },
  • "reasonInfo": [
    ],
  • "returnedAmounts": {
    },
  • "settlementDate": "2022-05-04",
  • "instructingAgent": {
    },
  • "instructedAgent": {
    },
  • "creditor": {
    },
  • "creditorAccount": {
    },
  • "creditorAgent": {
    },
  • "debtor": {
    },
  • "debtorAccount": {
    },
  • "debtorAgent": {
    },
  • "originalTransactionData": {
    }
}
Response samples
application/json
{
  • "detail": "string",
  • "message": "string",
  • "schema": "ErrorDetail"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.