Payment Link Overview
Statuses
Payment links object have several statuses:
Status | Final? | Description |
---|---|---|
Pending | No | The payment link has been created but the payer did not initiated the payment yet (or the payment has been initiated but we do not have sufficient blockchain confirmation yet). |
Completed | Yes | The payment link has been fully paid by the payer. In case of overpayment , the payment link status will also be shown as completed and the excess amount will be returned to the payer. |
Underpaid | Yes | The payer did not sent enough funds. It will be completely refunded (subject to refund processing costs) by Fipto. |
Expired | Yes | The payment link expired either because the expiration date has been reached OR the 15 minute quote lock timer reached the end. |
Workflow
Integrating the Payment Link API involves the following steps:
- Counterparty Validation: The customer confirms their shopping cart or requests to make a deposit on your platform.
- POST /payment-links: You call the Payment Link API, providing details of the transaction including the payment amount, an external reference, and an optional expiration date.
- URL Generation: Our product generates a payment link and returns it in the API response. You can then redirect the customer to this link, where they can complete their payment using cryptocurrency.
- Status Update: After the customer completes the payment, the status of the payment link is updated to
completed
, indicating that the transaction has been successfully processed.
Payment flow
Updated 7 months ago