Payment Links

Create and send payment links to help buyers easily complete transactions.


Payment Links

Payment links enable you to create individual links that you can send to buyers to help them complete a transaction. Payment links help reduce the hurdles buyers go through to submit a payment.

With payment links, instead of logging onto a computer or meeting the seller in person, the buyer can click a hyperlink and complete the transaction on their phone or preferred device.

Examples where payment links can help include:

  • Including a payment link link with an invoice for your buyer to pay.
  • Asking a buyer to pay after they visit your store.
  • Allowing a buyer to pay through chat, email, or social media.

The payment link purchase page can work on mobile and web. You can also customize the checkout page with your brand name and logo.

If you have any questions about using payment links, please don't hesitate to reach out to your Finix point of contact or email the Finix Support team.

Buyer Perspective

Payment links are created by submitting information about the transaction in the Finix Dashboard, like amount, currency, items sold, etc. You can then send the payment link that gets created to your buyer via email, chat, or other medium.

When the buyer clicks on the link, they'll see a payment page where they can enter their card or bank information to complete the purchase.

Buyer Page

Supported Payment Methods

Payment links currently support:

  • Card payments
  • Bank account payments (ACH in USA)

For more details about ACH payments, see ACH Direct Debit.

Finix Dashboard

You can create a payment link in the Finix Dashboard without any development work. Using the Finix Dashboard, you can:

  • Create and send payment links to buyers to help them submit their bank and/or card details.
  • Track the status of payment links.

To create a payment link using the Finix Dashboard:

  1. Login to the Finix Dashboard and create a payment link.
  2. Send the payment link to your buyer.
  3. Track the payment link for the buyer's payment submission.

Step 1: Create a Payment Link

To create a payment link in the Finix Dashboard:

  1. Log into the Finix Dashboard .
  2. Click Transactions > Payments .
  3. Click Create Payment > Create Payment Link .
  4. Set if the payment link will be one-time or multi-use.
  5. Fill out the form with the requested details. Be sure to include a link to your Terms of Service.

One-Time Links

Single-use payment links offer enhanced security by being only valid for one purchase. They're helpful for many businesses who want to text or email a payment link to a customer.

One-Time Link

When a One-Time Link purchase is completed, the link can't be used again by anyone else.

Single Use - Payment Completed

Multi-Use Links

Multi-use payment links allow businesses and customers to use the same payment link for multiple transactions. Businesses can track and analyze the performance of each individual payment link across multiple purchases.

Multi-Use Links

For Multi-Use Payment Links, the state of the payment link will remain ACTIVE until it expires or gets deactivated. Each successful purchase creates a purchase resource. For example, you could have one payment link with 100 purchases associated with the payment_link.

Multi-Use Links

Fields

Field Description Required
Type Set if the payment link will be One-Time or Multi-Use.
Name A short name to help you manage payment links.
Amount Type Set the pricing of the payment link. Variable allows your buyers to specify how much they want to pay.
Allowed Payment Methods Choose between Card and/or Bank Transfers.
Product or Service Name Name of the item or service being sold; the name will appear in the form the buyer submits.
Description Short description of your item. Optional
Terms of Service URL URL linking to your Terms of Service.
Success URL URL to redirect buyers if their payment is successful. Optional
Failure URL URL to redirect buyer if their payment is unsuccessful. Optional
Expired Session URL URL to redirect your buyer if the payment link expires. Optional

Fixed Price

Field Description Required
Unit Price Price of the item. At this time, payment links only support USD.
Quantity Item quantity. The final total will be calculated from the Unit Price and Quantity.
Image URL Image URL of an individual item. The image will appear in the form the buyer submits. Optional

Variable Price

Field Description Required
Default Amount Default amount to display when a buyer clicks on the payment link. This can be changed after clicking into the field. Optional
Minimum Allowed Minimum amount a buyer can set in the payment form. Optional
Maximum Allowed Maximum amount a buyer can put in the payment form. Optional

Step 2: Send Payment Link to Buyer

