Response to a prior request to pay or status request

Communicates the status of a prior request to pay initiated by a customer of the partner.

An outboundRequestToPayResponse may indicate that a request to pay, sent to Electrum by the partner on behalf of a partner's customer, will be presented to the debtor, has already been paid or has failed for some reason. A new unsolicited outboundRequestToPayResponse may be received for each status update of the request to pay.

If the partner is unsure of the status of an outboundRequestToPay, an outboundRequestToPayStatusRequest may be used to solicit an up-to-date outboundRequestToPayResponse.

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 (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 (OriginalRequestToPayData) Contains key elements related to the original request to pay that is being referred to.
	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: "RequestToPayResponse"
required	object (RequestToPayStatus)

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-response

Request samples

application/json

{"status": {"status": "PRESENTED"
},
"schema": "RequestToPayResponse",
"messageIdentifiers": {"messageIdentification": "89730ee05e184fb094cf27cec5078d6b",
"creationDateTime": "2022-05-04T03:02:02Z"
},
"originalMessageIdentifiers": {"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"requestToPayConditions": {"minAmount": {"value": 100,
"currency": "ZAR"
},
"maxAmount": {"value": 100,
"currency": "ZAR"
}
}
}

Response samples

application/json

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