| Table of Contents | ||
|---|---|---|
|
GET payments/show
This method returns information related with a payment. A single payment is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Payment identifier
The identifier of the payment that should be returned as a result. The allowed payment identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET payments/list
This method returns information related with payments. Multiple payments are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
payment_method_identifier
(optional)
...
The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET payments/get_latest
This method is used to get the latest payments that were submitted against a specific accounts receivable
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
payment_method_identifier
(optional)
...
The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:
...
number
(mandatory)
...
The number of payments to be retrieved, starting from the latest one
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST payments/create
This method is creating a new payment either in Draft or Posted state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(mandatory)
...
The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
...
life_cycle_state
(mandatory)
...
The state of the retrieved payment which can be one of the following:
DRAFT, POSTED
...
payment_method_identifier
(mandatory)
...
The payment method of the payment. The allowed payment method identifier fields are the following:
...
payment_amount
(mandatory)
...
category_identifier
(optional)
...
The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
received_on
(optional)
...
received_by_user_identifier
(optional)
...
The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
...
received_by_unit_identifier
(optional)
...
card_identifier
(mandatory on conditions)
...
The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
...
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| Tip |
|---|
...
notes
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
String
...
User Defined Field of type String
...
udf_string_3
(optional)
...
String
...
User Defined Field of type String
...
udf_string_4
(optional)
...
String
...
User Defined Field of type String
...
udf_string_5
(optional)
...
String
...
User Defined Field of type String
...
udf_string_6
(optional)
...
String
...
User Defined Field of type String
...
udf_string_7
(optional)
...
String
...
User Defined Field of type String
...
udf_string_8
(optional)
...
String
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
(optional)
...
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST payments/pay_invoice
This method is creating a new payment with the intention to pay the whole outstanding amount of a specific invoice. The method can be applied on a single invoice only. The payment is created in a posted state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(mandatory)
...
The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
payment_method_identifier
(mandatory)
...
The payment method of the payment. The allowed payment method identifier fields are the following:
...
invoice_identifier
(mandatory)
...
The invoice to be paid. The allowed invoice identifier fields are the following:
...
received_on
(optional)
...
received_by_user_identifier
(optional)
...
The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
...
received_by_unit_identifier
(optional)
...
card_identifier
(mandatory on conditions)
...
The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
...
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| Tip |
|---|
...
notes
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
String
...
User Defined Field of type String
...
udf_string_3
(optional)
...
String
...
User Defined Field of type String
...
udf_string_4
(optional)
...
String
...
User Defined Field of type String
...
udf_string_5
(optional)
...
String
...
User Defined Field of type String
...
udf_string_6
(optional)
...
String
...
User Defined Field of type String
...
udf_string_7
(optional)
...
String
...
User Defined Field of type String
...
udf_string_8
(optional)
...
String
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"accounts_receivable_identifier":{"number":"192"},
"life_cycle_state":"POSTED",
"type_identifier":{"name":"Invoices Balance Payment"},
"payment_method_identifier":{"name":"Direct Debit"},
"category_identifier":{"name":"Invoice Payments"},
"invoice_identifier":{"reference_number":"328"},
"received_on":"2014-07-14T09:12:54",
"received_by_user_identifier":{"username":"JackH"},
"received_by_unit_identifier":{"name":"Admin Unit"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment_amount": 225,
"issued_on": "2014-07-14T16:49:11",
"life_cycle_state": "POSTED",
"number": "100",
"id": "83DFE781350877933A6FA2A51EF0F102",
"reference_number": "115",
"posted_on": "2014-07-14T16:49:11"
}
} |
POST payments/pay_bill
This method is creating a new payment with the intention to pay the whole outstanding amount of a specific bill. The method can be applied on a single billonly. The payment is created in a posted state
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(mandatory)
...
The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
...
payment_method_identifier
(mandatory)
...
The payment method of the payment. The allowed payment method identifier fields are the following:
...
bill_identifier
(mandatory)
...
The invoice to be paid. The allowed invoice identifier fields are the following:
...
received_on
(optional)
...
received_by_user_identifier
(optional)
...
The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
...
received_by_unit_identifier
(optional)
...
card_identifier
(mandatory on conditions)
...
The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
...
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| Tip |
|---|
...
notes
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
String
...
User Defined Field of type String
...
udf_string_3
(optional)
...
String
...
User Defined Field of type String
...
udf_string_4
(optional)
...
String
...
User Defined Field of type String
...
udf_string_5
(optional)
...
String
...
User Defined Field of type String
...
udf_string_6
(optional)
...
String
...
User Defined Field of type String
...
udf_string_7
(optional)
...
String
...
User Defined Field of type String
...
udf_string_8
(optional)
...
String
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"accounts_receivable_identifier":{"number":"186"},
"life_cycle_state":"POSTED",
"type_identifier":{"name":"Invoices Balance Payment"},
"payment_method_identifier":{"name":"Direct Debit"},
"category_identifier":{"name":"Bill Payments"},
"bill_identifier":{"number":"128"},
"received_on":"2014-07-14T09:12:54",
"received_by_user_identifier":{"username":"JackH"},
"received_by_unit_identifier":{"name":"Admin Unit"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment_amount": 100,
"issued_on": "2014-07-14T17:01:43",
"life_cycle_state": "POSTED",
"number": "101",
"id": "B88388BA9E05BCBBB4579A2D2EBB22DC",
"reference_number": "116",
"posted_on": "2014-07-14T17:01:44"
}
} |
POST payments/post
This method is used to post a payment which is in draft state.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Payment identifier
The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"payment_identifier":{"reference_number":"117"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment_amount": 50,
"issued_on": "2014-07-14T17:06:14",
"life_cycle_state": "POSTED",
"number": "102",
"id": "4653BEFC9239043011096B329DFEF3F7",
"reference_number": "117",
"posted_on": "2014-07-14T17:07:13"
}
} |
POST payments/reject
This method is used to reject a payment which is in draft state.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Payment Identifier
The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
...
The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"payment_identifier":{"reference_number":"118"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment_amount": 50,
"issued_on": "2014-07-14T17:06:28",
"life_cycle_state": "REJECTED",
"number": null,
"id": "0ACCC72477BA606EE3B409400069F1BB",
"reference_number": "118",
"posted_on": null
}
} |
POST payments/cancel
This method is used to cancel a posted payment. A payment cancellation is created and posted to cancel the specified payment
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Payment Identifier
The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
...
type_identifier
(mandatory)
...
The financial transaction type of the payment cancellation. The allowed financial transaction type identifier field are the following:
...
category_identifier
(optional)
...
The financial transaction category of the payment cancellation. The allowed financial transaction category identifier fields are the following:
...
notes
(optional)
...
issue_reason
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
String
...
User Defined Field of type String
...
udf_string_3
(optional)
...
String
...
User Defined Field of type String
...
udf_string_4
(optional)
...
String
...
User Defined Field of type String
...
udf_string_5
(optional)
...
String
...
User Defined Field of type String
...
udf_string_6
(optional)
...
String
...
User Defined Field of type String
...
udf_string_7
(optional)
...
String
...
User Defined Field of type String
...
udf_string_8
(optional)
...
String
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
Payment object | The payment that was cancelled | |
| payment_cancellation | Payment cancellation object | The payment cancellation that was created |
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
"payment_identifier":{"reference_number":"117"},
"type_identifier":{"name":"Payment Cancellation"},
"category_identifier":{"name":"Cancellation Because of Mistake"},
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment":
{
"payment_amount": 50,
"issued_on": "2014-07-14T17:06:14",
"life_cycle_state": "POSTED",
"number": "102",
"id": "4653BEFC9239043011096B329DFEF3F7",
"reference_number": "117",
"posted_on": "2014-07-14T17:07:13"
},
"payment_cancellation":
{
"payment_amount": 50,
"issued_on": "2014-07-14T17:21:06",
"life_cycle_state": "POSTED",
"number": "35",
"id": "8F3613168562A73556CECA0FEA772AFE",
"reference_number": "26",
"posted_on": "2014-07-14T17:21:06"
}
}
} |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|