On the Payment Link Details page you can copy the payment link URL to send to buyers.

When the buyer clicks on the link, they get redirected to Finix's payment form which they can use to complete their purchase.

Here's an example of a payment link URL you can copy and review:

Copy
Copied
https://finix.sandbox-payments-checkout.com/payment_link?bearer_token=eyJ0eXAiOiJKV1MiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJVU2tzQkpNd2tOVXo1R3l4UGV2TDJ5RlkiLCJhdWQiOiIqLmhvc3RlZC1wYXltZW50cy1odHRwLmZpbml4b3BzLmNvbSIsImlzcyI6ImF1dGhlbnRpY2F0aW9uLnNiLmZpbml4b3BzLmNvbSIsImlhdCI6MTcwMDcwNDYxMiwiZXhwIjoxNzE2NDcyNjEyLCJlbnRpdHlfdHlwZSI6IlBBWU1FTlRfTElOSyIsImFkZGl0aW9uYWxfZGV0YWlscyI6eyJjb2xsZWN0X25hbWUiOmZhbHNlLCJjb2xsZWN0X2VtYWlsIjp0cnVlLCJjb2xsZWN0X3Bob25lIjpmYWxzZSwiY29sbGVjdF9iaWxsaW5nX2FkZHJlc3MiOmZhbHNlLCJjb2xsZWN0X3NoaXBwaW5nX2FkZHJlc3MiOmZhbHNlLCJnZW5lcmF0ZV9yZWNlaXB0IjpmYWxzZSwic3VjY2Vzc19yZXR1cm5fdXJsIjoiaHR0cHM6Ly9teXNvZnRiYWxsbGVhZ3VleHl6LmNvbS9zdWNjZXNzIiwidW5zdWNjZXNzZnVsX3JldHVybl91cmwiOiJodHRwczovL215c29mdGJhbGxsZWFndWV4eXouY29tL2ZhaWx1cmUiLCJleHBpcmVkX3Nlc3Npb25fdXJsIjoiaHR0cHM6Ly9teXNvZnRiYWxsbGVhZ3VleHl6LmNvbS9leHBpcmVkIiwidGVybXNfb2Zfc2VydmljZV91cmwiOiJodHRwczovL215c29mdGJhbGxsZWFndWV4eXouY29tL3Rlcm1zIiwiZXhwaXJhdGlvbl9pbl9taW51dGVzIjoyNjI4MDB9LCJicmFuZGluZyI6eyJicmFuZF9jb2xvciI6IiMxMTE4MjMiLCJhY2NlbnRfY29sb3IiOiIjZjNlZWVlIiwibG9nbyI6Imh0dHBzOi8vczMuYW1hem9uYXdzLmNvbS9jdXN0b21lci11cGxvYWRlZC1hc3NldHMtcHJvZC8xMS0xNi0yMDIzLTA0XzE2XzI3XzIwMjItMDQtMjgtMjJfNTZfMzMtZmluaXgtbG9nby12Mi5wbmdfMGZlZWZjNmQtMDZmZS00YzUwLWE1ZTQtOTFkZmViMTgzNDgyIiwiaWNvbiI6IiJ9LCJlbnRpdHlfaWQiOiJwYXltZW50X2xpbmtfYzV4MjgyQk5ya0RiN2RyWm1UVTNrIn0.d4l3PeXT-y6ZFRyXiEFdoTYoHqx6SXkvM6SkJYvAvxOylzoSsqj1hIYT_si-j0hnzfqYuVwfkqwlUAkkCucWJmzSOX7KWWqxSQzGNziJqR0DCshxG4X051lYsYnyHC5kf--vt_wvFYnsElvmUZBod7XTM64AzbXIXD_zp46dcuLdLuekBAYHuuR7D6IrrBVBzkOlzHFHVIdMW3XVJymiT21PqTrk_LlOTTr0KZf94CZ5whOQdtm6qN6-QinyPp34TkWBprEnYUEIeET7Or6AuXsbL7CEATYO1FK4FTUqptRe257_WlMvTOBuvMybF8q1ix3y1UaiA1X6PqS0jdL63CYrMDt7gAFQcoRV20JPhfAA86INslzhpmQwmVpy5iL7bO3kgZmoKif9mIZrx2V6NR5iAXrhvoeEl4D2g8bzu7KAadVwlDSUctrG7NZa73SWe7vR1HnD_uIOGG_r_n0PRKy_CiPNA6EaNjNWjMheynATLIv04kaOb4MWt_wVL9jkc0rrw5o-WE88Ux0EToUdujKKbsfixpEEDESR7a-Vb9GIQ53dxTGWjGyEwBOBtQLcaILjVv47cRfGWtL8Z3N0tzTWeuZHteBt6uk7pTdRrnZdLlS1Ze-EYb4-40pwv-pRUgRO5l5JUqBDE164LcpqSmSXIiE4JnfKwaW6E0Sw8Wk

