Deze pagina beschrijft de mogelijke bewerkingen op een transactie die via Axepta BNP Paribas Online is aangemaakt:

  • Capture (automatic, delayed, manual, partial)
  • Annulering (voor capture)
  • Terugbetaling (na capture)


Inhoudstafel



Gebruiksscenario: Autorisatie, Capture, Annulering, Terugbetaling

Autorisatie

Wanneer een kaarttransactie wordt aangemaakt, wordt een autorisatieverzoek naar de bank van de kaarthouder gestuurd om het bedrag te reserveren. Zolang de vastlegging niet is uitgevoerd, wordt het bedrag niet afgeschreven.

Capture/Vastlegging

Capture of vastlegging verwijst naar het verzoek voor de daadwerkelijke overschrijving. Dit is de stap waarbij het bedrag effectief van de kaarthouder wordt afgeschreven.

Annulering

Een annulering is mogelijk zolang de capture/vastlegging nog niet heeft plaatsgevonden. De gereserveerde middelen worden onmiddellijk vrijgegeven.

Terugbetaling

Een terugbetaling wordt uitgevoerd op een transactie die al is vastgelegd. Deze kan volledig of gedeeltelijk zijn.



Vastlegging/Capture

Bij het initialiseren van de transactie kan het gedrag worden bepaald via het captureMethod-object.


"captureMethod": {  "type": "AUTOMATIC" | "DELAYED" | "MANUAL"}


Als captureMethod ontbreekt → standaard automatische vastlegging.



Automatische vastlegging (standaardmodus)

Functioneel

Het vastleggingsverzoek wordt automatisch uitgevoerd direct na de autorisatie.

Er is geen actie vereist; de transactie wordt tijdens de volgende verzamelcyclus (eind van de dag) voor afhandeling verzonden.


Tenzij u specifieke gebruiksscenario's heeft, is dit de aanbevolen modus.


Aanbevolen gebruiksscenario's

  • Klassieke e-commercebetaling
  • Proces zonder complexe voorraadbeheer
  • Handelaars die geen beschikbaarheid hoeven te controleren voor vastlegging

Automatische uitgestelde vastlegging (DELAYED)


Functioneel

Bij het aanvragen van een transactie is het mogelijk een tijdslimiet (in uren) op te geven voordat het vastleggingsverzoek wordt uitgevoerd.

Deze optie zorgt ervoor dat de transactie niet wordt vastgelegd tijdens deze periode.

De betaling kan met één dag worden uitgesteld als de deadline de dagelijkse afwikkelingstijd overschrijdt.


Deze vastlegging moet binnen 7 dagen na autorisatie worden uitgevoerd, in overeenstemming met de geldigheidsduur van de fondsenreservering bij de bank.

Functies

  • De deadline zorgt ervoor dat er gedurende X uren geen vastlegging plaatsvindt.
  • Maakt eenvoudige annulering van de transactie voor vastlegging mogelijk.
  • Kan de bankafhandeling met één dag verschuiven als de deadline de afwikkelingstijd overschrijdt.


Gebruiksscenario

  • Uitgestelde voorraadcontrole
  • Handmatige controles voor verzending
  • Fraudebestrijding die een vertraging voor vastlegging vereist


Integratie

Met het Capture kunt u de middelen vastleggen aan de hand van de payId van de oorspronkelijke transactie.

(Optioneel bedrag → gedeeltelijke vastlegging als dit afwijkt van het geautoriseerde bedrag.)


...
	"captureMethod": {
		"type": "DELAYED",
		"delayed": {
			"delayedHours": 2
		}
    },
...

Manual Capture (MANUAL)


Functioneel

Handmatige vastlegging maakt het mogelijk om het volledige bedrag of slechts een deel van het geautoriseerde bedrag vast te leggen.

Wanneer slechts een deel van het bedrag wordt vastgelegd, spreekt men van een gedeeltelijke vastlegging.

Bij deze optie wordt de vastlegging nooit automatisch uitgevoerd; het is essentieel om een vastleggingsopdracht te verzenden om de middelen te innen.

