Alliance Partner – Verwaltung der Geldströme von Submerchants
1. Sub-Händler abrufen
Request
In diesem Request-Beispiel rufen wir mit dem Endpoint Alliance::getMerchants alle untergeordneten Submerchants eines Alliance-Kontos ab. Dieser Aufruf kann mit dem Token des Alliance Partners ausgeführt werden. Dadurch ist kein Pflichtfeld erforderlich und der Aufruf liefert automatisch alle M-Codes (Submerchants), die mit dem Alliance-Konto verknüpft sind.
Optional kann nach Status gefiltert werden.
Request-Code: Merchant-Liste über die API abrufen
curl --request POST
--url https://rest-api.pay.nl/v6/Alliance/getMerchants/json
--header 'authorization: Basic dG9rZW46PHlvdXItYXBpLXRva2VuPg=='
--header 'cache-control: no-cache'
--header 'content-type: application/x-www-form-urlencoded'
--data-urlencode 'state=accepted'
Parameters
| Parameter | Typ | Feld | Beschreibung |
|---|---|---|---|
| state | array | OPTIONAL | Der Status der Merchants, die in der Liste zurückgegeben werden sollen. Mögliche Werte: new accepted deleted |
Response
Response: Alliance::addMerchant
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"merchantId": ""M-####-####"",
"merchantName": "",
"packageType": "",
"invoiceAllowed": "M-####-####",
"payoutInterval": "***********",
"createdDate": "***********",
"acceptedDate": "***********",
"deletedDate": "***********",
"services": [
{
"serviceId": "A-####-####",
"serviceName": "director@classic-carparts.nl"
},
{
"serviceId": "A-####-####",
"serviceName": "finance@classic-carparts.nl"
}
]
}
]
2. Transaktionsberichte Ihrer Merchants abrufen
Für einen schnellen Einstieg verwenden Sie bitte das Beispiel im php SDK oder rufen Sie Statistics::Management auf.
Vollständige Dokumentation folgt in Kürze
3. Clearings über Ihr eigenes System auszahlen
Wenn Sie als Merchant oder Partner über die API Merchant::addClearing eine Auszahlung initiieren, kann dies auf der Clearing-Rechnung zu Unklarheiten führen, wenn der Auszahlungsbetrag von der Summe der einzelnen Transaktionen abweicht. Nachfolgend erläutern wir dies anhand eines Beispiels.
3.1 Beispielsituation
Angenommen, ein Merchant verfügt über folgendes verfügbares Kontoguthaben:
| Zahlungsart | Anzahl | Betrag |
|---|---|---|
| iDEAL | 50 | € 5.000 |
| Kreditkarte | 10 | € 2.000 |
| Bancontact | 5 | € 2.500 |
| Überweisung | 5 | € 500 |
| Gesamt | € 10.000 |
Der Partner initiiert über die API ein Clearing mit einer Auszahlung von € 6.000.
Was passiert?
- Das verfügbare Kontoguthaben beträgt € 10.000.
- Der Partner möchte lediglich € 6.000 auszahlen lassen.
- Die Transaktionen, aus denen dieses Guthaben besteht, wurden jedoch noch keinem Clearing zugeordnet.
Um dennoch eine korrekte Aufschlüsselung auf der Clearing-Rechnung darzustellen und eine Abstimmung zu ermöglichen, gehen wir wie folgt vor:
Die Lösung auf der Clearing-Rechnung
- Wir erstellen eine zusätzliche Umsatzzeile „Clearing Anfangssaldo“ über € -4.000, um das Guthaben auf den gewünschten Betrag zu reduzieren.
- Anschließend erstellen wir das Clearing einschließlich dieser neuen Umsatzzeile, sodass ein korrektes Clearing über € 6.000 entsteht (€ 10.000 Guthaben minus € 4.000).
- Danach erstellen wir erneut eine zusätzliche Umsatzzeile mit der Bezeichnung „Clearing Endsaldo“ über € +4.000, um die Zeile „Clearing Anfangssaldo“ auszugleichen. Dadurch wird das verbleibende Guthaben von € 4.000 wiederhergestellt.
Beispiel auf der Clearing-Rechnung
| Zahlungsart | Anzahl | Betrag |
|---|---|---|
| iDEAL | 50 | € 5.000 |
| Kreditkarte | 10 | € 2.000 |
| Bancontact | 5 | € 2.500 |
| Überweisung | 5 | € 500 |
| Pay.Zahlung – Clearing Anfangssaldo | 1 | - € 4.000 |
| Gesamt | € 6.000 |
Der Clearing Endsaldo wird anschließend als Korrektur ausgewiesen, um den zuvor verwendeten Anfangssaldo auszugleichen. In einem späteren Clearing wird dieser Betrag erneut als Startsaldo berücksichtigt (im folgenden Beispiel beträgt das verfügbare Guthaben € 14.000 und es wird ein Clearing von € 12.000 durchgeführt):
| Zahlungsart | Anzahl | Betrag |
|---|---|---|
| Pay.Zahlung – Clearing Endsaldo | 1 | € 4.000 |
| iDEAL | 45 | € 4.500 |
| Kreditkarte | 12 | € 3.000 |
| Bancontact | 5 | € 1.500 |
| Überweisung | 5 | € 1.000 |
| Pay.Zahlung – Clearing Anfangssaldo | 1 | - € 2.000 |
| Gesamt | € 12.000 |
3.2 Warum ist das wichtig?
Dadurch bleibt es für Merchants möglich, ihre Transaktionen korrekt mit dem Clearing abzugleichen, in dem die tatsächliche Auszahlung stattgefunden hat.
Alle Transaktionen, die zum Kontoguthaben beigetragen haben, wurden bereits in dem Clearing berücksichtigt, auf das sich die Auszahlung bezieht.
Sie werden daher nicht erneut in einem späteren Clearing berücksichtigt, da dies andernfalls zu Doppelzählungen führen würde.
3.3 Wichtig für Partner
Wenn Sie in der API einen Auszahlungsbetrag verwenden, der niedriger ist als das aktuelle Kontoguthaben, korrigieren wir die Differenz automatisch intern mit einem Anfangssaldo-/Endsaldo-Paar.
Diese Beträge werden nicht ausgezahlt und dienen ausschließlich der korrekten Berichterstattung und Abstimmung.
4. Rechnungen mit dem Kontoguthaben des Submerchants verrechnen
Für einen schnellen Einstieg verwenden Sie bitte das Beispiel im php SDK oder rufen Sie Alliance::addInvoice auf.
Vollständige Dokumentation folgt in Kürze