Step 3: Track your Payment Link

After the buyer completes the payment, you can review the details of the transactions on either the:

  1. Transactions > Payments page. Every successful payment will appear on the Payments page
  2. On the Payment Links details page. Here you can track the individual performance of individual payment links.

To get real-time payment updates, integrate with our webhooks.

Finix API

To create a payment link, include:

  • The ID of the Merchant that the payment will be created under.
  • The amount of the transaction.
  • Any additional URLs (terms of service required).
  • Allowed payment methods.

At this time, only APPROVED Merchants with one of the following processors can create payment links:

  • DUMMY_V1
  • LITLE_V1
  • FINIX_V1
Copy
Copied
curl https://finix.sandbox-payments-api.com/payment_links \
  -H 'Content-Type: application/json' \
  -H 'Finix-Version: 2022-02-01' \
  -u USksBJMwkNUz5GyxPevL2yFY:71b641c1-861d-435b-9a9c-532760731c5e \
  -X POST \
  -d '{
    "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
    "application_id": "AP32VuKPGvgg4qEVo54qazAD",
    "payment_frequency": "ONE_TIME",
    "is_multiple_use": true,
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "nickname": "Basketball League Holiday Dinner 2",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855"
        },
        "price_details": {
          "sale_amount": 7500,
          "currency": "USD"
        }
      }
    ],
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "additional_details": {
      "collect_name": false,
      "collect_email": true,
      "collect_phone_number": false,
      "collect_shipping_address": false,
      "collect_billing_address": false,
      "expiration_in_minutes": 1576800,
      "terms_of_service_url": "https://mybasketball-leaguexyz.com/terms",
      "success_return_url": "https://mybasketball-leaguexyz.com/success",
      "unsuccessful_return_url": "https://mybasketball-leaguexyz.com/failure",
      "expired_session_url": "https://mybasketball-leaguexyz.com/expired"
    },
    "branding": {
      "brand_color": "#111823",
      "accent_color": "#f3eeee",
      "logo": "https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482",
      "icon": ""
    }
  }'

Example Response

