Deprecated API Reference

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

Create an Authorization with Level 3 Processing

See the request arguments table below for the fields that are required to create an authorization with Level 3 processing.

A merchant first needs to be enabled for Level 2 and Level 3. Update Merchant to Enable Level 2/Level 3 Processing.

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

Example Response:

Copy
Copied
{
  "id" : "AUsQsCLRp9ENxrh563w1zZHi",
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "amount" : 1000,
  "tags" : {
    "order_number" : "21DFASJSAKAS"
  },
  "state" : "SUCCEEDED",
  "currency" : "USD",
  "transfer" : null,
  "messages" : [ ],
  "raw" : null,
  "created_at" : "2022-01-27T07:37:21.55Z",
  "updated_at" : "2022-01-27T07:37:21.68Z",
  "trace_id" : "88136ea9-9393-4b95-b4c0-940b49ab707d",
  "source" : "PIe2YvpcjvoVJ6PzoRPBK137",
  "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
  "3ds_redirect_url" : null,
  "is_void" : false,
  "void_state" : "UNATTEMPTED",
  "expires_at" : "2022-02-03T07:37:21.55Z",
  "idempotency_id" : null,
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/authorizations/AUsQsCLRp9ENxrh563w1zZHi"
    },
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
    }
  }
}

HTTP Request

POST https://finix.sandbox-payments-api.com/authorizations

Request Arguments

Field Type Description
merchant string, required The ID of the Identity for the merchant that you are transacting on behalf of
source string, required The Payment Instrument that you will be performing the authorization
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers)
currency string, required 3-letter ISO code designating the currency (e.g. USD)
amount integer, required The amount of the authorization in cents
processor string, optional If the Application has more than one processor association, it's required to pass the processor (e.g. DUMMY_V1)
idempotency_id string, optional A randomly generated value that you want associated with the request

additional_purchase_data-object Request Arguments

Field Type Description
customer_reference_number string, required The customer reference for the purchase (max 17 characters)
customs_duty_amount integer, required 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 (10 characters)
discount_amount integer, required 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.
ship_from_postal_code string, optional The postal code from where order is shipped (10 characters)
shipping_amount integer, required The shipping cost in cents for the order
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, required Total cost in cents of the line item excluding tax
amount_including_sales_tax integer, required Total cost in cents of the line item including tax
commodity_code string, required 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, required The price in cents of one unit of the item purchased
item_description string, required Required when item_data is supplied (max 25 characters)
item_discount_amount integer, required Item discount amount in cents
merchant_product_code string, required Merchant defined product code (max 12 characters)
quantity integer, required The number of items purchased. Must be greater than 0.
unit_of_measure string, required The unit of measure of the purchased item (max 3 characters)