Alliance Partners - Beheren van Submerchants geldstromen
1. Submerchants ophalen
Request
In dit request voorbeeld halen wij (alle) onderliggende Submerchans op voor een Alliantie account door het aanroepen van het Alliance::getMerchants endpoint. Deze aanroep kan gestart worden met het token van de Alliance Partner. Hierdoor is het niet nodig een verplicht veld mee te geven en haalt de aanroep automatisch alle M-codes (submerchants) op die gekoppeld zijn aan het Alliantie account. Optioneel kan er gefilterd worden op
Request code: Merchantlijst ophalen via API
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
| Pameter | Type | Veld | Omschrijving |
|---|---|---|---|
| state | array | OPTIONEEL | De status van de merchants die je terug wilt hebben in de lijst. Mogelijke waardes: 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. Transactierapportages ophalen van jouw merchants
For a quick start, please refer to the sample in the php SDK or call the Statistics::Management
Full documentation coming soon
3. Clearings uitbetalen via jouw eigen systeem
Wanneer je als merchant of partner via de Merchant::addClearing API een opname initieert, kan dit verwarring opleveren op de clearingfactuur als het opgenomen bedrag afwijkt van de som van de individuele transacties. Hieronder leggen we uit hoe dit werkt aan de hand van een voorbeeld.
3.1 Voorbeeldsituatie
Stel: een merchant heeft het volgende beschikbare boeksaldo:
| Betalingstype | Aantal | Bedrag per type |
|---|---|---|
| iDeal | 50 | € 5.000 |
| Creditcard | 10 | € 2.000 |
| Bancontact | 5 | € 2.500 |
| Overboeking | 5 | € 500 |
| Totaal | € 10.000 |
De partner initieert een clearing via de API met een opname van € 6.000.
Wat gebeurt er?
- Het beschikbare boeksaldo bedraagt € 10.000.
- De partner wil slechts € 6.000 laten uitbetalen.
- Echter: de transacties die tot het saldo leiden zijn nog niet verwerkt in een clearing.
- Om toch een juiste specificatie van de clearing te tonen (en reconciliatie mogelijk te maken), doen wij het volgende:
De oplossing in de clearingfactuur
- We maken een extra omzetregel “Clearing beginsaldo” van € -4.000 om het boeksaldo te verlagen tot het gewenste bedrag.
- We maken de clearing inclusief deze nieuwe omzetregel om tot een correcte clearing te komen van het gewenste bedrag van € 6.000 (€10.000 tegoed min de € 4.000)
- Na het maken creëren we wederom een extra omzetregel genaamd “Clearing eindsaldo” van € +4.000 om de regel “Clearing eindsaldo” te compenseren. Het boeksaldo wordt hierdoor hersteld tot de €4.000 die over is gebleven.
Voorbeeld op de clearingfactuur
| Betalingstype | Aantal | Bedrag per type |
|---|---|---|
| iDeal | 50 | € 5.000 |
| Creditcard | 10 | € 2.000 |
| Bancontact | 5 | € 2.500 |
| Overboeking | 5 | € 500 |
| Pay.betaling - Clearing beginsaldo | 1 | - € 4.000 |
| Totaal | € 6.000 |
De Clearing eindsaldo zie je vervolgens terug als correctie om het eerdere "beginsaldo" te compenseren. In een volgende clearing wordt het bedrag dan weer meegenomen als startbedrag (in onderstaand voorbeeld is het beschikbare saldo €14.000 en zal er een clearing plaatsvinden van €12.000):
| Betalingstype | Aantal | Bedrag per type |
|---|---|---|
| Pay.betaling - Clearing eindsaldo | 1 | € 4.000 |
| iDeal | 45 | € 4.500 |
| Creditcard | 12 | € 3.000 |
| Bancontact | 5 | € 1.500 |
| Overboeking | 5 | € 1.000 |
| Pay.betaling - Clearing beginsaldo | 1 | - € 2.000 |
| Totaal | € 6.000 |
3.2 Waarom is dit belangrijk?
- Hierdoor blijft het voor merchants mogelijk om hun transacties correct te reconciliëren met de clearing waarin de daadwerkelijke opname plaatsvond.
- Alle transacties die bijdroegen aan het boeksaldo zijn immers al meegenomen in de clearing waar deze opname betrekking op had.
- Ze worden dus niet opnieuw meegenomen in de volgende clearing – dat zou anders tot dubbeltellingen leiden.
3.3 Belangrijk om te weten als partner
- Gebruik je een opnamebedrag in de API dat lager is dan het actuele boeksaldo, dan zullen we het verschil automatisch intern corrigeren met een beginsaldo/eindsaldo-paar.
- Deze worden dus niet uitgekeerd en zijn puur intern bedoeld voor correcte rapportage en reconciliatie.
4. Facturen verrekenen met boeksaldo submerchant
For a quick start, please refer to the sample in the php SDK or call the Alliance::addInvoice
Full documentation coming soon