Search for a mandate
Searches for a mandate object. Up to 50 results are returned. The argument should be in the query string (not in the body).
ARGUMENTS
Scroll inside to view more
|
Argument
|
Description
|
|---|---|
id optional
| The mandate ID to search by e.g. /v1/mandates/search/id/3322. Supply a full or partial string. Supply exactly one argument from id, umrn, reference1 and mandate_request_id.
|
umrn optional
| The Unique Mandate Reference Number to search by e.g. /v1/mandates/search/umrn/KKBK1234.
|
reference1 optional
| The Reference 1 to search by e.g. /v1/mandates/search/reference1/ABC.
|
mandate_request_id optional
| The Mandate Request ID to search by e.g. /v1/mandates/search/mandate_request_id/DEF.
|
Returns A dictionary with a data property that contains an array of up to 50 mandates, all containing the searched string in the searched field. Each entry in the array is a separate mandate object. If no more mandates are available, the resulting array will be empty. Note: Limited API Keys will return only those objects to which they are associated.
Request
Response
API Endpoints
Sandbox Link
GET
https://api-test.lotuspay.com/v1/mandates/search/id/{string}
Production Link
GET
https://api.lotuspay.com/v1/mandates/search/id/{string}