APICompleteOrder
Call to Complete an Order
/api/plain/?type=APICompleteOrder&[payload]&HashString=[hashstring]
URL Parameters
Field | Type | Description |
---|
Type | String | API that will be called |
Payload | URL_ENCODED | An URL encoded JSON array |
HashString | Varchar | sha256 encoded string. Click here for more info |
Payload Parameters
Field | Type | Description |
---|
Reference | String | Order Reference |
SendConfirmationEmail | Boolean | true or false. Set this to true if you wish to send the Customer a confirmation Email when the order is completed. |
SendConfirmationSMS | Boolean | true or false.Set this to true if you wish to send the Customer a confirmation SMS when the order is completed. (optional) |
Transactions | array() | (optional). if no transaction provided order will be completed as Provisional |
- Type | String | Valid Transaction types: Cash,PDQ,Cheque,Goodwill |
- Amount | Double | Amount of the order |
Success 200
Field | Type | Description |
---|
Errors | array() | If empty then the call is successful |
Error 4xx
Field | Type | Description |
---|
Errors | array() | |
- Code | Int | Number of error |
- Error | String | Error message |
- Error-Response:
HTTP/1.1 200 OK
{
"Errors": [
{"Code":"9", "Error":"no Reference sent"},
{"Code":"10", "Error":"no OrderItems sent"},
]
}