Capture
POST /capture
This endpoint allows merchants to capture authorized funds, completing the transaction and transferring the specified amount from the cardholder’s account. Capturing converts an authorization into an actual charge, making it a key step in finalizing the payment.
Types of Capture: Final vs. Partial
You can specify the amount to be captured using this endpoint, allowing for final or partial captures, depending on the situation.
-
Final Capture: When capturing the entire authorized amount, you are performing a final capture. This is typically used when the full order is fulfilled, and no additional charges are expected. Final captures complete the authorization, meaning no further captures can be made against that authorization.
-
Partial Capture: Partial captures are used when only a portion of the authorized amount is collected. This can be useful for split shipments, partial order fulfillments, or when only part of the service is provided. Multiple partial captures may be made until the total authorized amount is reached.
Test URL
The capture request will be made to the following URL:
https://checkout-api.staging.straumur.is/api/v1/modification/capture
This call will create a capture request for the specified amount on the intended authorization.
Request Example
{
"amount": "48900",
"currency": "ISK",
"reference": "9990QQAZ1221",
"payfacReference": "5215125152151259990QQAZ1"
}
Request Body Fields
Field | Type | Required | Description | Example | Min Length | Max Length |
---|---|---|---|---|---|---|
amount | Integer | Required | The amount to be captured in minor units. | 127300 | - | - |
currency | String | Required | The three-character ISO currency code. | ISK | 3 | 3 |
reference | String | Required | Merchant reference to uniquely identify a payment. | 9990QQAZ1221 | 1 | 100 |
payfacReference | String | Required | Straumur reference to uniquely identify a payment. | 5215125152151259990QQAZ1 | 1 | 100 |
Example - Received Response
Status "Received" means that the system has received your request and will process it.
After completion, you will receive a final response through a webhook.
{
"status": "Received",
"payfacReference": "ASDAKOS125152",
"responseDateTime": "2024-09-04T09:50:14.343503Z",
"responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
Error Response
Our error responses are standardised. Please see Errors.
You can also find a detailed overview of our HTTP Status Codes.