<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>
URL
/check-order
Method:
GET
| POST
URL Params
Api will consume query or data params depending on method.
Required:
auth_token=[string]
Optional [required if method is GET
]
digest=[string]
- representssha1(merchant_key + digest)
order_number=[string]
- order number
POST params
Required:
digest=[string]
- representssha1(merchant_key + digest)
order_number=[string]
- order number
Success Response:
Response is successful if following is satisfied:
Code: 200
Content:
{
"id":82085,
"card_type":"visa",
"pm_alias":null,
"ch_email":"[email protected]",
"ch_full_name":"jasmin suljic",
"merchant_id":"007007007007",
"masked_pan":"***-1111",
"amount":12.5,
"response_code":"0000",
"response_message":"approved",
"approval_code":"870112",
"status":"approved"
}
Error Response:
Error response can occur in multiple scenarios as described bellow
- Wrong or missing auth token
- Code:
401 UNAUTHORIZED
Invalid input data - missing one of required params, input data validation failed.
- Details: Errors will always contain string "Validation errors, check data for details". Data differs from case to case [result from validating json schema]
- Code:
422 Unprocessable Entity
- Content:
{
"errors":[
"Validation errors, check data for details"
],
"data":[]}- Not found - transaction with order_number not found on payment proxy
- Details: This will only occur if transaction is not found on payment proxy, although is found on payment gateway. Use check-order-id to retrieve details from payment gateway directly
- Code:
404 Not Found
- Content:
{
"errors":["Transaction with orderNumber 1484635152 not found!"],
"notice":["Try retrieving order details from /check-order-id"]
}