Perform a reservation of funds on an account

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

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 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 (PaymentAccount) Representation of an account for payment purposes. Note that at least one of `identification` or `proxy` is expected to be present.
required	object (Amount)
reference	string <= 35 characters An explanation of the transaction, e.g. to be printed on the account holder's statement.
	object (ReservationType)
schema required	string Value: "ReservationRequest"

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/funds-management/reservation

Request samples

application/json

{"schema": "ReservationRequest",
"messageIdentifiers": {"messageIdentification": "original-msg-12345",
"creationDateTime": "2025-01-23T06:29:01Z"
},
"transactionIdentifiers": {"endToEndIdentification": "e2e-12345",
"transactionIdentification": "txn-12345",
"uetr": "550e8400-e29b-41d4-a716-446655440000"
},
"accountIdentification": {"identification": {"schema": "GENERIC",
"scheme": {"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {"schema": "CODE",
"value": "CACC"
}
},
"reference": "Reservation Ref",
"amount": {"value": 65.23,
"currency": "ZAR"
},
"reservationType": {"schema": "CODE",
"value": "BLKD"
},
"supplementaryData": {"key1": "value1",
"key2": "value2"
}
}

Response samples

application/json

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