„GET /billing/paymentmethods“ ändern

master
Thomas Brinkmann 3 years ago
parent 1162d51541
commit 1c409ee182
  1. 109
      GET-%2Fbilling%2Fpaymentmethods.md

@ -0,0 +1,109 @@
## **GET /billing/paymentmethods**
## **Inhalt**
---
- Parameter
- Optionale Parameter
- Beispiel Anfrage
- Beispiel Antwort
- Mögliche Fehlermeldungen
---
### Parameter
|URL Parameter | Typ | Beschreibung|
|----------|-----|-------------|
|- | -| -
|Body Parameter | Typ | Beschreibung|
|----------|-----|-------------|
| - | - | - |
---
### Optionale Parameter
|Query-String Parameter | Typ | Beschreibung|
|----------|-----|-------------|
|?page | integer | Beschreibt die aktuelle Seitenzahl
|?limit | integer | Beschreibt wieviele Elemente pro Seite angezeigt werden sollen
---
### Beispiel Anfrage
##### PHP
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'control.local/api/v2/billing/paymentmethods',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'X-TOKEN: test-token',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
##### cURL
```bash
curl --location --request GET 'control.local/api/v2/billing/paymentmethods' \
--header 'X-TOKEN: test-token' \
--header 'Content-Type: application/json'
```
---
### Beispiel Antwort
```json
{
"status": "OK",
"totalResults": 6,
"page": 1,
"itemsPerPage": 10,
"maxPages": 1,
"items": [
{
"id": "paysafecard",
"displayname": "PaySafeCard"
},
{
"id": "paypal",
"displayname": "PayPal"
},
{
"id": "sofort",
"displayname": "Klarna (Sofortüberweisung)"
},
{
"id": "banktransfer",
"displayname": "SEPA - Überweisung (Bevorzugt)"
},
{
"id": "coingate",
"displayname": "CoinGate (CryptoCurrencies)"
},
{
"id": "dshstripe",
"displayname": "Mastercard/Visa | Creditcard"
}
]
}
```
### Mögliche Fehlermeldungen
> :warning: Status Code **403** - Permission denied
> :warning: Status Code **500** - Payment Methods could not be fetched!
Loading…
Cancel
Save