GET Payment Link
Get the link to send to your patient. This link will take them to a white-listed version of iCorePay to complete their payment. After they pay, we will send a Webhook (documented later) to update your system with the status of orders and/or payment transactions.
Use this instead of (or in conjuction with) SEND Payment Link if you want to control how the link is delivered and/or displayed
From your backend code, get the patient link using your API key and Order ID. There are two types of link, the regular link will allow the patient 3 chances to hit the URL or 72 hours. If they do not pay after 3 hits to the URL (or 72 hours later), they will have a button to send a new link to the email address provided in the Create Order API call above. Â
Every time the below API call is made, it increases the number of retries for a patient (e.g. from 3 to 4).
curl --request GET \
--url 'https://gfp-api.acdev.io/api/v1/orders/:orderId/payment-link' \
--header 'content-type: application/json;charset=UTF-8' \
--header 'accept: application/json' \
--header 'X-Api-Key: {Secret API Key}' \
--header 'X-Store-Id: {Store ULID}'{
"patientLink": "https://gfp-pay.acdev.io/invoice/01FDW69FYZCGKQS9BY0G1W25CM/01FDZF7CAZS9SQYVFEAHJ2ZNN8",
"expires":"2022-03-26T21:53:07.236242"
}The short link on the other hand requires additional verification from the patient; zip code, email or phone number depending on what details are available on the order. This link does not expire.
curl --request GET \
--url 'https://gfp-api.acdev.io/api/v1/orders/:orderId/payment-link-short-url' \
--header 'content-type: application/json;charset=UTF-8' \
--header 'accept: application/json' \
--header 'X-Api-Key: {Secret API Key}' \
--header 'X-Store-Id: {Store ULID}'{
"patientLink": "https://gfp-pay.acdev.io/p/krukmDdeTq"
}