Skip to main content
A capture takes place after receiving an approved authorization, and initiates the flow of funds from the cardholder’s issuing bank account to your merchant account.
When to Use
  • You’re ready to collect payment for a previously authorized transaction.
  • You’ve shipped goods or provided services that were previously authorized.
  • You need to capture a full or partial amount from an existing authorization.
ScenarioAfter CoolTechGear.com’s stock of mechanical keyboards was replenished, they are ready to capture the $300 authorization previously run on Ben’s card ending in 4242.

​
Steps

  1. Retrieve the unique paymentId from the authorization you are going to capture. This is how we link the capture to its original authorization.
  2. Call the captureAuthorization mutation, passing in the pertinent inputs:
    Required inputDescription
    paymentIdRequired. The unique “payment ID” returned on the original, approved authorization, which we’ll use to tie to this capture.
    acceptorIDRequired. The unique, 36 character identifier assigned to the entity providing the goods or services to the cardholder. Other processors may refer to this as the Merchant ID (MID), Outlet ID, or Customer number.
    transactionReferenceRequired. The unique transaction identifier created by YOU to distiniguish this transaction from another.
    transactionAmountDetailsOptional. The transaction currency and amount to be captured. If are capturing a portion of the authorization amount, specify only that portioned amount.
    totalCaptureCountApplicable only if there will be multiple partial captures submitted on a single authorization.

    Example, if an order will be split up and shipped on two different dates, you’ll submit a capture as each shippment is sent, and therefore set totalCaptureCount:2.

    If you are submitting a single capture for the authorization, then you do not need to include this field.

​
Full vs. partial captures

Under the hood, full and partial captures are the same thing, with the only difference being that a full capture’s amount is a single capture equal to final authorization amount, and a partial capture is for a value less than the full authorization amount. There can be multiple partial capture requests on an authorization, with each one specifying the partial amount to be captured within the transactionAmountDetails input. If you do not specify an amount, Tesouro will capture any remaining uncaptured amount left on the authorization.
ScenarioBen buys 3 sets of mechanical keyboard caps at $20 a set. The sets are in stock, but one set is not ready to ship. CoolTechGear.com authorizes Ben’s card for the full $60, and then submits a partial capture for $40 when the first two cap sets are shipped.
In this example, CoolTechGear can capture only what is available to ship, so they specify the partial amount ($40) to be captured, using the paymentId from the original authorization. Later, when the remaining keyboard cap set is available to ship, CoolTechGear will submit another capture request for the remaining $20, using the same paymentId from the original authorization.
If any remaining authorization amount is not captured or reversed within 10 days, you will be assessed a Misuse of Authorization fee.
mutation captureAuthorization($input: CaptureAuthorizationInput!) {
  captureAuthorization(captureAuthorizationInput: $input) {
    captureAuthorizationResponse {
      status: __typename
      ... on CaptureAuthorizationApproval {
        captureAmountDetails {
          approvedAmount
          requestedAmount
          currency
        }
      }
      ... on CaptureAuthorizationDecline {
        message
        declineType
      }
      activityDate
      transactionId
      paymentId
      activityDate
    }
    errors {
      errorType: __typename
    }
  }
}

{
  "data": {
    "captureAuthorization": {
      "transactionInformation": {
        "paymentId": "64495c8b-4c0f-11ee-bf97-0e7d489d8cb0"
      }
    }
  }
}
Run in Playground