REST Payment Method
List, create or update payment methods. Payment methods are required to integrate plugins of payment providers and markets. The payment method must also be specified in payments and orders.
List payment methods
Lists all payment method plugins.
/rest/payments/methods
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 method |
| pluginKey |
String |
The plugin key of the payment method |
| paymentKey |
String |
The payment key of the payment method |
| name |
String |
The name of the payment method |
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 method
Gets a payment method plugin. The plugin key must be specified.
/rest/payments/methods/plugins/{pluginKey}
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 method |
| pluginKey |
String |
The plugin key of the payment method |
| paymentKey |
String |
The payment key of the payment method |
| name |
String |
The name of the payment method |
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 method
Creates a payment method. The plugin key, the payment key and the name of the payment method must be specified.
/rest/payments/methods
Request
| Field |
Type |
Description |
| name |
String |
The name of the payment method required matching to /^[A-Za-z]+[A-Za-z0-9]+$/ |
| pluginKey |
String |
The plugin key of the payment method required matching to /^[A-Za-z]+[A-Za-z0-9]+$/ value must be unique |
| paymentKey |
String |
The payment key of the payment method required matching to /^[A-Za-z]+[A-Za-z0-9]+$/ value must be unique |
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment method |
| pluginKey |
String |
The plugin key of the payment method |
| paymentKey |
String |
The payment key of the payment method |
| name |
String |
The name of the payment method |
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 method
Updates the name of the payment method. The name of the payment method must be specified.
/rest/payments/methods
Request
| Field |
Type |
Description |
| name |
String |
The name of the payment method required matching to /^[A-Za-z]+[A-Za-z0-9]+$/ |
Success 200
| Field |
Type |
Description |
| id |
Int |
The ID of the payment method |
| pluginKey |
String |
The plugin key of the payment method |
| paymentKey |
String |
The payment key of the payment method |
| name |
String |
The name of the payment method |
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 EBICS Accounts
/rest/payments/methods/ebics
Success 200
[{"id": 1, "accountName": "Account Name", "storeId": "-1", "eSignature": "A005"},{"id": 2, "accountName": "Other Account Name", "storeId": "-1", "eSignature": "A005"}]
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 an EBICS Account
/rest/payments/methods/ebics
Parameters
| Field |
Type |
Description |
| name |
String |
The name of the EBICS Account |
Success 200
{"accountName": "The Account Name", "id": 4}
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. |
Returns the HBCI-Account count
/rest/payments/methods/hbci
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. |
Get a preview list for payment methods.
/rest/payments/methods/preview/{language?}
Parameters
| Field |
Type |
Description |
| language |
String |
|
Success 200
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. |