This page describes the possible operations on a transaction created via Axepta BNP Paribas Online:
- Capture (automatic, delayed, manual, partial)
- Cancellation (before capture)
- Refund (after capture)
Content
Use case: Authorize, Capture, Cancellation, Refund
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
When initializing the transaction, you can control the behavior via the captureMethod object.
"captureMethod": { "type": "AUTOMATIC" | "DELAYED" | "MANUAL"}
If captureMethod is missing → automatic capture by default.
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).
Unless you have specific use cases, this is the mode to prioritize.
Recommended use cases
- Classic e-commerce payment
- Process without complex inventory management
- Merchants not needing to check availability before capture
Automatic delayed capture (DELAYED)
Functional
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.
This capture must be carried out within 7 days following authorization, in agreement with the funds guarantee deadline at the bank.
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.
Use case
- Deferred stock verification
- Manual checks before shipping
- Anti-fraud requiring a delay before capture
Integration
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.
This capture must be carried out within 7 days following authorization, in agreement with the funds guarantee deadline at the bank.
Integration
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": "MANUAL"
},
...
Cancellation
Functional
- Cancellation is possible only if the transaction has not been captured (capturedValue = 0).
- It allows to release the funds reserved on the customer's card.
The cancellation cannot be partial. The cancelled amount = authorized amount.
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.
The status affects the number of calls required.
Status | Meaning | Action of the Reversal Call | Number of Calls Required |
OK | Capture requested but not executed | Cancels the capture request → changes to AUTHORIZED | 2 calls |
AUTHORIZED | Authorization pending capture | Cancels the authorization | 1 call |
Refund
Functional
Only a transaction already captured (capturedValue > 0) or settled (status Sale) can be refunded.
The refund can be total or partial refund.
Several successive refunds possible up to the captured amount.
Integration
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.