Deprecated API Reference

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

Create a Sale with Level 3 Processing

Combines both the create Authorization and capture Authorization API calls into one.

See the request arguments table below for the fields that are required to meet Level 3 processing for an Transfer.

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/transfers \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
    -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
      },
	    "amount": 1000,
	    "currency": "USD",
      "merchant": "MUeDVrf2ahuKc9Eg5TeZugvs",
	    "source": "PIe2YvpcjvoVJ6PzoRPBK137",
	    "tags": {
	        "test": "sale"
	    }
	}'

Example Response:

Copy

Copied

{
  "id" : "TRhNEVxYWDF97SEqBJHykPDH",
  "created_at" : "2022-10-10T03:42:15.11Z",
  "updated_at" : "2022-10-10T03:42:15.68Z",
  "additional_buyer_charges" : null,
  "additional_healthcare_data" : null,
  "address_verification" : null,
  "amount" : 1000,
  "amount_requested" : 1000,
  "application" : "APgPDQrLD52TYvqazjHJJchM",
  "currency" : "USD",
  "destination" : null,
  "externally_funded" : "UNKNOWN",
  "failure_code" : null,
  "failure_message" : null,
  "fee" : 0,
  "idempotency_id" : null,
  "merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
  "messages" : [ ],
  "raw" : null,
  "ready_to_settle_at" : null,
  "security_code_verification" : null,
  "source" : "PIe2YvpcjvoVJ6PzoRPBK137",
  "state" : "PENDING",
  "statement_descriptor" : "FNX*FINIX FLOWERS",
  "subtype" : "API",
  "tags" : {
    "test" : "sale"
  },
  "trace_id" : "ce93f81e-187d-4d2a-b387-bb316f9efa9a",
  "type" : "DEBIT",
  "_links" : {
    "application" : {
      "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
    },
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH"
    },
    "merchant_identity" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
    },
    "payment_instruments" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/payment_instruments"
    },
    "reversals" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/reversals"
    },
    "fees" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/fees"
    },
    "disputes" : {
      "href" : "https://finix.sandbox-payments-api.com/transfers/TRhNEVxYWDF97SEqBJHykPDH/disputes"
    },
    "source" : {
      "href" : "https://finix.sandbox-payments-api.com/payment_instruments/PIe2YvpcjvoVJ6PzoRPBK137"
    },
    "fee_profile" : {
      "href" : "https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"
    }
  }
}

HTTP Request

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

Request Arguments

Field	Type	Description
`amount`	integer, required	The total amount that will be debited in cents (e.g. 100 cents to debit $1.00)
`currency`	string, required	3-letter ISO code designating the currency of the `Transfers` (e.g. USD)processor
`fee`	integer, optional	The amount of the `Transfer` you would like to collect as your fee in cents. Defaults to zero (Must be less than or equal to the amount)
`idempotency_id`	string, optional	A randomly generated value that you want associated with the request
`merchant`	string, required	`Merchant` ID of the merchant whom you're charging on behalf of
`source`	string, required	ID of the `Payment Instrument` that will be debited
`tags`	object, optional	Key value pair for annotating custom metadata (e.g. order numbers)

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.
`shipping_amount`	integer, required	The shipping cost in cents for the order
`ship_from_postal_code`	string, optional	The postal code from where order is shipped (10 characters)
`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)