(Quick Reference)

59 Payments operations - Reference Documentation

Version: 2.1

Table of Contents

59 Payments operations

59.1 List

Service: List order payments

Description: This web service return the list of order payments in JSON format.

URL:

https://BASE_URL/api/VERSION/orderPayments

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
offsetTells where to start returning records from the entire set of results.IntegerNo 
maxLimits the number of resources requested to return.IntegerNo 
sortOrders the results by the specified field.StringNo 
orderOrders ascending or descendingIntegerNoasc, desc

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
referenceWildcard search by the reference of order paymentStringnoreference=ref-6*
orderReferenceWildcard search by the order's referenceStringno 
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
  "paging": {
    "total": 1,
    "max": 100,
    "offset": 0,
    "previous": null,
    "next": null
  },
  "data": [
    {
	  "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 = 400
{
   "error": "invalid_param",
   "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}

Failure case:response.status = 500
{
   "error": "server_error",
   "error_description": "Oops! Something went wrong..."
}

59.2 Show

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."
}