Payment Links
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) { "tab" "examples", "url" "https //gfp api acdev io/api/v1/orders/{orderid}/payment link", "name" "get payment link", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "setbcxdu 4s8zb8lunohb", "code" "{\n \\"patientlink\\" \\"https //gfp pay acdev io/invoice/01fdw69fyzcgkqs9by0g1w25cm/01fdzf7cazs9sqyvfeahj2znn8\\",\n \\"expires\\" \\"2022 03 26t21 53 07 236242\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "setbcxdu 4s8zb8lunohb" }, "examples" { "languages" \[ { "id" "cxzmcrzoqg6xnberloyox", "code" "curl request get \\\\\n url 'https //gfp api acdev io/api/v1/orders/\ orderid/payment link' \\\\\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}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cxzmcrzoqg6xnberloyox" }, "description" "generete a payment link to send to patient", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } 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 { "tab" "examples", "url" "https //gfp api acdev io/api/v1/orders/{orderid}/payment link short url", "name" "get payment link (short)", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "setbcxdu 4s8zb8lunohb", "code" "{\n \\"patientlink\\" \\"https //gfp pay acdev io/p/krukmddetq\\"\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "setbcxdu 4s8zb8lunohb" }, "examples" { "languages" \[ { "id" "cxzmcrzoqg6xnberloyox", "code" "curl request get \\\\\n url 'https //gfp api acdev io/api/v1/orders/\ orderid/payment link short url' \\\\\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}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "cxzmcrzoqg6xnberloyox" }, "description" "generete a payment link to send to patient", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }