POST payments/create
- Former user (Deleted)
- Antonis Papageorgiou
- Georgia Kountouri
This method is creating a new payment either in Draft or Posted state
Resource URL
http://host_name/crmapi/rest/$version/payments/create
Parameters
Name | Type | Description | |||||||||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||||||||
| accounts_receivable_identifier (semi-optional) | 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:
For releases prior CRM.COM R14.0.0, the accounts_receivable_identifier is mandatory | |||||||||||||||||||||||||||
| wallet_identifier (semi-optional) | Wallet Identifier | The identifier of the wallet in which the payment should be allocated to. The allowed wallet identifier fields are the following:
Only unconditional wallet funds can be used in order to pay off Available from CRM.COM R14.0.0 If the payment using unconditional wallet funds is not enabled through the Wallet Definition, then this parameter is not applicable | |||||||||||||||||||||||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:
From CRM.COM R14.0.0 and onwards, if the wallet_identifier parameter is set, then this parameter cannot include Payment Gateways | |||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||
payment_amount (mandatory) | Number | The amount of the payment | |||||||||||||||||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the payment. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| |||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||
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:
| |||||||||||||||||||||||||||
received_by_unit_identifier (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | |||||||||||||||||||||||||||
received_by_business_unit_identifier (optional) | Business Unit identifier | The business unit who actually received the payment. The allowed business unit identifier fields are the following: Unable to render {include} The included page could not be found. Available from CRM.COM R18.0.0 | |||||||||||||||||||||||||||
card_identifier (mandatory on conditions) | Payment Gateway Card Identifier | 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 | |||||||||||||||||||||||||||
accounts_receivable_payment_preference_identifier (mandatory on conditions) | Accounts Receivable Payment Preference Identifier | The accounts receivable payment preferences that will be used by generic payment gateways to process the payment. The specified accounts receivable payment preferences should belong to the specified accounts receivable. This information is applicable and mandatory only if the payment will be processed by a generic payment gateway, as denoted by the selected payment method. The allowed accounts receivable payment preference identifier fields are the following:
| |||||||||||||||||||||||||||
notes (optional) | String | Shared notes for the payment | |||||||||||||||||||||||||||
back_office_code (optional) | String | A back office code for the payment. If specified then it should be unique | |||||||||||||||||||||||||||
job_identifier (optional) | Job Identifier | The job for which the payment was done for. The allowed job identifier fields are the following:
| |||||||||||||||||||||||||||
posted_on (optional) | Date | The posting date of the financial transaction which is before or equal to the current date and not included in already closed accounting periods. If not specified then the current date is applied. Available from CRM.COM R14.10.0 | |||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||
(optional) | Set of invoice objects | The invoices that are intended to be paid | |||||||||||||||||||||||||||
(optional) | Set of bill objects | The bills that are intended to be paid | |||||||||||||||||||||||||||
(optional) | Set of product objects | The subscription service products that are intended to be paid through the payment. Applicable only if the account owner has an effective wallet and the payment type is included in active Wallet Definitions as a wallet credit cause. The payment's amount will be allotted only to services for which the account owner is already subscribed. | |||||||||||||||||||||||||||
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 |
Referred Parameter Objects
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
HTTP Method: POST
Request:
Body:
{
"token": "825D7B5BB7F62E043A7C73B0FFBF124F",
"accounts_receivable_identifier":{"number":"200"},
"type_identifier":{"name":"Payment 1"},
"life_cycle_state":"POSTED",
"payment_method_identifier":{"name":"Stripe Payment Gateway"},
"card_identifier":{"payment_gateway_reference_number":"card_15S0w0E0IcJRGs11e6ffmDXK"},
"payment_amount":"50",
"received_on":"2015-03-02T09:12:54",
"received_by_user_identifier":{"username":"mpadministrator"},
"received_by_unit_identifier":{"name":"Admin Unit"},
"description":"Payment",
"notes":"Payment note",
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"bills_to_pay_set": [
{
"bill_identifier":{"number":"163"},
}]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"payment_gateway_reference_number": "ch_15S1nyE0IcJRGs11wD2c3TUn",
"payment_amount": 50,
"issued_on": "2015-02-03T10:12:48",
"processed_by_payment_gateway": "STRIPE",
"life_cycle_state": "POSTED",
"number": "245",
"id": "BF2392E94DB88F496656F6AFE860A673",
"reference_number": "277",
"posted_on": "2015-02-03T10:12:52"
}
}
HTTP Method: POST
Request:
Body:
{
"token": "825D7B5BB7F62E043A7C73B0FFBF124F",
"fields_set":"number,payment_amount,id,payment_gateway_reference_number,posted_on",
"accounts_receivable_identifier":{"name":"Dina Mika"},
"type_identifier":{"name":"Payment 1"},
"life_cycle_state":"POSTED",
"payment_method_identifier":{"name":"Cash"},
"payment_amount":"50",
"received_on":"2016-08-06T09:12:54",
"received_by_user_identifier":{"username":"mpadministrator"},
"received_by_unit_identifier":{"name":"Admin Unit"},
"description":"Payment",
"notes":"Payment note",
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"payment_amount": 50,
"number": "366",
"id": "B8D20D3D27E543F18C09D66945BAF7D2",
"posted_on": "2016-06-09T13:10:43"
}
}
HTTP Method: POST
Request:
Body:
{
"token": "825D7B5BB7F62E043A7C73B0FFBF124F",
"accounts_receivable_identifier":{"number":"ACR0000000739"},
"type_identifier":{"name":"Payment"},
"life_cycle_state":"DRAFT",
"payment_method_identifier":{"name":"Cash"},
"payment_amount":"50",
"intended_currency_identifier":{"code":"USD"},
"received_on":"2016-05-09T09:12:54",
"received_by_user_identifier":{"username":"mpadministrator"},
"received_by_unit_identifier":{"name":"Admin Unit"},
"description":"Payment",
"notes":"Payment note"
}
Response:
{
"status": {
"code": "COM.CRM.EXCEPTION.INVALIDCURRENCYEXCEPTION",
"description": "Invalid currency %1. The currency must be %2.",
"message": "Invalid Currency USD. The Currency Must Be EUR."
}
}
HTTP Method: POST
Request:
Body:
{
"token":{{token}},
"wallet_identifier": {
"number": "W0000007376"
},
"type_identifier": {
"name": "Cash Payment"
},
"life_cycle_state":"POSTED",
"payment_method_identifier": {
"name": "Cash Payment"
},
"payment_amount": "10.00",
"received_on": "2017-09-15T09:20:00",
"received_by_user_identifier": {
"username":"mpadministrator"
},
"received_by_unit_identifier": {
"name": "Admin Unit"
},
"description": "Payment for invoice I00003802",
"notes": "Pay with cash",
"invoices_to_pay_set": [
{
"invoice_identifier": {
"id" : "54F3A49F23024C51AFF21B7C728F3549"
}
}
]
}
Response:
{
"data": {
"posted_on": "2017-09-15T11:23:29",
"number": "3868",
"payment_amount": 10,
"issued_on": "2017-09-15T11:23:29",
"currency_rate_period": null,
"id": "43461750EE734AD7978C94A9D5D74D81",
"life_cycle_state": "POSTED",
"reference_number": "4877"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: POST
Request:
Body:
{
"token":{{token}},
"wallet_identifier": {
"number": "W0000007376"
},
"type_identifier": {
"name": "Cash Payment"
},
"life_cycle_state":"POSTED",
"payment_method_identifier": {
"name": "Cash Payment"
},
"payment_amount": "30.00",
"received_on": "2017-09-15T09:20:00",
"received_by_user_identifier": {
"username":"mpadministrator"
},
"received_by_unit_identifier": {
"name": "Admin Unit"
},
"description": "Payment for Bill 1196",
"notes": "Pay with cash",
"bills_to_pay_set": [
{
"bill_identifier": {
"number" : "1196"
}
}
]
}
Response:
{
"data": {
"posted_on": "2017-09-15T11:35:23",
"number": "3872",
"payment_amount": 30,
"issued_on": "2017-09-15T11:35:23",
"currency_rate_period": null,
"id": "0643BEAB8E2D4E639435AD7081E95C95",
"life_cycle_state": "POSTED",
"reference_number": "4881"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: POST
Request:
Body:
{
"token":{{token}},
"accounts_receivable_identifier": {
"number": "ACR0000001146"
},
"type_identifier": {
"name": "Voucher Payment "
},
"life_cycle_state":"DRAFT",
"payment_method_identifier": {
"name": "Cash"
},
"payment_amount": "10.00",
"products_to_pay_set": [
{
"product_identifier": {
"code" : "MTV"
}
}
]
}
Response:
{
"data":
{
"posted_on": null,
"number": null,
"payment_amount": 10,
"issued_on": "2017-09-18T18:09:58",
"currency_rate_period": null,
"id": "C877EF68E82C4B52ACEC5334E445A4B9",
"life_cycle_state": "DRAFT",
"reference_number": "642"
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}