(Quick Reference) Service: Show an order payment

Description: Returns the requested order payment in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/orderPayments/{id}

Method: GET

Parameters:

NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired order paymentLongYes777

Success Output

Success case: response.status=200
{
  "id": 921,
  "reference": "5_8_2014_12_20",
  "orderReference": "marie_order_2014_12_20",
  "order": {
    "id": 5,
    "reference": "marie_order_2014_12_20",
    "href": "/api/v1.0/orders/5"
  },
  "advanceAmount": null,
  "paymentDate": "2014_12_20T22:00:00Z",
  "isLast": true,
  "paymentTypeReference": "CHEQUE",
  "paymentType": {
    "id": 8,
    "reference": "CHEQUE",
    "name": "Cheque",
    "href": "/api/v1.0/paymentTypes/8"
  },
  "bank": null,
  "chequeNumber": null,
  "desiredPaymentDate": null,
  "chequeImage": null,
  "dateCreated": "2014_12_20T22:00:00Z",
  "lastUpdated": "2014_12_20T22:00:00Z"
}

Failure Output

Failure case:response.status = 404

Failure case:response.status = 400
{
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
}