Payment Links
create individual links you can send to buyers to complete a transaction. You can share these links on different platforms such as web pages, email, text, or QR codes.
Related Guides: Payment Links
Retrieve a list of previously created Payment Links
.
Payment Links
are links you can send to buyers to complete a transaction. You can share these links on web pages, email, text, QR codes, and more.
Related guides: Payment Links.
For details on how to query endpoints using the available parameters, see Query Parameters.
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Example response
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/payment_links" \ -H "Finix-Version: 2022-02-01" \ -u USksBJMwkNUz5GyxPevL2yFY:71b641c1-861d-435b-9a9c-532760731c5e
{- "_embedded": {
- "payment_links": [
- {
- "id": "payment_link_ceBaS82SqvsTeg84MDVaF",
- "created_at": "2024-08-26T23:44:03.41Z",
- "updated_at": "2024-08-26T23:44:03.58Z",
- "additional_details": {
- "collect_name": "true",
- "collect_email": "true",
- "collect_phone": "false",
- "collect_billing_address": "false",
- "collect_shipping_address": "false",
- "expiration_in_minutes": "1576800",
- "send_receipt": "true",
- "receipt_requested_delivery_methods": [
- {
- "type": "EMAIL",
- "destinations": [
- "abc@test.com"
]
}, - {
- "type": "SMS",
- "destinations": [
- "2348765431"
]
}
]
}, - "allowed_payment_methods": [
- "BANK_ACCOUNT",
- "PAYMENT_CARD"
], - "amount_details": {
- "amount_type": "FIXED",
- "total_amount": "7500",
- "currency": "USD",
- "min_amount": null,
- "max_amount": null,
- "amount_breakdown": null
}, - "application_id": "AP32VuKPGvgg4qEVo54qazAD",
- "branding": {
- "brand_color": "#111823",
- "accent_color": "#f3eeee",
- "logo_alternative_text": null,
- "button_font_color": null
}, - "buyer_details": null,
- "is_multiple_use": "true",
- "items": [
- {
- "image_details": {
- "primary_image_url": "https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855",
- "alternative_image_urls": null
}, - "description": null,
- "price_details": {
- "sale_amount": "7500",
- "currency": "USD",
- "price_type": null,
- "regular_amount": "0"
}, - "name": "Holiday Dinner Contribution",
- "quantity": "1"
}
], - "link_expires_at": "2027-08-26T23:44:03.338674Z",
- "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
- "nickname": "Basketball League Holiday Dinner 2",
- "payment_frequency": "ONE_TIME",
- "state": "ACTIVE",
- "tags": null
}, - {
- "id": "payment_link_ceBaKV1D76peSvQt1bPYp",
- "created_at": "2024-08-26T23:42:39.20Z",
- "updated_at": "2024-08-26T23:42:39.34Z",
- "additional_details": {
- "collect_name": "true",
- "collect_email": "true",
- "collect_phone": "false",
- "collect_billing_address": "false",
- "collect_shipping_address": "false",
- "expiration_in_minutes": "1576800",
- "send_receipt": "true",
- "receipt_requested_delivery_methods": [
- {
- "type": "EMAIL",
- "destinations": [
- "abc@test.com"
]
}, - {
- "type": "SMS",
- "destinations": [
- "2348765431"
]
}
]
}, - "allowed_payment_methods": [
- "BANK_ACCOUNT",
- "PAYMENT_CARD"
], - "amount_details": {
- "amount_type": "FIXED",
- "total_amount": "7500",
- "currency": "USD",
- "min_amount": null,
- "max_amount": null,
- "amount_breakdown": null
}, - "application_id": "AP32VuKPGvgg4qEVo54qazAD",
- "branding": {
- "brand_color": "#111823",
- "accent_color": "#f3eeee",
- "logo_alternative_text": null,
- "button_font_color": null
}, - "buyer_details": null,
- "is_multiple_use": "true",
- "items": [
- {
- "image_details": {
- "primary_image_url": "https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855",
- "alternative_image_urls": null
}, - "description": null,
- "price_details": {
- "sale_amount": "7500",
- "currency": "USD",
- "price_type": null,
- "regular_amount": "0"
}, - "name": "Holiday Dinner Contribution",
- "quantity": "1"
}
], - "link_expires_at": "2027-08-26T23:42:39.156853Z",
- "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
- "nickname": "Basketball League Holiday Dinner 2",
- "payment_frequency": "ONE_TIME",
- "state": "ACTIVE",
- "tags": null
}
]
}, - "_links": {
}, - "page": {
- "limit": "100",
- "next_cursor": "payment_link_c7ADJ9PLbidXLX17iLGSZ"
}
}
Create a Payment Link
to help a buyer submit a payment.
Payment Links
create individual links you can send to buyers to complete a transaction. You can share these links on different platforms such as web pages, email, text, or QR codes.
Create a Payment Link
to help a buyer submit a payment.
Related guides: Payment Links.
Accept | string Default: application/hal+json |
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Example response
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
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": true, "collect_email": true, "collect_phone": false, "collect_billing_address": false, "collect_shipping_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", "send_receipt": true, "receipt_requested_delivery_methods": [ { "type": "EMAIL", "destinations": [ "abc@test.com" ] }, { "type": "SMS", "destinations": [ "2348765431" ] } ] }, "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": "https://s3.amazonaws.com/customer-uploaded-assets-prod/11-16-2023-04_16_27_2022-04-28-22_56_33-finix-icon-v2.png_0feefc6d-06fe-4c50-a5e4-91dfeb183482" } }'
{- "id": "payment_link_ceBaS82SqvsTeg84MDVaF",
- "created_at": "2024-08-26T23:44:03.414715Z",
- "updated_at": "2024-08-26T23:44:03.414715Z",
- "application_id": "AP32VuKPGvgg4qEVo54qazAD",
- "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
- "payment_frequency": "ONE_TIME",
- "is_multiple_use": "true",
- "allowed_payment_methods": [
- "BANK_ACCOUNT",
- "PAYMENT_CARD"
], - "nickname": "Basketball League Holiday Dinner 2",
- "items": [
- {
- "image_details": {
- "primary_image_url": "https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855",
- "alternative_image_urls": null
}, - "description": null,
- "price_details": {
- "sale_amount": "7500",
- "currency": "USD",
- "price_type": null,
- "regular_amount": "0"
}, - "name": "Holiday Dinner Contribution",
- "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_alternative_text": null,
- "button_font_color": null
}, - "additional_details": {
- "collect_name": "true",
- "collect_email": "true",
- "collect_phone": "false",
- "collect_billing_address": "false",
- "collect_shipping_address": "false",
- "expiration_in_minutes": "1576800",
- "send_receipt": "true",
- "receipt_requested_delivery_methods": [
- {
- "type": "EMAIL",
- "destinations": [
- "abc@test.com"
]
}, - {
- "type": "SMS",
- "destinations": [
- "2348765431"
]
}
]
}, - "state": "ACTIVE",
- "tags": null,
- "link_expires_at": "2027-08-26T23:44:03.338674Z",
- "_links": {
}
}
Retrieve the details of a previously created Payment Link
.
Finix-Version | string Default: 2018-01-01 Specify the API version of your request. For more details, see Versioning. Example: 2022-02-01 |
Example response
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
Invalid field
curl "https://finix.sandbox-payments-api.com/payment_links/payment_link_ceBaS82SqvsTeg84MDVaF" \ -H "Finix-Version: 2022-02-01" \ -u USksBJMwkNUz5GyxPevL2yFY:71b641c1-861d-435b-9a9c-532760731c5e
{- "id": "payment_link_ceBaS82SqvsTeg84MDVaF",
- "created_at": "2024-08-26T23:44:03.414715Z",
- "updated_at": "2024-08-26T23:44:03.414715Z",
- "application_id": "AP32VuKPGvgg4qEVo54qazAD",
- "merchant_id": "MUaC9hbNvRwBoCJzqrjWk69N",
- "payment_frequency": "ONE_TIME",
- "is_multiple_use": "true",
- "allowed_payment_methods": [
- "BANK_ACCOUNT",
- "PAYMENT_CARD"
], - "nickname": "Basketball League Holiday Dinner 2",
- "items": [
- {
- "image_details": {
- "primary_image_url": "https://shop.momofuku.com/cdn/shop/articles/Holidays_2021_Table_Spread_3.jpg?v=1636317855",
- "alternative_image_urls": null
}, - "description": null,
- "price_details": {
- "sale_amount": "7500",
- "currency": "USD",
- "price_type": null,
- "regular_amount": "0"
}, - "name": "Holiday Dinner Contribution",
- "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_alternative_text": null,
- "button_font_color": null
}, - "additional_details": {
- "collect_name": "true",
- "collect_email": "true",
- "collect_phone": "false",
- "collect_billing_address": "false",
- "collect_shipping_address": "false",
- "expiration_in_minutes": "1576800",
- "send_receipt": "true",
- "receipt_requested_delivery_methods": [
- {
- "type": "EMAIL",
- "destinations": [
- "abc@test.com"
]
}, - {
- "type": "SMS",
- "destinations": [
- "2348765431"
]
}
]
}, - "state": "ACTIVE",
- "tags": null,
- "link_expires_at": "2027-08-26T23:44:03.338674Z",
- "_links": {
}
}