SEND Payment Link
Send the link to your patient. The link can be sent via SMS and/or Email. This link will take them to a white-listed version of FeatherPay to complete their payment.
From your backend code, send the patient an email with their invoice link using your API key and Order ID. This will send to the email identified by customerEmail and/or via SMS identified by billingAddress.telephone on the order.
By default, when the link is generated, the patient will have 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) and the expiration of the link will be updated.
- typesArrayDescription
curl -X POST \
--url 'https://test-api.featherpay.io/api/v1/notifications/order/:orderId/send-pay-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}' \
--data '{
"types": ["email"] //Can be “email” and/or “sms”. Default is “email”
}'{"message":"Email was sent successfully"}{
"subErrors":[],
"status":"BAD_REQUEST",
"message":"Id: 017fb8be-ce71-437a-8a3d-7f19f74f6d41 does not match a saved store"
}