Copy
Copied
{
    "id": "payment_link_c5yAw6QxmcNx4USZhv4C6",
    "created_at": "2023-11-23T21:55:26.607332Z",
    "updated_at": "2023-11-23T21:55:26.935152Z",
    "application_id": "AP32VuKPGvgg4qEVo54qazAD",
    "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
    "payment_frequency": "ONE_TIME",
    "is_multiple_use": false,
    "allowed_payment_methods": [
        "PAYMENT_CARD"
    ],
    "nickname": "Basket Ball Dinner 3",
    "items": [
        {
            "image_details": {
                "primary_image_url": "https://assets.bonappetit.com/photos/6348838979beb39578db546f/16:9/w_2580%2Cc_limit/20220825-1122-TURKEY-8111.jpg",
                "alternative_image_urls": null
            },
            "description": null,
            "price_details": {
                "sale_amount": 7500,
                "currency": "USD",
                "price_type": null,
                "regular_amount": 0
            },
            "name": "Holiday Dinner 3",
            "quantity": 1
        }
    ],
    "buyer_details": null,
    "amount_details": {
        "amount_type": "FIXED",
        "total_amount": 7500,
        "currency": "USD",
        "min_amount": null,
        "max_amount": null,
        "amount_breakdown": null
    },
    "branding": {
        "brand_color": "#111823",
        "accent_color": "#f3eeee",
        "logo": "https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-logo-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482",
        "icon": ""
    },
    "additional_details": {
        "collect_name": false,
        "collect_email": true,
        "collect_phone": false,
        "collect_billing_address": false,
        "collect_shipping_address": false,
        "generate_receipt": false,
        "success_return_url": "",
        "unsuccessful_return_url": "",
        "expired_session_url": "",
        "terms_of_service_url": "https://assets.bonappetit.com/photos/6348838979beb39578db546f/16:9/w_2580%2Cc_limit/20220825-1122-TURKEY-8111.jpg",
        "expiration_in_minutes": 10080
    },
    "state": "ACTIVE",
    "tags": {},
    "link_url": "https://finix.sandbox-payments-checkout.com/payment_link?bearer_token=eyJ0eXAiOiJKV1MiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJVU2tzQkpNd2tOVXo1R3l4UGV2TDJ5RlkiLCJhdWQiOiIqLmhvc3RlZC1wYXltZW50cy1odHRwLmZpbml4b3BzLmNvbSIsImlzcyI6ImF1dGhlbnRpY2F0aW9uLnNiLmZpbml4b3BzLmNvbSIsImlhdCI6MTcwMDc3NjUyNiwiZXhwIjoxNzAxMzgxMzI2LCJlbnRpdHlfdHlwZSI6IlBBWU1FTlRfTElOSyIsImFkZGl0aW9uYWxfZGV0YWlscyI6eyJjb2xsZWN0X25hbWUiOmZhbHNlLCJjb2xsZWN0X2VtYWlsIjp0cnVlLCJjb2xsZWN0X3Bob25lIjpmYWxzZSwiY29sbGVjdF9iaWxsaW5nX2FkZHJlc3MiOmZhbHNlLCJjb2xsZWN0X3NoaXBwaW5nX2FkZHJlc3MiOmZhbHNlLCJnZW5lcmF0ZV9yZWNlaXB0IjpmYWxzZSwic3VjY2Vzc19yZXR1cm5fdXJsIjoiIiwidW5zdWNjZXNzZnVsX3JldHVybl91cmwiOiIiLCJleHBpcmVkX3Nlc3Npb25fdXJsIjoiIiwidGVybXNfb2Zfc2VydmljZV91cmwiOiJodHRwczovL2Fzc2V0cy5ib25hcHBldGl0LmNvbS9waG90b3MvNjM0ODgzODk3OWJlYjM5NTc4ZGI1NDZmLzE2Ojkvd18yNTgwJTJDY19saW1pdC8yMDIyMDgyNS0xMTIyLVRVUktFWS04MTExLmpwZyIsImV4cGlyYXRpb25faW5fbWludXRlcyI6MTAwODB9LCJicmFuZGluZyI6eyJicmFuZF9jb2xvciI6IiMxMTE4MjMiLCJhY2NlbnRfY29sb3IiOiIjZjNlZWVlIiwibG9nbyI6Imh0dHBzOi8vczMuYW1hem9uYXdzLmNvbS9jdXN0b21lci11cGxvYWRlZC1hc3NldHMtcHJvZC8xMS0xNi0yMDIzLTA0XzE2XzI3XzIwMjItMDQtMjgtMjJfNTZfMzMtZmluaXgtbG9nby12Mi5wbmdfMGZlZWZjNmQtMDZmZS00YzUwLWE1ZTQtOTFkZmViMTgzNDgyIiwiaWNvbiI6IiJ9LCJlbnRpdHlfaWQiOiJwYXltZW50X2xpbmtfYzV5QXc2UXhtY054NFVTWmh2NEM2In0.D91NlAqgNBfX7ekpUTqlKEJ6kplBCXavQH53c9rLABrB5fipQujMrawnEhhMbplw7Vwi6OjnrAB1-_OHnbITbF211ZE3x5UnGRAqCnm6E-bmtHtt4K37EwHPrgIJIwmMx2EbDsH-hsZnd6Q2mcNfTo8NNkTM-cDn_fuJuA-38MtNeZAZ-gYmmQkFfVPQSXeftNYXX9nspoTcbgW1y6r4iO7IkhKItPrgenI2tAM5Nd0-Lkii86p7LAEswtKxiM7l-axsxJ0tqJCCt1FNFsJMEY9gMOAWyoQ_P0GGjzXHQfWVl4aOBO_9AadI1YuGz0zbNy90yX024R3VoT6n1WrAmKYSxtw0XRXe07zWlE-YQc-NBz-JWRgoZCGCAYB9_XYzhQBqfg6Qq-kC0CC6LIIBsuaHVdhrOkIS7x1T72KWEhgWpmGKufiSEW3RNtGA_QMlqO4i-AH6vSj-lbHSURtqeiSAKUDj9IX7ixr0pg6YpLvTI_AYHIXmJGjuHTRXEOJtOpTOXS18LoJBQn-M8x7T0JC4IOJ4LHDPdJkPwboaN3Svy85DQ7HC3s8hZuygUd8gcjO8QBtydUlOIWebSx0k5CqCgq2FT9GMotMOED6famhG2bHJAVAbjyzRBINhRpPSF8PLDCk0UNEHTJshXT_p7uUdzU8ZhcNbfUr5h_xYkt0",
    "link_expires_at": "2024-05-21T21:55:26.630564Z",
    "_links": {
        "self": {
            "href": "https://finix.sandbox-payments-api.com/payment_links/payment_link_c5yAw6QxmcNx4USZhv4C6"
        }
    }
}

