Checkout Forms

Checkout Forms are a low-code solution that enables you to create a customizable payment page where buyers can easily enter their payment details and submit a payment on both desktop and mobile devices.

Using Checkout Forms you can quickly create a checkout page and accept payments from buyers with minimal dev work.

Related Guides: Checkout Forms

Create a Checkout Form

Create a Checkout Form to accept the details of buyers.

Related guides: Checkout Formss.

Request
header Parameters
Finix-Version
string
Default: 2018-01-01

Specify the API version of your request. For more details, see Versioning.

Example: 2022-02-01
Request Body schema: application/json
merchant_id
required
string

The ID of the Merchant the payment is getting created under.

Only approved Merchants with one of the following processors can create checkout pages: DUMMY_V1, LITLE_V1 or FINIX_V1.

payment_frequency
required
string

Details if a payment created from a checkout form is:

  • ONE_TIME
  • RECURRING
At this time, only ONE_TIME is supported.

is_multiple_use
boolean

If set to True, the checkout form can be used for multiple purchases.

allowed_payment_methods
required
Array of strings

Payment methods allowed on the checkout form.

nickname
required
string

Descriptor name of the checkout form.

Array of objects

Details the items or services used in the checkout form.

object

Object containing details about the buyer. This object is only used for SINGLE_USE checkout forms.

object

Object containing details about the amount getting charged by the checkout form.

object

Object containing branding details for the checkout form.

object

Object containing additional details about the checkout form.

object or null

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500.

(e.g., order number: 25, item_type: produce, department: sales, etc.)

Responses
200

Example response

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

post/checkout_forms
Request samples
Response samples
application/json
{}

List Checkout Forms

Retrieve a list of Checkout Forms.

For details on how to query endpoints using the available parameters, see Query Parameters.

Request
header Parameters
Finix-Version
string
Default: 2018-01-01

Specify the API version of your request. For more details, see Versioning.

Example: 2022-02-01
Responses
200

Example response

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

get/checkout_forms
Request samples
curl "https://finix.sandbox-payments-api.com/checkout_forms" \
-H "Finix-Version: 2022-02-01" \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{}

Fetch a Checkout Form

Retrieve the details of a previously created Checkout Form.

Request
path Parameters
checkout_forms_id
required
string
header Parameters
Finix-Version
string
Default: 2018-01-01

Specify the API version of your request. For more details, see Versioning.

Example: 2022-02-01
Responses
200

Example response

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

422

Invalid field

get/checkout_forms/{checkout_forms_id}
Request samples
curl "https://finix.sandbox-payments-api.com/checkout_forms/checkout_form_c6dyWA9HiFkNkbXgeAoqP" \
-H "Finix-Version: 2022-02-01" \
-u USksBJMwkNUz5GyxPevL2yFY:71b641c1-861d-435b-9a9c-532760731c5e
Response samples
application/json
{}