Request the latest status of a prior request to pay

Requests the latest status of a prior inboundRequestToPay operation.

This operation may be called if Electrum doesn't receive an expected inboundRequestToPayResponse operation or if an Industry Participant is requesting the latest status and the last status observed by Electrum was not a final status (i.e. it was one such as ACCP, PDNG or PRES).

The requested status is 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

	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.
	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.
schema	string Value: "RequestToPayStatusRequest"

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/status-request

Request samples

application/json

{"schema": "RequestToPayStatusRequest",
"messageIdentifiers": {"messageIdentification": "f3507f23c9be4812baddf81e4a1a1180",
"creationDateTime": "2022-05-04T03:01:01Z"
},
"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"
}