HTTP Request

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

Request Arguments

Field Type Description
merchant_id string, required The ID of the Merchant the payment is getting created under.

Only approved Merchants with one of the following processors can create payment links: DUMMY_V1, LITLE_V1 or FINIX_V1.
payment_frequency string, required Details if a payment created from a payment link is:
  • ONE_TIME
  • RECURRING
At this time, only ONE_TIME is supported.
is_multiple_use boolean, optional If set to True, the payment link can be used for multiple purchases.
allowed_payment_methods array, required Payment methods allowed on the payment link.
nickname string, required Descriptor name of the payment link.
items object, required Details the items or services used in the payment form.
tags object, optional Key value pair for annotating custom metadata (e.g. order numbers).
buyer_details object, optional Object containing details about the buyer. This object is only used for SINGLE_USE payment links.
amount_details object, optional Object containing details about the amount getting charged by the payment link.
branding object, optional Object containing branding details for the payment link.
additional_details object, optional Object containing additional details about the payment link.

Request Arguments - items array

Field Type Description
item.description string, optional Description for the item.
item.image_details object, optional Additional details about the item image.
item.price_details object, optional Additional details about the price.

Request Arguments - items.image_details

Field Type Description
item.image_details.primary_image_url string, optional Primary image URL for the item.
item.image_details.alternative_image_urls array, optional Secondary image URLs for the item.

Request Arguments - items.price_details

Field Type Description
item.price_details.current_price string, optional Details the sale price of the item if different from the regular_price.
item.price_details.currency string, optional 3-letter ISO code designating the currency of the Transfers (e.g. USD).
item.price_details.current_price_type string, optional Add additional details noting if the price is discounted or on sale.
item.price_details.regular_price string, optional The standard price of the item without any adjustments applied (e.g. discounts, taxes, sales).
item.quantity string, optional Set how many units of the item are part of the transaction.

Request Arguments - buyer_details

