Upload a physical mandate image file
Uploads a physical mandate image. To upload a file to LotusPay, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
ARGUMENTS
Scroll inside to view more
|
Argument
|
Description
|
|---|---|
file REQUIRED
| A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the multipart/form-data protocol). File must be format JPG, and file size no greater than 300kb. These attributes are validated. The following attributes are required by LotusPay, but not validated in the API: Image colour scheme should be black and white or greyscale. Image dimension aspect ratio should be 24:11. Image should be of physical mandate scan, legible, in good light. Image should be cropped around the border of the mandate.
|
reference1 conditionally REQUIRED
| The reference1 of the source to which the physical mandate image is to be attached. If successful, and if the same reference1 exists in any other pending source of the merchant, this new image will replace the existing image. Either source or reference1 must be passed.
|
source conditionally REQUIRED
| The identifier of the source to which the physical mandate image is to be attached. Source's status must be pending, and variant must be physical. If successful, this new image will replace the existing image. Either source or reference1 must be passed.
|
Returns Returns a physical mandate image object if a valid file and source or reference1 were provided.
Request
Response
API Endpoints
Sandbox Link
POST
https://api-test.lotuspay.com/v1/physical_mandate_images
Production Link
POST
https://api.lotuspay.com/v1/physical_mandate_images