Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

excludeFromSearch: true

Capture an Authorization with Level 2/Level 3 Processing

Unless the Level 2 and Level 3 data is different than the original Authorization, there's no need to pass in the Level 2 and Level 3 data on the capture request. We'll automatically pass in the Level 2 and Level 3 data on the capture.

Copy
Copied
curl https://finix.sandbox-payments-api.com/authorizations/AU4AHPn4k7YTQ8YjK3QajeL2 \
    -H "Content-Type: application/vnd.api+json" \
    -H 'Finix-Version:2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -X PUT \
    -d '
  {
      "additional_purchase_data": {
          "item_data": [
              {
                  "amount_excluding_sales_tax": 400,
                  "amount_including_sales_tax": 500,
                  "commodity_code": "175-62-20",
                  "cost_per_unit": 500,
                  "item_description": "printing paper",
                  "item_discount_amount": 100,
                  "merchant_product_code": "1149611",
                  "quantity": 1,
                  "unit_of_measure": "BX"
              },
              {
                  "amount_excluding_sales_tax": 400,
                  "amount_including_sales_tax": 500,
                  "commodity_code": "207-72-54",
                  "cost_per_unit": 500,
                  "item_description": "printing ink",
                  "item_discount_amount": 0,
                  "merchant_product_code": "2149612",
                  "quantity": 1,
                  "unit_of_measure": "CTN"
              }
          ],
          "customer_reference_number": "321xyz",
          "customs_duty_amount": 10,
          "discount_amount": 100,
          "shipping_amount": 100
      },
      "capture_amount": 100,
      "fee": 0
  }'

Example Response:

Copy
Copied
{
  "id" : "AUj9xCyjoNMxcJjaQw2GW7GZ",
  "created_at" : "2022-10-06T20:22:43.39Z",
  "updated_at" : "2022-10-07T17:07:46.24Z",
  "3ds_redirect_url" : null,
  "additional_buyer_charges" : null,
  "additional_healthcare_data" : null,
  "address_verification" : "POSTAL_CODE_AND_STREET_MATCH",
  "amount" : 108,
  "amount_requested" : 108,
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "currency" : "USD",
  "expires_at" : "2022-10-13T20:22:43.39Z",
  "failure_code" : null,
  "failure_message" : null,
  "idempotency_id" : null,
  "is_void" : false,
  "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
  "messages" : [ ],
  "raw" : null,
  "security_code_verification" : "MATCHED",
  "source" : "PIe2YvpcjvoVJ6PzoRPBK137",
  "state" : "SUCCEEDED",
  "tags" : {
    "test_key_100" : "test_val_100"
  },
  "trace_id" : "20fb8474-1b04-433e-9573-d58e6fcc1586",
  "transfer" : "TRmGcgUgKxqpTVC2UVKngFsv",
  "void_state" : "UNATTEMPTED",
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/authorizations/AUj9xCyjoNMxcJjaQw2GW7GZ"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "transfer" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRmGcgUgKxqpTVC2UVKngFsv"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
    }
  }
}

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

additional_purchase_data-object Request Arguments

Field Type Description
customer_reference_number string, optional The customer reference for the purchase (max 17 characters)
customs_duty_amount integer, optional The duty in cents on the total purchase amount for the order
destination_country_code string, optional The ISO country code of the order destination
destination_postal_code string, optional The postal code of the order destination
discount_amount integer, optional The amount in cents of the discount for the order
invoice_reference_number string, optional The order's invoice number (max 15 characters)
sales_tax integer, optional Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts. For non-taxable transactions either set sales_tax to 0 or omit from payload and also set tax_exempt to true.
shipping_amount integer, optional The shipping cost in cents for the order
ship_from_postal_code string, optional The postal code from where order is shipped
tax_exempt boolean, optional For tax exempt purchases set to True

order_date-object Request Arguments

Field Type Description
day integer, optional Day of purchase (between 1 and 31)
month integer, optional Month of purchase (between 1 and 12)
year integer, optional Year of purchase (4-digit)

item_data-object Request Arguments

Field Type Description
amount_excluding_sales_tax integer, optional Total cost in cents of the line item excluding tax
amount_including_sales_tax integer, optional Total cost in cents of the line item including tax
commodity_code string, optional A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters)
cost_per_unit integer, optional The price in cents of one unit of the item purchased
item_description string, optional Required when item_data is supplied (max 26 characters)
item_discount_amount integer, optional Item discount amount in cents
merchant_product_code string, optional Merchant defined product code (max 12 characters)
quantity integer, optional The number of items purchased. Must be greater than 0.
unit_of_measure string, optional The unit of measure of the purchased item (max 12 characters)