Capture a payment

POST

/api/payments/{id}/capture

Path Parameters

idstringrequired

Header Parameters

Idempotency-Keystringrequired
Description
Client-supplied key to safely retry the request without duplicating the operation.

Body Parameters

bodyCapturePaymentDTOrequired
- amountnumber
  Example
  2999
  Description
  Amount to capture from the payment
  Minimum
  1
- authorizationobject
  - CaptureAuthorizationDTO
    - renewIfExpiredboolean
      Example
      true
      Description
      Renew the authorization before capturing if it has expired. Adds a merchant-initiated authorization against the stored credential, which may be declined; the capture then fails.
      Default
      false

Responses

200Payment captured

PaymentResponseDTO
Description
Payment response
- idstringrequired
  Description
  Unique identifier for the payment
- orderIdstringrequired
  Example
  order-abc-123
  Description
  The Forter order ID associated with this payment
- amountnumberrequired
  Example
  9876
  Description
  The total amount for the payment
- capturedAmountnumber
  Example
  9876
  Description
  The total amount captured for the payment
- authorizedAmountnumber
  Example
  9876
  Description
  The amount still held by the authorization and available to capture. Zero once the authorization is concluded, whether captured or voided
- refundedAmountnumber
  Description
  The total amount refunded for the payment
- capturedAtstring<date-time>
  Description
  When the payment was captured (latest successful capture)
  Format
  date-time
- refundedAtstring<date-time>
  Description
  When the payment was refunded (latest successful refund).
  Format
  date-time
- authorizedAtstring<date-time>
  Description
  When the payment was authorized.
  Format
  date-time
- authorizationExpiresAtstring<date-time>
  Description
  When the authorization hold expires (capture deadline).
  Format
  date-time
- createdAtstring<date-time>
  Example
  2025-07-14T12:34:56.789Z
  Description
  Date and time when the payment was created
  Format
  date-time
- currencystring<AED | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BWP | BYN | BZD | CAD | CHF | CLP | CNY | COP | CRC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ETB | EUR | FJD | FKP | GBP | GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | INR | IQD | JMD | JOD | JPY | KES | KGS | KHR | KMF | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRU | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SEK | SGD | SHP | SLE | SLL | SOS | SRD | SSP | STN | SVC | SZL | THB | TND | TOP | TRY | TTD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VES | VND | VUV | WST | XAF | XCD | XOF | XPF | YER | ZAR | ZMW>required
  Example
  GBP
  Description
  The currency code for the payment
  Allowed
  AEDALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBWPBYNBZDCADCHFCLPCNYCOPCRCCUPCVECZKDJFDKKDOPDZDEGPETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDJMDJODJPYKESKGSKHRKMFKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSEKSGDSHPSLESLLSOSSRDSSPSTNSVCSZLTHBTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVESVNDVUVWSTXAFXCDXOFXPFYERZARZMW
- statusstring<requires_payment_method | requires_confirmation | requires_action | processing | requires_capture | canceled | succeeded | failed>required
  Example
  succeeded
  Description
  Current status of the payment
  Allowed
  requires_payment_methodrequires_confirmationrequires_actionprocessingrequires_capturecanceledsucceededfailed
- nextActionobject
  - PaymentNextActionDTO
    - typestring<use_sdk>required
      Example
      use_sdk
      Description
      Type of action required
      Allowed
      use_sdk
    - useSdkobject
      - UseSdkActionDTO
        tokenstringrequired
        Example
        sdk_token_123
        Description
        SDK token for client-side authentication
- captureMethodstring<automatic | manual>
  Example
  automatic
  Description
  The capture method for the payment
  Default
  automatic
  Allowed
  automaticmanual
- paymentMethodobject
  - PaymentMethodResponseDTO
    - typestring<token | card | network_token>required
      Example
      card
      Description
      Payment method type used for authorization.
      Allowed
      tokencardnetwork_token
    - cardobject
      - PaymentMethodCardDTO
        brandstringrequired
        Example
        visa
        Description
        Card brand. 'unknown' when the brand could not be determined.
        last4stringrequired
        Example
        4242
        Description
        Last four digits of the card
        expirationMonthstringrequired
        Example
        03
        Description
        Card expiration month
        expirationYearstringrequired
        Example
        2026
        Description
        Card expiration year
        cardholderNamestring
        Example
        Jane Doe
        Description
        Cardholder name
        networkTokenobject
        NetworkTokenDTO
        usedbooleanrequired
        Description
        Whether a network token (rather than the PAN) was used to authorize. Always false until network tokenization is used at the PSP.
    - processorTokenstring
      Example
      f28v7s
      Description
      Processor vault token for stored-credential reuse. Present only when the processor returned a stored-credential token.
