Captures a transaction

Request

POST {{baseURL}}/pay-api/v1/transactions/capture

This endpoint captures a previously authorized transaction.

The capture must reference an existing authorized transaction. It intends to convert the authorization hold into a completed charge that will be submitted for settlement. When a transaction is first authorized, the customer's bank places a temporary hold on the funds. Those funds are not transfer the money yet. A capture confirms that the merchant intends to collect those funds and finalizes the transaction. Once captured, the transaction cannot be voided.

For example, a customer orders $100 at a restaurant. The charge is authorized but the funds are not paid yet. The customer is waiting to add a tip amount. After the tip is included and a new amount is agreed on, the transaction is captured. Now, the funds are released for payment.

See Also:
To authorize a transaction, see POST /pay-api/v1/transactions/auth
To refund a settled transaction, see POST /pay-api/v1/transactions/return
To capture an amount for funds transfer, see POST /pay-api/v1/transactions/capture

Security

Bearer

Bodyapplication/json

amountnumber, (double)required

Specifies the base amount of the transaction before adjustments (if any).

Adjustments, such as tips, discounts, and surcharges, are added individually through request parameters. The call makes all adjustments during processing. The total amount charged is returned in the response body amount.totalAmount.

Example: 124.86

Example:124.86

transactionIdstring, (uuid)required

Specifies the transactionId from the original authorization.

After the transaction is complete, the transactionId is invalidated for future attempts.

Example: 19be194d-d962-41e2-bba0-ee719ed94634

Example:"19be194d-d962-41e2-bba0-ee719ed94634"

curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-api/v1/transactions/capture \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 123.45,
    "transactionId": "4b25e010-5a4a-4bd0-9961-0cff14bdb41b"
  }'

Responses

Bodyapplication/json

transactionIdstring, (uuid)

Indicates the transaction identifier.

Example: c7c15dd0-03e7-4e55-917c-54bedafba5e7

Example:"c7c15dd0-03e7-4e55-917c-54bedafba5e7"

transactionDateTimestring, (date-time)

Indicates the date and time (in ISO 8601 UTC or timezone offset format) of the transaction.

Examples: 2026-08-24T08:45:22Z

Example:"2026-08-24T08:45:22Z"

typeIdinteger, (int32)

Type id of transaction.

typestring or null

Type name of transaction

statusIdinteger, (int32)

Status id of transaction.

statusstring or null

Status name of transaction

detailsobject

transactionReceiptobject or null

Indicates an object describing the transaction receipt. The transaction receipt will be null or empty before the transaction is completed. After the completed transaction, it be filled out.

Response

{
  "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
  "transactionDateTime": "2026-08-24T08:45:22Z",
  "typeId": 0,
  "type": "string",
  "statusId": 0,
  "status": "string",
  "details": {
    "hostResponseCode": "string",
    "hostResponseMessage": "string",
    "hostResponseDefinition": "string",
    "code": "string",
    "message": "string",
    "processorResponseCode": "string",
    "authCode": "string",
    "maskedPan": "********3743"
  },
  "transactionReceipt": {
    "transactionId": "c7c15dd0-03e7-4e55-917c-54bedafba5e7",
    "transactionDateTime": "2026-02-19T20:24:52.934Z",
    "amount": {
      "baseAmount": 129.99,
      "percentageOffAmount": 12.5,
      "percentageOffRate": 3.5,
      "cashDiscountAmount": 10.55,
      "cashDiscountRate": 1.5,
      "surchargeAmount": 6.45,
      "surchargeRate": 1.5,
      "tipAmount": 14.5,
      "tipRate": 15,
      "totalAmount": 3219.45
    },
    "currencyId": 1,
    "currency": "USD",
    "processorId": "ef08c4d5-6e7f-4a8b-9c0d-1e2f3a4b5c81",
    "processor": "TSYS",
    "operationTypeId": 1,
    "operationType": "PayNow",
    "paymentMethodTypeId": 2,
    "paymentMethodType": "Card",
    "transactionTypeId": 5,
    "transactionType": "Refund",
    "customerId": "fd9198a4-eb6f-4620-9603-4f4638289de5",
    "customerPan": "************4512",
    "cardTokenType": 2,
    "statusId": 0,
    "status": "string",
    "merchantName": "string",
    "merchantAddress": "string",
    "merchantPhoneNumber": "+14155552309",
    "merchantEmailAddress": "string",
    "merchantWebsite": "string",
    "authCode": "string",
    "source": {
      "typeId": 0,
      "type": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "cardholderAuthenticationMethodId": 0,
    "cardholderAuthenticationMethod": "string",
    "cvmResultMsg": "string",
    "cardDataSourceId": 2,
    "cardDataSource": "string",
    "responseCode": "string",
    "responseDescription": "string",
    "cardProcessingDetails": {
      "authCode": "string",
      "mid": "43252511",
      "tid": "8820432549239101",
      "cardCreditDebitTypeId": 0,
      "cardCreditDebitType": "string",
      "processCreditDebitTypeId": 0,
      "processCreditDebitType": "string",
      "rrn": "10628361287F",
      "cardTypeId": 0,
      "cardType": "string"
    },
    "achProcessingDetails": {
      "customerAccountNumber": "string",
      "customerRoutingNumber": "string",
      "accountHolderType": "string",
      "accountHolderTypeId": 0,
      "accountType": "string",
      "accountTypeId": 0,
      "taxId": "98-7654321"
    },
    "availableOperations": [
      {
        "typeId": 0,
        "type": "string",
        "availableAmount": 0.1,
        "suggestedTips": [
          {
            "tipAmount": 14.5,
            "tipPercent": 15
          }
        ]
      }
    ],
    "avsResponse": {
      "actionId": 1,
      "action": "string",
      "responseCode": "string",
      "groupId": 5,
      "group": "string",
      "resultId": 1,
      "result": "string",
      "codeDescription": "string"
    },
    "emvTags": {
      "ac": "string",
      "tvr": "string",
      "tsi": "string",
      "aid": "string",
      "applicationLabel": "string",
      "rawTags": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "orderNumber": "string"
  }
}