REST Payment Payment
List, get, create or update payments. Payments can come into plentymarkets automatically or can be booked manually. Existing payments can be filtered by payment method, by ID, by payment status, by transaction type, by order or by date. Existing payments can also be updated.
List payments of a payment method
Lists all payments of the a payment method. The ID of the payment method must be specified.
/rest/payments/methods/{methodId}
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Create Payment-Order-Relation
/rest/payment/{paymentId}/order/{orderId}
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment order relation |
| paymentId |
Int |
The ID of the payment |
| orderId |
Int |
The ID of the order |
| assignedAt |
String |
The time the payment order relation was assigned |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Delete Payment-Order-Relation
/rest/payment/{paymentId}/order
Success 200
This call does not have a response output.
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/payment/{paymentId}/contact/{contactId}
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment order relation |
| paymentId |
Int |
The ID of the payment |
| contactId |
Int |
The ID of the contact |
| assignedAt |
String |
The time the payment contact relation was assigned |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
/rest/payment/{paymentId}/contact
Success 200
This call does not have a response output.
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments
/rest/payments
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Update a payment
/rest/payments
Request
| Field |
Type |
Description |
| amount |
Float |
The amount of the payment required matching to /^[0-9]{1,9}[\.][0-9]{4}+$/ |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. required matching to /^[0-9]{1,9}[\.][0-9]{4}+$/ |
| mopId |
Int |
The ID of the payment method required matching to /^[0-9]+$/ |
| parentId |
Int |
The ID of the parent payment optional matching to /^[0-9]+$/ |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. optional matching to /^[0-1]$/ |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. optional matching to /^[0-1]$/ |
| currency |
String |
The currency of the payment in ISO 4217 code. required matching to /^[A-Z]{3}$/ |
| type |
String |
The payment type. Available types are credit and debit. required allowed values are debit, credit |
| status |
Int |
The status of the payment required matching to /^[1-9][0]?$/ |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
required matching to /^[1-3]$/ |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. optional |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. optional |
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Create a payment
/rest/payments
Request
| Field |
Type |
Description |
| amount |
Float |
The amount of the payment required matching to /^[0-9]{1,9}[\.][0-9]{4}+$/ |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. required matching to /^[0-9]{1,9}[\.][0-9]{4}+$/ |
| mopId |
Int |
The ID of the payment method required matching to /^[0-9]+$/ |
| parentId |
Int |
The ID of the parent payment optional matching to /^[0-9]+$/ |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. optional matching to /^[0-1]$/ |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. optional matching to /^[0-1]$/ |
| currency |
String |
The currency of the payment in ISO 4217 code. required matching to /^[A-Z]{3}$/ |
| type |
String |
The payment type. Available types are credit and debit. required allowed values are debit, credit |
| status |
Int |
The status of the payment required matching to /^[1-9][0]?$/ |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
required matching to /^[1-3]$/ |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. optional |
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
Get a payment
Gets a payment. The ID of the payment must be specified.
/rest/payments/{paymentId}
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments of a payment status
Lists all payments of a payment status. The ID of the payment status must be specified.
/rest/payments/status/{statusId}
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments of a transaction type
Lists all payments of a transaction type. The ID of the transaction type must be specified.
/rest/payments/transactions/{transactionTypeId}
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments of an order
Lists all payments of an order. The ID of the order must be specified.
/rest/payments/orders/{orderId}
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments by entry date
Lists all payments by entry date within a certain date range. The start and the end of the date range must be specified.
/rest/payments/entrydate
Parameters
| Field |
Type |
Description |
| startDate |
String |
The start date of the date range for the entry date of the payment |
| endDate |
String |
The end date of the date range for the entry date of the payment |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments by import date
Lists all payments by import date within a certain date range. The start and the end of the date range must be specified.
/rest/payments/importdate
Parameters
| Field |
Type |
Description |
| startDate |
String |
The start date of the date range for the import date of the payment |
| endDate |
String |
The end date of the date range for the import date of the payment |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |
List payments by property type ID and value
Lists all payments by the given property type ID and the value.
/rest/payments/property/{propertyTypeId}/{propertyValue}
Parameters
| Field |
Type |
Description |
| itemsPerPage |
Int |
The number of items to list per page |
| page |
Int |
The page of results to search for |
Success 200
Response is a List
| Field |
Type |
Description |
| id |
Int |
The ID of the payment |
| amount |
Float |
The amount of the payment |
| exchangeRatio |
Float |
The exchange rate. Exchange rates are used if the default currency saved in plentymarkets differs from the currency of the order. |
| parentId |
Int |
The ID of the parent payment |
| deleted |
Int |
A deleted payment. Deleted payments have the value 1 and are not displayed in the plentymarkets back end. |
| unaccountable |
Int |
An unassigned payment. Unassigned payments have the value 1. |
| currency |
String |
The currency of the payment in ISO 4217 code. |
| type |
String |
The payment type. Available types are credit and debit. |
| hash |
String |
The hash code of the payment. The hash code consists of 32 characters and is automatically generated. |
| origin |
Int |
The origin of the payment. The following origins are available:
- Undefined = 0
- System = 1
- Manually = 2
- SOAP = 3
- Import = 4
- Split payment = 5
- Plugin = 6
|
| receivedAt |
String |
The time the payment was received |
| importedAt |
String |
The time the payment was imported |
| status |
Int |
The status of the payment |
| transactionType |
Int |
The transaction type of the payment. The following transaction types are available:
- Interim transaction report = 1
- Booked payment = 2
- Split payment = 3
|
| mopId |
Int |
The ID of the payment method |
| regenerateHash |
Bool |
If $regenerateHash is true, regenerate the payment hash value. Default is false. |
| updateOrderPaymentStatus |
Bool |
If $updateOrderPaymentStatus is true, update the order payment status. Default is false. |
| isSystemCurrency |
Bool |
If $isSystemCurrency is false, the value will be converted to the standard currency with the provided exchange rate. If $isSystemCurrency is false, the value is not converted. Default is true. |
Errors 4xx
| Code |
Exception |
Description |
| 401 |
League\OAuth2\Server\Exception\AccessDeniedException |
The resource owner or authorization server denied the request. |
| 401 |
League\OAuth2\Server\Exception\InvalidRequestException |
The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter. |