Field Type Description
identity_id string, optional The Identity ID of the buyer.
first_name string, optional First name of the buyer.
last_name string, optional Last name of the buyer.

Request Arguments - amount_details

Field Type Description
amount_type integer, optional The Identity ID of the buyer.
total_amount integer, optional First name of the buyer.
currency string, optional 3-letter ISO code designating the currency of the Transfers (e.g. USD).
min_amount integer, optional Min amount allowed for VARIABLE amount links.
max_amount integer, optional Max amount allowed for VARIABLE amount links.
amount_breakdown object, optional Breakdown of the total_amount.

Request Arguments - amount_breakdown

Field Type Description
subtotal_amount integer, optional Subtotal amount before tax and other fees.
shipping_amount integer, optional Shipping amount.
estimated_tax_amount integer, optional Estimated tax amount.
min_amount integer, optional Discount amount in cents.
tip_amount integer, optional Tip amount in cents.

Request Arguments - branding

Field Type Description
brand_color string, optional Hex code of branding color (e.g. #F2F2F2).
accent_color string, optional Hex code of the accent color.
logo string, optional URL of the logo for the payment link.
icon string, optional URL for the icon of the payment link.

Request Arguments - additional_details

Field Type Description
collect_name boolean, optional Collect name from the payment link. Defaults to true.
collect_email_address boolean, optional Collect email address from the payment link
collect_billing_address boolean, optional Collect billing address from the payment link. Defaults to false.
collect_shipping_address string, optional Collect shipping address from the payment link.
success_return_url string, optional URL to redirect the user to, after the payment is successful.
unsuccessful_return_url string, optional URL to redirect the user to after the payment is unsuccessful.
expired_session_url string, optional URL to redirect the user to if the payment link has expired.
terms_of_service_url string, required Terms of service URL for payment links.
expiration_in_minutes string, optional Expiration for the payment links in minutes.

Successful Purchase

When a buyer successfully submits a purchase using a payment link, the status of the payment link updates to COMPLETED.

Finix will also create a purchase that contains additional details about the successfully submitted payment link.

Example Response

Copy
Copied
{
  "id": "purchase_b7lpaKsgmwlDsbpS1P58R2",
  "created_at": "2023-08-22T17:16:19.8Z",
  "updated_at": "2023-08-22T17:16:19.8Z",
  "merchant_id": "MUeDVrf2ahuKc9Eg5TeZugvs",
  "application_id": "APgPDQrLD52TYvqazjHJJchM",
  "amount": "10",
  "currency": "USD",
  "state": "SUCCEEDED",
  "payment_frequency": "string",
  "transfer_id": "TRhw2BGAqyFZcrjTYXq4qTvY",
  "payment_instrument_id": "PIe2YvpcjvoVJ6PzoRPBK137",
  "entity_id": "payment_link_h6htoPnfwmgGdvaG4L67Q1", 
  "entity_type": "PAYMENT_LINK", 
  "buyer_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "abc@test.com",
    "identity_id": "IDuqZpDw28f2KK6YuDk4jNLg",
    "phone": "1234567890"
    "billing_address": {
      "country": "USA",
      "region": "CA",
      "city": "SF",
      "line1": "631 howard st",
      "line2": "string",
      "postal_code": "94105"
    },
    "shipping_address": {
      "country": "USA",
      "region": "CA",
      "city": "SF",
      "line1": "631 howard st",
      "line2": "string",
      "postal_code": "94105"
    }
  },
  "tags": {
    "abc": "xyz"
  },
  "_links": {
    "self": {
      "href": "https://finix.sandbox-payments-api.com/payment_links/payment_link_b7lpaKsgmwlDsbpS1P58R2"
  }
}

The purchase resource contains the additional details collected as specified in the additional_details object. Each purchase also includes a link to a transfer which details information about the transaction and any other fees associated with the payment.

Terms of Service

attention

Before creating your first payment link, you must include a URL to your terms of service.

Sellers must inform buyers of the terms and conditions that apply to their purchases. This means you must include your terms and services with every payment link you create.