Interfaces
Integration Guide
Partial Captures
Saferpay does offer the option to do Partial Captures (Hereafter refered to as Multipart Captures) on transactions, made with certain payment methods. Multipart Captures split the money authorized during one transactions into multiple batches, enabling the merchant to only capture the amount he wants to obtain e.g. for deliviering a part of a certain order.
Requirements
- 1.
- 2.No MultipartCapture request should be sent before receiving the response of a preceeding request (i.e. no parallel calls are allowed). The timeout for this are 100 seconds.
- 3.The sum of multipart captures must not exceed the authorized amount.
- 4.A unique OrderPartId must be used for each request.
- 5.​Multipart Captures execute the money-flow (closing) with the execution of the capture itself! A Cancel of a Multipart Capture therefore is not possible!
- 6.
Note, that you cannot mix the Multipart Capture and the Normal Capture within one transaction. Either do one, or the other!
Executing a Multipart Capture
Before you can even execute a Multipart Capture, you, of course, need a transaction, that needs to be captured. This can be any normal authorization, either done by the Payment Page, or Transaction Interface. You don't have to consider anything special, up to this point!
Additionally to the standard parameters, needed to execute a Capture, the following parameters are important for a Multipart Capture:
- Type: The Type specifies, whether this is one of many subsequent, or the final Capture.
- OrderPartId: Each Multipart Capture is identified by a unique OrderPartId, which will also be forwarded to the respective reconciliation-files you will recieve later. That makes this Id very important for later identification, thus you have to make sure, that said Id is set as unique, so confusions can be averted.
Request
Response
1
{
2
"RequestHeader": {
3
"SpecVersion": "1.10",
4
"CustomerId": "[your customer id]",
5
"RequestId": "[unique request identifier]",
6
"RetryIndicator": 0
7
},
8
"TransactionReference": {
9
"TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
10
},
11
"Amount": {
12
"Value": 1000,
13
"CurrencyCode": "CHF"
14
},
15
"Type": "PARTIAL",
16
"OrderPartId": "123456789"
17
}
Copied!
1
{
2
"ResponseHeader": {
3
"SpecVersion": "1.10",
4
"RequestId": "[unique request identifier]"
5
},
6
"CaptureId": "723n4MAjMdhjSAhAKEUdA8jtl9jb_c",
7
"Status": "CAPTURED",
8
"Date": "2018-08-08T12:45:22.258+01:00"
9
}
Copied!
Each capture is identified by a CaptureId (Marked with the suffix "_c") , which should be saved, since this Id is used for further actions, like refunds. More on the latter later in this very chapter.
The basic reservation times mentioned here do still apply for Multipart Captures! If this time is exceeded, the reservation could void and the money flow will be rejected by the card holders bank!
The overall amount you submit is not checked on the test-environment, as it is rejected by the processor/acquirer! So it is indeed possible to capture more, than authorized!
Finalizing a Capture-Chain
After a transaction has been captured to the merchants liking using Multipart Capture, it should be finalized, in order to seclude the transaction. There are two different ways to finalize a Multipart Capture. Each covering one specific case, that should be differentiated, by asking one specific question:
Does the merchant intend to capture a final amount, or not?
Once finalized, a transaction cannot be opened again. Make sure, that you really want to finalize the transaction. Other captures won't be possible!
Finalizing, while also capturing a certain amount
Like mentioned previously, make sure to not exceed the initially authorized amount, or the capture will fail!
In order to capture a final amount, the merchant-system simply needs to execute Multipart Capture, whilst setting the parameter Type to "FINAL". A full request then may look like this:
1
{
2
"RequestHeader": {
3
"SpecVersion": "1.10",
4
"CustomerId": "[your customer id]",
5
"RequestId": "[unique request identifier]",
6
"RetryIndicator": 0
7
},
8
"TransactionReference": {
9
"TransactionId": "723n4MAjMdhjSAhAKEUdA8jtl9jb"
10
},
11
"Amount": {
12
"Value": 1000,
13
"CurrencyCode": "CHF"
14
},
15
"Type": "FINAL",
16
"OrderPartId": "123456790"
17
}
Copied!
Finalizing without capturing/ Capturing with amount 0
In order to avoid confusion and merchants accidently executing the wrong request, the finalization with amount 0 is done through a completely different request called Multipart Finalize. Executing this request will close the transaction without transfering any money.
Why do you need to finalize a transaction?
There are two reasons, why you, the merchant, should finalize a transactions, once you have finished all your actions:
- 1.It is the cleaner process! Four you, the merchant, this is the cleaner solution and helps keeping track of every transaction and its status, not just inside your own system, but also inside the Saferpay Backoffice, where still open and closed transactions, will be marked as such!
- 2.It means less hassle for your customers! Each time you successfully authorize a credit card, the authorized amount gets reserved on the card holders credit limit. That effectively means, that he/she cannot use this money, as long as you haven't claimed the money, or the reservation voids, after a certain time-frame. A finalization will open up the credit-limit for the card holder, so he/she may use it again, which is especially important in situations, where the merchant does not want, or can't claim all of the money originally authorized!
Handling Refunds
Since Multipart Captures basically split an existing transaction into multiple parts, refunds also need to be processed in a different way. Unlike normal Refunds, you now need to reference each Capture you want to refund individually!
To do so, you have to reference the CaptureId from the Multipart Capture Response, you want to refund. Remember, that all CaptureIds have the suffix _c for that reason.
1
{
2
"RequestHeader": {
3
"SpecVersion": "1.10",
4
"CustomerId": "[your customer id]",
5
"RequestId": "[your request id]",
6
"RetryIndicator": 0
7
},
8
"Refund": {
9
"Amount": {
10
"Value": 100,
11
"CurrencyCode": "CHF"
12
}
13
},
14
"CaptureReference": {
15
"CaptureId": "723n4MAjMdhjSAhAKEUdA8jtl9jb_c"
16
}
17
}
Copied!
Like every other Refund, these too need to be captured. However please make sure to use the normal Capture request in this case and NOT MultipartCapture! Refunds cannot be split into multiple parts, like authorizations!
Last modified 1mo ago