Capture an Authorization

attention

This API is available for Finix Flex and Finix Core customers.

If successfully captured, the transfer field of the Authorization will contain the ID for the corresponding Transfer resource. By default, Transfers are in a PENDING state. The PENDING state means the system hasn't submitted the capture request yet. Capture requests are submitted via batch request. Once submited, the state of the Transfer will update to SUCCEEDED.

Copy
Copied
curl https://finix.sandbox-payments-api.com/authorizations/AUvAZfiEH7irXZf49P7o8P1r \
    -H "Content-Type: application/vnd.api+json" \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -X PUT \
    -d '
	{
	    "fee": 0,
	    "capture_amount": 100
	}'

Example Response:

Copy
Copied
{
  "id" : "AUvAZfiEH7irXZf49P7o8P1r",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "amount" : 100,
  "tags" : {
    "order_number" : "21DFASJSAKAS"
  },
  "state" : "SUCCEEDED",
  "currency" : "USD",
  "transfer" : "TRsBcF8LjV1UaK5vXY6pFHmG",
  "messages" : [ ],
  "raw" : null,
  "created_at" : "2022-01-27T07:37:19.16Z",
  "updated_at" : "2022-01-27T07:37:25.50Z",
  "trace_id" : "b9e38593-da27-49e7-b948-f6c1d59d5e7e",
  "source" : "PIe2YvpcjvoVJ6PzoRPBK137",
  "merchant_identity" : "IDpYDM7J9n57q849o9E9yNrG",
  "3ds_redirect_url" : null,
  "is_void" : false,
  "void_state" : "UNATTEMPTED",
  "expires_at" : "2022-02-03T07:37:19.16Z",
  "idempotency_id" : null,
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/authorizations/AUvAZfiEH7irXZf49P7o8P1r"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "transfer" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRsBcF8LjV1UaK5vXY6pFHmG"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
    }
  }
}

HTTP Request

PUT https://finix.sandbox-payments-api.com/authorizations/:AUTHORIZATION_ID

URL Parameters

Parameter Description
:AUTHORIZATION_ID ID of the Authorization

Request Arguments

Field Type Description
capture_amount integer, required The amount of the Authorization you would like to capture in cents. Must be less than or equal to the amount of the Authorization
fee integer, optional Amount of the captured Authorization you would like to collect as your fee. Must be less than or equal to the amount