(Quick Reference)

13 Payment types - Reference Documentation

Version: 2.1

13.1List

13.2Show

13.3Create

13.4Update

13.5Upsert

13.6Delete

13 Payment types

13.1 List

Service: List of payment types

Description: This web service returns the list of payment types in JSON format

URL:

https://BASE_URL/api/VERSION/paymentTypes

Method: GET

Parameters:

Pagination parameters:

Name	Description	Type	Required	Possible values
max	Limits the number of resources requested to return.	Integer	no
offset	Tells where to start returning records from the entire set of results.	Integer	no
order	Orders ascending or descending.	Integer	no	asc,desc
sort	Orders the results by the specified field.	String	no

The max parameter is set to 100 by default.

Filters parameters:

Name	Description	Type	Required	Example values
dateCreated_gt	Filters by the resource's creation date time and operator greater than	Date	no	2016-08-15T14:52:48Z
dateCreated_gte	Filters by the resource's creation date time and operator greater than or equal	Date	no
dateCreated_lt	Filters by the resource's creation date time and operator less than	Date	no
dateCreated_lte	Filters by the resource's creation date time and operator less than or equal	Date	no
lastUpdated_gt	Filters by the resource's last-modified date time and operator greater than	Date	no
lastUpdated_gte	Filters by the resource's last-modified date time and operator greater than or equal	Date	no
lastUpdated_lt	Filters by the resource's last-modified date time and operator less than	Date	no
lastUpdated_lte	Filters by the resource's last-modified date time and operator less than or equal	Date	no
reference	Wildcard search by the resource's reference	String	no	reference=Ref-6* , reference=ef-6 , reference=ef-6*
name	Wildcard search by the resource's name	String	no

reference must be unique

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
  "paging": {
    "total": 8,
    "max": 5,
    "offset": 0,
    "previous": null,
    "next": "/api/v1.0/paymentTypes?max=5&offset=5&sort=dateCreated&order=asc"
  },
  "data": [
    {
      "id": 6,
      "name": "World Pay Call for Payment",
      "reference": "wp_cfp",
      "isActive": true,
      "organization": "entity1",
      "dateCreated": "2015-12-15T08:59:58Z",
      "lastUpdated": "2015-12-15T08:59:58Z"
    },
    {
      "id": 4,
      "name": "World Pay Credit Cards",
      "reference": "wp_cr",
      "isActive": true,
      "organization": "entity1",
      "dateCreated": "2015-12-15T08:59:58Z",
      "lastUpdated": "2015-12-15T08:59:58Z"
    },
    {
      "id": 5,
      "name": "World Pay Invoice Me",
      "reference": "wp_im",
      "isActive": true,
      "organization": "entity1",
      "dateCreated": "2015-12-15T08:59:58Z",
      "lastUpdated": "2015-12-15T08:59:58Z"
    },
    {
      "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",
   "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}

{
    "error": "invalid_datetime_format",
    "error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
}

Failure case:response.status = 500

{
   "error": "server_error",
   "error_description": "Oops! Something went wrong..."
}

13.2 Show

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}

URL with external_id:

https://BASE_URL/api/VERSION/paymentTypes/reference/{id}

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

13.3 Create

Service: Create a payment type

Description: Returns the created payment type in JSON format when successful. Returns a JSON response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/paymentTypes

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
reference		String	yes
name		String	yes
isActive	By default, it is set to true	Boolean	no	true, false

Success Output

Success case: response.status=201

{
  "id": 7,
  "name": "cash on delivery",
  "reference": "cod",
  "isActive": true,
  "organization": "entity1",
  "dateCreated": "2016-01-04T13:51:54Z",
  "lastUpdated": "2016-01-04T13:51:54Z"
}

Failure Output

Failure case:response.status = 400

{
  "error": "missing_param",
  "error_description": "reference parameter is missing
}

{
  "error": "not_unique",
  "error_description": "reference already used"
}

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

Failure case:response.status = 500

{
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."
}

13.4 Update

Service: Update a payment type

Description: Returns the updated 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}