De bankafwikkelingsdatum voor deze transacties zal de datum van het vastleggingsverzoek zijn.


Deze vastlegging moet binnen 7 dagen na de autorisatie worden uitgevoerd, conform de geldigheidsduur van de fondsengarantie bij de bank.


Integratie

Via het Capture-eindpunt kunnen de middelen worden vastgelegd met behulp van de payId van de oorspronkelijke transactie.

(Optioneel bedrag → gedeeltelijke vastlegging indien afwijkend van het geautoriseerde bedrag.)


...
	"captureMethod": {
		"type": "MANUAL"
    },
...




Annulering


Functioneel

  • Annulering is alleen mogelijk als de transactie niet is vastgelegd (capturedValue = 0).
    Hiermee worden de op de kaart van de klant gereserveerde middelen vrijgegeven.


Annulering kan niet gedeeltelijk gebeuren. Het geannuleerde bedrag = het geautoriseerde bedrag.


Integratie

Het Reverse -endpunt maakt het mogelijk om een transactie (of een stap binnen de transactie) te annuleren. Hiervoor moet het `payId` van de oorspronkelijke transactie worden meegegeven.


De status bepaalt het aantal benodigde oproepen.


Status

Betekenis

Actie van de Reverse-oproep

Aantal benodigde oproepen

OK

Verwerking aangevraagd maar niet uitgevoerd

Annuleert het verzoek → status wordt AUTHORIZED

2 calls

AUTHORIZED

Autorisatie in afwachting van verwerking

Annuleert de autorisatie

1 call


Terugbetaling

Functioneel

Alleen een transactie die al is afgeschreven (capturedValue > 0) of vereffend (status "Sale") kan worden terugbetaald.

De terugbetaling kan volledig of gedeeltelijk zijn.

Meerdere opeenvolgende terugbetalingen zijn mogelijk, tot het afgeschreven bedrag.


Integratie

Het Refund endpunt maakt het mogelijk om een terugbetaling te starten voor een reeds vereffende transactie. Hiervoor moet het `payId` van de te terugbetalen transactie worden opgegeven.


Moet ik mijn transactie annuleren of terugbetalen?

Bij het beheer van transacties is het essentieel om duidelijk onderscheid te maken tussen situaties waarin een betaling geannuleerd moet worden en situaties waarin een terugbetaling nodig is.

In dit gedeelte worden de belangrijkste stappen beschreven om de meest geschikte actie te bepalen wanneer een bestelling niet kan worden uitgevoerd.

Of het nu om logistieke, technische of andere redenen gaat, het is cruciaal om de betalingsstatus en de bijbehorende bedragen te begrijpen.

Door deze elementen te controleren, kan worden bepaald of de betaling geannuleerd moet worden (wanneer de gelden nog niet door de houder zijn opgeëist) of terugbetaald moet worden (wanneer de gelden wel zijn opgeëist). Deze aanpak zorgt voor transparant en compliant beheer dat aansluit bij de verwachtingen van de klant en tegelijkertijd operationele processen optimaliseert.

Als de transactie is betaald, is de klant gedebiteerd. In dit geval moet een terugbetaling worden gestart.

Als de transactie niet is betaald, is de klant niet gedebiteerd. In dit geval moet een annulering worden gestart.



Voor alle bewerkingen is het nodig om de betalingsreferentie 'payId' te gebruiken die door het betaalplatform tijdens de transactie is geretourneerd.



Stap 1: Controleer de transactiestatus



Het GetByPayId eindpunt stelt u in staat om de transactie-informatie op te halen door het bijbehorende payId op te geven.


