The outcome of a prior outboundRequestToPayCancellationRequest operation

Communicates the outcome of a prior outboundRequestToPayCancellationRequest operation.

An outboundRequestToPayCancellationRequest operation is not guaranteed to be successful. For example, if the associated outboundRequestToPay has already been paid then it cannot be cancelled.

Note too that if the associated outboundRequestToPay was rejected or has already expired then the outboundRequestToPayCancellationRequest operation will be deemed to have failed despite the net result of no subsequent payment. This is because the final status of the outboundRequestToPay will be something other than a cancellation.

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

	object (InstitutionIdentification)
	object (InstitutionIdentification)
required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
required	object (MessageIdentifiers) Holds a point-to-point unique message identification string as well as a message's creation date time.
	object (OriginalRequestToPayData) Contains key elements related to the original request to pay that is being referred to.
required	object (TransactionIdentifiers) Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
schema required	string Value: "RequestToPayCancellationResponse"
required	object (RequestToPayCancellationStatus)

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/outbound/request-to-pay/cancellation-response

Request samples

application/json

{"status": {"status": "CANCELLED"
},
"schema": "RequestToPayCancellationResponse",
"messageIdentifiers": {"messageIdentification": "336b84c5592c3ebfa5553f6e191b6eaa",
"creationDateTime": "2022-05-04T03:05:10Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"originalTransactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
}
}

Response samples

application/json

{"detail": "string",
"message": "string",
"schema": "ErrorDetail"
}