URL with external_id:

https://BASE_URL/api/VERSION/paymentTypes/reference/{id}

Method: PUT

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired payment type	Long/String	yes	123
reference		String	yes
name		String	yes
isActive	By default, it is set to true	Boolean	no	true, false

World pay payment types are not authorized to be updated!

Payment types with the references CASH, CREDIT_CARD, CHEQUE are only authorized to active, desactivate it, or just change name.

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": "update_not_authorized",
  "error_description": "World pay types of payment should not be updated"
}

{
  "error":"invalid_param_type",
  "error_description": "The type of parameter $param you provided is not valid for this request."
}

{
  "error": "missing_param", 
  "error_description": "reference parameter is missing"
}

{
  "error": "not_unique",
  "error_description": "reference already used"
}

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The payment type with the id 706 doesn't exist."
}

Failure case:response.status = 500

{
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."
}

13.5 Upsert

Service: Create a payment type

Description: This web service is used to insert a payment type object to the database if it does not already exist, or update it.

URL with external_id:

https://BASE_URL/api/VERSION/paymentTypes/reference/{id}

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
name		String	yes
isActive	By default, it is set to true	Boolean	no	true, false

Success Output

Success case: response.status=201

{
  "id": 7,
  "name": "cash on delivery",
  "reference": "cod",
  "isActive": true,
  "organization": "entity1",
  "dateCreated": "2016-01-04T13:51:54Z",
  "lastUpdated": "2016-01-04T13:51:54Z"
}

Failure Output

Failure case:response.status = 400

{
  "error": "missing_param",
  "error_description": "reference parameter is missing
}

{
  "error": "not_unique",
  "error_description": "reference already used"
}

{
  "error": "save_failed",
  "error_description": "Failed to save instance"
}

Failure case:response.status = 500

{
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."
}

13.6 Delete

Service: Delete a payment type

Description: Returns a JSON response.

URL:

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

URL with external_id:

https://BASE_URL/api/VERSION/paymentTypes/reference/{id}

Method: DELETE

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired payment type	Long/String	yes	123

World pay and payment types with the references CASH, CREDIT_CARD, CHEQUE are not authorized to delete!

Success Output

Success case: response.status=200

{
  "success": "true",
  "success_description": "Instance deleted successfully"
}

Failure Output

Failure case:response.status = 400

{
  "error": "delete_failed",
  "error_description": "Failed to delete instance."
}

{
  "error": "delete_not_authorized",
  "error_description": "This type of payment must not be deleted"
}

{
  "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 706 doesn't exist."
}

Failure case:response.status = 500

{
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."
}

<< 12Contacts of customers

14Assign customers to employees >>

13 Payment types - Reference Documentation

Table of Contents

13 Payment types

13.1 List

Success Output

Failure Output

13.2 Show

Success Output

Failure Output

13.3 Create

Success Output

Failure Output

13.4 Update

Success Output

Failure Output

13.5 Upsert

Success Output

Failure Output

13.6 Delete

Success Output

Failure Output

Answers

Appointment

Appointment Categories

Attribute values

Attributes

Authentication

Authority

Check In List

Contacts

Customer Categories

Customer Categories Discount Lists

Customer Categories Price Lists

Customer Categories Tax Lists

Customer Discounts

Customer Employee

Customer Group Promotion Lists

Customer Groups

Customer Groups Assign

Customer Price List

Customer Promo List

Customer Segmentations

Customer Tax List

Customers

Deliveries

Discount lists

Employee Groups

Employee Item Category Assign

Employee WareHouses

Employees

Exchange rates

Item Categories

Item Groups

Item Groups Assign

Item attributes

Item category translation

Item customer groups assign

Item group translation

Item translation

Item units

Items

Loading details

Loadings

Objectives

Operation Prepayments

Operation lines

Operation payments

Operations

Payment types

Prepayment Allocations

Price List

Prices

Promotion inputs

Promotion outputs

Promotions

Question Columns

Question Lines

Question options

Questions

Reasons