{
  "amount": {
    "currency": "EUR",
    "value": 1000,
	"capturedValue": 1000
  },
  "externalIntegrationId": "12345-abcde-67890-fghij",
  "language": "en",
  "payId": "ed7773c09f314c45b2a0de47a1994e1d",
  "xId": "86a8198cc9da4b4d9fbcdb15a5ddd6ca",
  "transId": "20240103-121913-554",
  "status": "OK",
  "responseCode": "00000000",
  "responseDescription": "success",
  "refNr": "refNr01",
  "metadata": {
    "userData": "my user data",
    "plain": "some plain text",
    "key1": "value1",
    "key2": "value2"
  },
  "paymentMethods": {
    "type": "CARD",
    "card": { … }
  }
}

 Om te bepalen of een transactie geannuleerd of terugbetaald moet worden, moeten de eigenschappen 'status' en 'responseCode' van de transactie worden geraadpleegd:

  • de eigenschap 'status' moet gelijk zijn aan "OK" of "AUTHORIZED" (relevant voor annulering)
    de eigenschap 'responseCode' moet gelijk zijn aan "00000000"..
  • Raadpleeg de Responscodes / Foutcodes voor details over de responsecodes.


   "status": "OK",
   "responseCode": "00000000",



Stap 2: Controleer de transactiebedragen


De bedragen van de transactie zijn gedetailleerd opgenomen in het JSON-object 'amount'.


   "amount": {
    "currency": "EUR",
    "value": 1000,
	"capturedValue": 1000
  },


Het is nodig om de bedragen 'value' en 'capturedValue' te raadplegen:

  • 'value': Geautoriseerd bedrag. Dit moet groter zijn dan nul.
    Als dit gelijk is aan nul, betekent dit dat de transactieautorisatie is mislukt en dat de transactie niet is doorgevoerd.

  • 'capturedValue': Bedrag van de afgeschreven transactie.



'capturedValue' bepaalt of een terugbetaling of annulering moet worden gestart:


  • Als capturedValue = 0: de transactie is niet afgeschreven => Annulering
  • Als capturedValue > 0: de transactie is afgeschreven => Terugbetaling



Step 3a: Terugbetaling 

Het Refund eindpunt maakt het mogelijk om een terugbetaling te starten voor een reeds vereffende transactie. Hiervoor moet het payId van de te terugbetalen transactie worden opgegeven.

Het terug te betalen bedrag kan het volledige of een deel zijn van het oorspronkelijke transactiebedrag (gedeeltelijke terugbetaling).
Het is mogelijk om een reeks gedeeltelijke terugbetalingen uit te voeren tot het geautoriseerde bedrag.


Step 3b: Annulering

Het Reverse eindpunt maakt het mogelijk om een transactie (of een stap binnen de transactie) te annuleren. Hiervoor moet het payId van de oorspronkelijke transactie worden opgegeven.

Het te annuleren bedrag moet precies gelijk zijn aan het geautoriseerde bedrag. Gedeeltelijke annuleringen zijn niet mogelijk.



Annulering kan in 1 of 2 stappen gebeuren, afhankelijk van of de afschrijvingsaanvraag al is gedaan.



Het Reverse eindpunt maakt het volgende mogelijk:

  • De afschrijvingsaanvraag annuleren en teruggaan naar de stap 'Authorized', als de transactie in afwachting is van afschrijving.
  • De autorisatieaanvraag annuleren en de volledige transactie definitief annuleren, als de transactie geautoriseerd is en de afschrijvingsaanvraag niet is gedaan.


Om te weten in welke stap de transactie zich bevindt, moet de 'status' worden gecontroleerd:

  • "OK"
    De afschrijving is aangevraagd maar nog niet uitgevoerd.
    De transactie is in afwachting van afschrijving.
    De API-oproep naar Reverse zal de afschrijvingsaanvraag annuleren en de transactiestatus wijzigen in "AUTHORIZED".
  • "AUTHORIZED"
    De afschrijvingsaanvraag is niet gedaan (of is geannuleerd).
    De API-oproep naar Reverse zal de autorisatie annuleren.
    De tijdens de autorisatie gereserveerde middelen worden vrijgegeven.
    De transactie is definitief geannuleerd.


In conclusie:

  • Om een transactie met status "OK" te annuleren, zijn 2 oproepen naar het Reverse -eindpunt nodig
    • een eerste oproep om de afschrijvingsaanvraag te annuleren en een tweede om de autorisatie te annuleren
  • Om een transactie met status "AUTHORIZED" te annuleren, is 1 oproep naar het Reverse -eindpunt nodig:
    • een enkele oproep om de autorisatie te annuleren