Page History

This page describes the possible operations on a transaction created Deze pagina beschrijft de mogelijke bewerkingen op een transactie die via Axepta BNP Paribas Online is aangemaakt:

• Capture (automatic, delayed, manual, partial)
• Cancellation Annulering (before capturevoor vastlegging)Refund
• Terugbetaling (after capturena vastlegging)

Content

 Gebruiksscenario:

Autorisatie,

Vastlegging,

Annulering,

Terugbetaling

Authorize

When a card transaction is created, an authorization is sent to the cardholder's bank to reserve the amount.

As long as the capture is not made, the funds are not debited.

Capture

The capture refers to the request for bank transfer.

This is the step that triggers the actual debit of the cardholder.

Cancellation

A cancellation is possible as long as the capture has not already been made.

She immediately releases the reserved funds.

Refund

A refund is made on a transaction already captured.

It can be total or partial.

Capture

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.

Vastlegging

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 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

Bij het initialiseren van de transactie kan het gedrag worden bepaald via het captureMethod-When initializing the transaction, you can control the behavior via the captureMethod object.

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

Automatic capture (default mode)

Functional

The capture request is performed automatically right after the authorization.

No action is required, the transaction will be sent for settlement during the next collection cycle (end of day).

 Recommended use cases

• Classic e-commerce payment
• Process without complex inventory management
• Merchants not needing to check availability before capture

Automatic delayed capture (DELAYED)

When requesting a transaction, it is possible to specify a time limit (in hours) before the capture request is executed.

This option makes it possible to ensure that the transaction will not be captured during this period.

The payment may be delayed by one day if the deadline exceeds the daily settlement time.

Features

• The deadline ensures that no capture will occur during X hours.
• Allows for easy cancellation of the transaction before capture.
• May shift the banking settlement by one day if the deadline exceeds the settlement time.

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.

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.

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

• Deferred stock verification
• Manual checks before shipping
• Anti-fraud requiring a delay before capture

The Capture endpoint allows capturing the funds using the payId of the original transaction.

(Optional amount → partial capture if different from the authorized amount.)

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

Manual Capture (MANUAL)

Functional

Manual capture allows for capturing all or only part of the authorized amount.

In the case where part of the amount is captured, this is referred to as partial capture.

So, with this option, the capture is never executed automatically; it is essential to send a capture order for the funds to be collected.

The banking settlement date for these transactions will be the date of the capture request.

Integration

The Capture endpoint allows capturing the funds using the payId of the original transaction.

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.

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(Optional amount → partial capture if different from the authorized amount.)

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

Cancellation

Functional

Functioneel

• Annulering is alleen mogelijk als de transactie niet is vastgelegd Cancellation is possible only if the transaction has not been captured (capturedValue = 0).
  It allows to release the funds reserved on the customer's cardHiermee worden de op de kaart van de klant gereserveerde middelen vrijgegeven.

Integration

The Reverse endpoint allows to cancel a transaction (or a step of the transaction). It is necessary to provide the payId of the original transaction.

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.

Terugbetaling

Functional

Functioneel

Alleen een transactie die al is afgeschreven Only a transaction already captured (capturedValue > 0) or settled of vereffend (status "Sale) can be refunded.

The refund can be total or partial refund.

Several successive refunds possible up to the captured amount.

The Refund endpoint allows you to initiate a refund on an already settled transaction. It is necessary to provide the payId of the transaction to be refunded.

Should I cancel or refund my transaction?

") 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.

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

In the context of transaction management, it is essential to clearly distinguish between situations requiring the cancellation of a payment and those requiring a refund.

This section describes the key steps to determine the best action to take when an order cannot be fulfilled.

Whether for logistical, technical, or other reasons, understanding the payment status and the amounts involved is essential.

By checking these elements, it will be possible to determine whether the payment should be canceled (when the funds have not been claimed by the holder) or refunded (when the funds have indeed been claimed). This approach ensures transparent and compliant management with client expectations, while optimizing operational processes.

Step 1: Check the transaction status

The GetByPayId endpoint allows you to recover the transaction information by providing the corresponding payId.

{
  "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": { … }
  }
}

 To determine whether it is necessary to cancel or refund a transaction, it is necessary to consult the properties 'status' and 'responseCode' of the transaction:

 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.
• the property 'status' must be equal to "OK" or "AUTHORIZED" (to keep if cancellation is needed)
• the property 'responseCode' must be equal to "00000000".
  • Refer to Codes réponse / Error codes (1) for details on the response codes

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

Stap 2:

Controleer de transactiebedragen

De bedragen van de transactie zijn gedetailleerd opgenomen in het JSON-

The amounts of the transaction are detailed in the JSON object 'amount'.

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

It is necessary to consult the amounts Het is nodig om de bedragen 'value' and en 'capturedValue' te raadplegen:

• 'value': Authorized amount. It must be greater than zero.

• 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': Amount of the captured transactionBedrag van de afgeschreven transactie.

Step 3a:

Terugbetaling 

HetRefund 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.

The Refund endpoint allows you to initiate a refund on an already settled transaction. It is necessary to provide the payId of the transaction to be refunded.

Step 3b:

Annulering

The Reverse endpoint allows you to cancel a transaction (or a step of the transaction). It is necessary to provide the payId of the original transaction.

The Reverse endpoint allows for:

• Cancel the capture request and return to the 'Authorized' step, if the transaction is pending capture.
• Cancel the authorization request, and definitively cancel the entire transaction, if the transaction is authorized and the capture request has not been made.

To know at what step the transaction is, you need to check its 'status':

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 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 "OK"
  The capture has been requested but has not been done yet.
  The transaction is pending capture.
  The API call to reverse will cancel the capture request and change the transaction status to "AUTHORIZED".

• "AUTHORIZED"
  The request for capture was not made (or was canceledDe afschrijvingsaanvraag is niet gedaan (of is geannuleerd).
  The API call to reverse will cancel the authorization.
  The funds reserved during the authorization will be released.
  The transaction is definitely cancelledDe API-oproep naar Reverse zal de autorisatie annuleren.
  De tijdens de autorisatie gereserveerde middelen worden vrijgegeven.
  De transactie is definitief geannuleerd.