SEND Payment Receipt

this api is very similar to "send payment link" and will allow you to send the payment receipt 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 view their receipt for a given invoice note the invoice must have a payment already made in order for them to see the receipt otherwise, this will simply take them to the payment page (ala send payment link) for hipaa purposes, the content of either the sms or the email will not include the receipt details instead it will include a link for the patient to view their receipt details from your backend code, send the patient an email with their invoice receipt 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 you can choose to send the link for a basic receipt or for an itemized receipt the itemized receipt will show each individual line item and the associated costs, whereas the non itemized receipt will only show the high level details of the invoice the only distinction between the 2 api calls is the endpoint you will hit { "tab" "examples", "url" "https //test api featherpay io/api/v1/notifications/{orderid}/send pay receipt itemized", "name" "send payment receipt (itemized)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "types", "type" "array", "description" "can be “email” and/or “sms” default is “email”" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "7lgwldeetkw1p1bc0limq", "code" "{\\"message\\" \\"email was sent successfully\\"}", "language" "200", "customlabel" "" }, { "id" " jeqqe1oo9aotl1sm efp", "code" "{\n \\"suberrors\\" \[],\n \\"status\\" \\"bad request\\",\n \\"message\\" \\"id 017fb8be ce71 437a 8a3d 7f19f74f6d41 does not match a saved store\\"\n}\n", "language" "400", "customlabel" "" } ], "selectedlanguageid" "7lgwldeetkw1p1bc0limq" }, "examples" { "languages" \[ { "id" "dips18nvcqgwgc fksc2y", "code" "curl x post \\\\\n url 'https //test api featherpay io/api/v1/notifications/order/\ orderid/send pay receipt itemized' \\\\\n header 'content type application/json;charset=utf 8' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}' \\\\\n data '{\n \\"types\\" \[\\"email\\"] //can be “email” and/or “sms” default is “email”\n }'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dips18nvcqgwgc fksc2y" }, "description" "send payment receipt (itemized) via email or sms", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //test api featherpay io/api/v1/notifications/{orderid}/send pay receipt", "name" "send payment receipt (non itemized)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "types", "type" "array", "description" "can be “email” and/or “sms” default is “email”" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "7lgwldeetkw1p1bc0limq", "code" "{\\"message\\" \\"email was sent successfully\\"}", "language" "200", "customlabel" "" }, { "id" " jeqqe1oo9aotl1sm efp", "code" "{\n \\"suberrors\\" \[],\n \\"status\\" \\"bad request\\",\n \\"message\\" \\"id 017fb8be ce71 437a 8a3d 7f19f74f6d41 does not match a saved store\\"\n}\n", "language" "400", "customlabel" "" } ], "selectedlanguageid" "7lgwldeetkw1p1bc0limq" }, "examples" { "languages" \[ { "id" "dips18nvcqgwgc fksc2y", "code" "curl x post \\\\\n url 'https //test api featherpay io/api/v1/notifications/order/\ orderid/send pay receipt' \\\\\n header 'content type application/json;charset=utf 8' \\\\\n header 'accept application/json' \\\\\n header 'x api key {secret api key}' \\\\\n header 'x store id {store ulid}' \\\\\n data '{\n \\"types\\" \[\\"email\\"] //can be “email” and/or “sms” default is “email”\n }'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dips18nvcqgwgc fksc2y" }, "description" "send payment receipt (non itemized) via email or sms", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }