Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment identifier

The identifier of the payment that should be returned as a result. The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

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

...

Include Page

	V4:payment_complete
	V4:payment_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "invoices_to_pay_set":
        [
            {
                "total_amount": 138,
                "issued_on": "2014-07-14T10:31:15",
                "life_cycle_state": "POSTED",
                "number": "I00000294",
                "due_on": "2014-08-17T10:35:57",
                "id": "176AB06AE6DBFDB103182C67C68A2A8B",
                "outstanding_amount": 0,
                "reference_number": "322",
                "posted_on": "2014-07-14T10:35:57"
            }
        ],
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "number": "96",
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "received_by_unit":
        {
            "community_name": "Main Community",
            "group_name": "Main Group",
            "name": "Admin Unit",
            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
            "description": "r1",
            "alternative_code": "MG"
        },
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Johnson",
                "middle_name": null,
                "company_profile": null,
                "type": "PERSON",
                "first_name": "Peter",
                "name": "Peter Johnson",
                "id": "C73D1572FEA76C37A08945ECE4DECC98",
                "company_name": null,
                "demographics":
                {
                    "gender": "MALE",
                    "passport_issued_by_country": null,
                    "passport_number": "7839023",
                    "social_security_number": "98374",
                    "country_of_residence":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry_sector":
                    {
                        "name": "GOVERNMENTAL",
                        "id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
                    },
                    "date_of_birth":
                    {
                        "month": 4,
                        "day": 6,
                        "year": 1985
                    },
                    "name_day":
                    {
                        "month": 6,
                        "day": 29
                    },
                    "id_number": "984783",
                    "id_issued_by_country":
                    {
                        "name": "CYPRUS",
                        "id": "181"
                    },
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "192",
            "name": "Peter Johnson Premium",
            "id": "2C5FC6F615FA9E798487AC0C293ECCE6"
        },
        "received_by_user":
        {
            "person_name": "JackH",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "bills_to_pay_set":
        [
        ],
        "id": "830C6B800A1EAB42EA8D670ED6871E41",
        "posted_on": "2014-07-14T10:41:13",
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "log_information":
        {
            "updated_date": "2014-07-14T10:41:14",
            "created_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_date": "2014-07-14T10:40:29",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "JackH",
                "username": "JackH",
                "id": "B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            },
            "updated_by_user":
            {
                "person_name": "JackH",
                "username": "JackH",
                "id": "B8650C555C4EA8C741103961276E7773",
                "email": "j_hadjicosti@crm.com"
            }
        },
        "payment_amount": 60,
        "issued_on": "2014-07-14T10:40:29",
        "life_cycle_state": "POSTED",
        "type":
        {
            "classification": "PAYMENT",
            "name": "Invoices Balance Payment",
            "id": "9CC46F8C0A203CCA7A40B58825E74704",
            "description": null,
            "alternative_code": "INVBALPAY"
        },
        "payment_method":
        {
            "name": "Bank Transfer",
            "id": "PM7",
            "description": "Bank Transfer",
            "alternative_code": "BT"
        },
        "rejection_reason": null,
        "received_on": "2014-07-14T10:40:29",
        "reference_number": "111",
        "category": null
    }
}

GET payments/list

This method returns information related with payments. Multiple payments are returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

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

...

Include Page

	V4:payment_complete
	V4:payment_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "life_cycle_state": "POSTED",
            "id": "830C6B800A1EAB42EA8D670ED6871E41",
            "reference_number": "111"
        },
        {
            "life_cycle_state": "POSTED",
            "id": "F29426EFD767C7F35AC5BB179B8F7669",
            "reference_number": "113"
        }
    ]
}

GET payments/get_latest

This method is used to get the latest payments that were submitted against a specific accounts receivable

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

number

(mandatory)

Number

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

...

Include Page

	V4:payment_complete
	V4:payment_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "number": "98",
            "id": "F29426EFD767C7F35AC5BB179B8F7669",
            "reference_number": "113"
        },
        {
            "number": "96",
            "id": "830C6B800A1EAB42EA8D670ED6871E41",
            "reference_number": "111"
        }
    ]
}

POST payments/create

This method is creating a new payment either in Draft or Posted state

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

life_cycle_state

(mandatory)

String

The state of the retrieved payment which can be one of the following:

DRAFT, POSTED

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

payment_amount

(mandatory)

Number

The amount of the payment

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

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:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

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

invoices_to_pay_set

(optional)

Set of invoice objects

The invoices that are intended to be paid

bills_to_pay_set

(optional)

Set of bill objects

The bills that are intended to be paid

...

Include Page

	V4:payment_short
	V4:payment_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"accounts_receivable_identifier":{"number":"186"},
	"type_identifier":{"name":"Invoices Balance Payment"},
	"life_cycle_state":"POSTED",
	"payment_method_identifier":{"name":"Direct Debit"},
	"payment_amount":"50",
	"received_on":"2014-04-19T09:12:54",
	"received_by_user_identifier":{"username":"mpadministrator"},
	"received_by_unit_identifier":{"name":"Admin Unit"},
	"invoices_to_pay_set": [
	{
	   "invoice_identifier":{"reference_number":"307"},
	}],
	"bills_to_pay_set": [
    {
	   "bill_identifier":{"number":"126"},
	}]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount": 50,
        "issued_on": "2014-07-14T16:29:02",
        "life_cycle_state": "POSTED",
        "number": "99",
        "id": "C5E2F4D14F217257AD1A724E9B2F77F2",
        "reference_number": "114",
        "posted_on": "2014-07-14T16:29:02"
    }
}

POST payments/pay_invoice

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

invoice_identifier

(mandatory)

Invoice identifier

The invoice to be paid. The allowed invoice identifier fields are the following:

Include Page

	V4:invoice_identifier
	V4:invoice_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

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:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

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.

...

Include Page

	V4:payment_short
	V4:payment_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
	"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

theme	Confluence
language	javascript
linenumbers	true

{
    "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

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

bill_identifier

(mandatory)

Bill identifier

The invoice to be paid. The allowed invoice identifier fields are the following:

Include Page

	V4:bill_identifier
	V4:bill_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

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:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

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

...

Include Page

	V4:payment_short
	V4:payment_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
	"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

theme	Confluence
language	javascript
linenumbers	true

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

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(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:

Include Page

	V4:payment_identifier
	V4:payment_identifier

...

Include Page

	V4:payment_short
	V4:payment_short

Examples

Example 1

HTTP Method: POST

Request:

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(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:

Include Page

	V4:payment_identifier
	V4:payment_identifier

rejection_reason_identifier

Rejection reason identifier

The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:

Include Page

	V4:financial_transaction_rejection_reason_identifier
	V4:financial_transaction_rejection_reason_identifier

...

Include Page

	V4:payment_short
	V4:payment_short

Examples

Example 1

HTTP Method: POST

Request:

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(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:

Include Page

	V4:payment_identifier
	V4:payment_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment cancellation. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment cancellation. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

notes

(optional)

String

Shared notes for the payment

issue_reason

(optional)

String

A description of the reason that the payment cancellation is issued

udf_string_1

(optional)

String

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

...

Include Page

	V4:payment_cancellation_short
	V4:payment_cancellation_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token": "B8D7A12E9F91AFADE914B7330AFD08CB",
	"payment_identifier":{"reference_number":"117"},
	"type_identifier":{"name":"Payment Cancellation"},
	"category_identifier":{"name":"Cancellation Because of Mistake"},
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

Versions Compared

Old Version 20

New Version 21

Key

Examples

GET payments/list

Examples

GET payments/get_latest

Examples

POST payments/create

Examples

POST payments/pay_invoice

Restrictions

Examples

POST payments/pay_bill

Examples

POST payments/post

Examples

Example 1

Examples

Example 1

Examples

Page Comparison

Versions Compared

Old Version 20

New Version 21

Key

Examples

GET payments/list

Examples

GET payments/get_latest

Examples

POST payments/create

Examples

POST payments/pay_invoice

Restrictions

Examples

POST payments/pay_bill

Examples

POST payments/post

Examples

Example 1

Examples

Example 1

Examples