- processorobject
  - ProcessorDTO
    - namestring<stripe | adyen | braintree | airwallex | connexpay | echo | fiserv>
      Description
      Processor used for the payment
      Allowed
      stripeadyenbraintreeairwallexconnexpayechofiserv
    - transactionIdstring
      Example
      pi_abc123
      Description
      Processor-assigned transaction id
    - chargeIdstring
      Example
      ch_xyz789
      Description
      Processor-assigned charge id
- authorizationobject
  - AuthorizationDTO
    - authorizationCodestring
      Example
      AUTH123
      Description
      Processor authorization code
    - rawResponseCodestring
      Example
      card_declined
      Description
      Raw processor response code
    - rawResponseMessagestring
      Example
      Your card was declined.
      Description
      Raw processor response message
    - processorResponseCodestring<approved | do_not_honor | generic_decline | insufficient_funds | limit_exceeded | expired_card | invalid_card_number | cvv_mismatch | avs_mismatch | invalid_account | call_issuer | lost_or_stolen_card | fraudulent | pickup_card | transaction_not_allowed | processor_unavailable | duplicate_transaction | invalid_amount | invalid_request | card_type_not_supported | configuration_error>
      Example
      insufficient_funds
      Description
      Processor response code normalized into a canonical cross-PSP vocabulary. Omitted when the raw code has no normalized mapping.
      Allowed
      approveddo_not_honorgeneric_declineinsufficient_fundslimit_exceededexpired_cardinvalid_card_numbercvv_mismatchavs_mismatchinvalid_accountcall_issuerlost_or_stolen_cardfraudulentpickup_cardtransaction_not_allowedprocessor_unavailableduplicate_transactioninvalid_amountinvalid_requestcard_type_not_supportedconfiguration_error
    - checksobject
      - CardChecksDTO
        addressCheckstring<pass | fail | unavailable | unchecked>
        Description
        AVS (address) check result
        Allowed
        passfailunavailableunchecked
        cvcCheckstring<pass | fail | unavailable | unchecked>
        Description
        CVV/CVC check result
        Allowed
        passfailunavailableunchecked
- authenticationobject
  - AuthenticationDTO
    - threeDSecureobject
      - ThreeDSecureResultsDTO
        statusstring<authenticated | attempted | failed | rejected | challenge_required | unavailable>
        Description
        3DS authentication outcome
        Allowed
        authenticatedattemptedfailedrejectedchallenge_requiredunavailable
        versionstring<1.0.2 | 2.1.0 | 2.2.0 | 2.3.1>
        Example
        2.2.0
        Description
        3DS protocol version
        Allowed
        1.0.22.1.02.2.02.3.1
        ecistring<00 | 01 | 02 | 04 | 05 | 06 | 07>
        Example
        05
        Description
        Electronic Commerce Indicator (chargeback liability-shift evidence)
        Allowed
        00010204050607
- metadataobject
  Description
  Set of key-value pairs for storing additional information about the payment
- fraudobject
  - PaymentFraudDTO
    - preAuthobject
      - FraudDecisionDTO
        decisionstring<approve | decline | not_reviewed>required
        Description
        Fraud decision
        Allowed
        approvedeclinenot_reviewed
    - postAuthobject
      - FraudDecisionDTO
        decisionstring<approve | decline | not_reviewed>required
        Description
        Fraud decision
        Allowed
        approvedeclinenot_reviewed

400Bad request

401Unauthorized

404Not found

curl

curl --request POST \
     --url /api/payments/{id}/capture \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'idempotency-key: string' \
     --data '{
     "authorization": {}
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("idempotency-key", "string");

var raw = JSON.stringify({
   "authorization": {}
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("/api/payments/{id}/capture", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/api/payments/{id}/capture")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["idempotency-key"] = "string"
request.body = JSON.dump({
   "authorization": {}
})

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/api/payments/{id}/capture"

payload = json.dumps({
   "authorization": {}
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'idempotency-key': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Payment captured
{
  "id": "",
  "orderId": "order-abc-123",
  "amount": 9876,
  "capturedAmount": 9876,
  "authorizedAmount": 9876,
  "refundedAmount": 0,
  "capturedAt": "",
  "refundedAt": "",
  "authorizedAt": "",
  "authorizationExpiresAt": "",
  "createdAt": "2025-07-14T12:34:56.789Z",
  "currency": "GBP",
  "status": "succeeded",
  "nextAction": {},
  "captureMethod": "automatic",
  "paymentMethod": {},
  "processor": {},
  "authorization": {},
  "authentication": {},
  "metadata": {},
  "fraud": {}
}

400

// Bad request

401

// Unauthorized

404

// Not found