Receive the response to an outbound credit transfer request

This operation is asynchronous. It starts with the outboundCreditTransfer operation

Invoked when a response to an outbound credit transfer is available. The response will indicate the success or failure of the outbound credit transfer.

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

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

required
object (TransactionIdentifiers)

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

object (InstitutionIdentification)
object (InstitutionIdentification)
object (OriginalTransactionData)

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

required
object (PaymentStatusReportPaymentScheme)

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

schema
required
string
Value: "PaymentStatusReport"
required
object (Status)
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/outbound/credit-transfer-response
Request samples
application/json
{
  • "schema": "PaymentStatusReport",
  • "messageIdentifiers": {
    },
  • "originalMessageIdentifiers": {
    },
  • "paymentScheme": {
    },
  • "transactionIdentifiers": {
    },
  • "status": {
    },
  • "instructingAgent": {
    },
  • "instructedAgent": {
    },
  • "originalTransactionData": {
    }
}
Response samples
application/json
{
  • "detail": "string",
  • "message": "string",
  • "schema": "ErrorDetail"
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.