(Quick Reference)
Service: Show a payment type
Description: Returns the requested payment type in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/paymentTypes/{id}:
https://BASE_URL/api/VERSION/paymentTypes/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired payment type | Long/String | yes | 123 |
Success Output
Success case: response.status=200
{
"id": 7,
"name": "cash on delivery",
"reference": "cod",
"isActive": true,
"organization": "entity1",
"dateCreated": "2016-01-04T13:51:54Z",
"lastUpdated": "2016-08-15T10:32:55Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The payment type with the id 7065 doesn't exist."
}
