Payment Links

a payment link is the simplest way to request payment from a customer here's how it works create a payment link by supplying a transaction amount (the amount you wish to request) provide your submerchant id for operators, you can supply the submerchant id of the account who should receive the transaction, for example a driver who has been allocated to a booking choose for us to send the payment link directly to your customer by sms, or if you prefer you can send the url to your customer via another channel the customer can open the link using any web browser, on any device, and make payment by entering their payment details you can view the status of a payment link by polling the api, or alternatively use our webhooks feature to be notified programatically when a payment link is completed api operations { "tab" "request", "url" "https //api cabcard services/v1/intents", "name" "create a payment link", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "saleamount", "type" "integer", "description" "requested transaction amount in currency minor units (i e pence)" }, { "kind" "required", "name" "submerchantid", "type" "string", "description" "submerchant id for the payment link" }, { "kind" "optional", "name" "currency", "type" "string", "description" "payment currency in iso 4217 alpha 3 format currently only gbp is supported " }, { "kind" "optional", "name" "customername", "type" "string", "description" "name of your customer" }, { "kind" "optional", "name" "customerphonenumber", "type" "string", "description" "mobile phone number ofcustomer (e 164)" }, { "kind" "optional", "name" "description", "type" "string", "description" "describe what the payment request is for" }, { "kind" "optional", "name" "reference", "type" "string", "description" "a reference code or number, useful for reconciliation purposes" }, { "kind" "optional", "name" "sendcustomersms", "type" "boolean", "description" "indicate whether you wish to sent the payment link to the customer via sms if you intend to provide the customer with the link directly, set this to false " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "f7xerd6frwj hnpq fibw", "code" "{\n \\"statusisfinal\\"\ false,\n \\"clientaccessurl\\" \\"https //pay cabcard services/?p=int l3bj84mc\&t=c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"clientaccessqrcode\\" \\"data\ image/png;base64,ivborw0kggoaaaansuheugaaaoeaaadhcaaaaaab2i2maaacreleqvr42u3bwxlqmawf0p7/t7+37xd3xhuintlzlqeshs9uwxi//55+/rasehisehisehisehisehkek/z5+/r14cux45u+eupv1/qocakjzxbej6cxpf9xxab4nltvmrmsem4vvmx96todonm7p1erehi+uhi5k3v1utez3r4sehisxituksmot32ehitpelbpropf6v3upqetehj+wpiekn/915er+osehj8txi3yq3pr8odgglnbpaihiehnheh+cvpn43z9eicsyiekjdxnoi43zxhv8boqtmuhr0jcwj2fqszlc+r95sjo8ne5mzcqchdhf1ib3ngf65lu9ggjcc8qzt5r7iczaze//60gishhqcjgbdfie9xat/dges2bkjdwvug4xjzwi6r9w7oift+okjbwu+fk7blfhjxa+fjvn5cq8fzhh/q43mrcsa9ozf63icqkvfxyjxpxivqbrr9lsei4sbdaw6wzst9cjl8mjxpcqsi9hembpvuynatwxf6+ge5islipcljthitukmwmaxspf0hishirmoint04qdgm/f68nishhkcjqi9appy9ddurg3aisehlukuwbyuhbkwjerywjebispkeynpbsnpae/edeiwkjctcwpqmwn/+z6jdvlw5cqskdhh1xpk1x/dqlkwsehirhcpoeffby0w1gck5mbqgjcc8rlo8zb5pgdglinpuqkhbp4wtjeqv7h4dtbrohieezwip1vt+/6btrvwupkjdwnghviuu/vg0bvumwkjdwxohk2fbft+7ph2/kpysehe8rvs2xyay/ishh84xpdsbxqe/3exishisclbuflemgq/avxepishircgwiebnmpr4m+l5vn5cq8hpcr12ehisehisehisehisehisez1z/aunjh4bw0sgfaaaaaelftksuqmcc\\",\n \\"receipturl\\"\ null,\n \\"id\\" \\"int l3bj84mc\\",\n \\"customersmssent\\"\ true,\n \\"customeremailsent\\"\ false,\n \\"saleamount\\" 1259,\n \\"currency\\" \\"gbp\\",\n \\"submerchantid\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"description\\" \\"payment request for taxi journey\\",\n \\"reference\\" \\"exmpl 01\\",\n \\"customername\\" \\"john smith\\",\n \\"brandidentifier\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"customerphonenumber\\" \\"+447763306128\\",\n \\"gratuityamount\\" 0,\n \\"gratuityenabled\\"\ true,\n \\"createdby\\" \\"usr 4fsacblknri74u8\\",\n \\"expiresat\\" \\"2022 05 25t12 00 12 770z\\",\n \\"paymentfacilitatorid\\" \\"pfc 3q12hkjyo6478c\\",\n \\"brand\\" {\n \\"payeename\\" \\"john smith\\",\n \\"smssendername\\" \\"taxi fleet\\",\n \\"payeeavatarurl\\" \\"https //pay cabcard services/default avatar png\\",\n \\"processorname\\" \\"cabcard services (uk) ltd\\",\n \\"receiptcontactinfo\\" \\"receipts\@cabcard services\\",\n \\"receiptsbaseurl\\" \\"https //receipts cabcard services\\"\n },\n \\"logs\\" \[\n \\"\[2022 05 18t12 00 12 900z] created by usr 4fsacblknri74u8\\",\n \\"\[2022 05 18t12 00 14 184z] customer sms sent to +447763306128\\"\n ],\n \\"updatedat\\" \\"2022 05 18t12 00 14 184z\\",\n \\"createdat\\" \\"2022 05 18t12 00 12 901z\\",\n \\"clientaccesstoken\\" \\"c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"status\\" \\"created\\",\n \\"amount\\" 1259,\n \\"statusexplanation\\"\ null,\n \\"customeripaddress\\"\ null,\n \\"customeripinfo\\"\ null,\n \\"customerdeviceinfo\\"\ null,\n \\"customeremailaddress\\"\ null,\n \\"threedsecuretoken\\"\ null,\n \\"cardtoken\\"\ null,\n \\"cardtokentype\\"\ null,\n \\"transactiondetails\\"\ null,\n \\"saleid\\"\ null,\n \\"succeededat\\"\ null\n}", "language" "201", "customlabel" "" }, { "id" " 8ldctw lcx4mwbp2v6ud", "code" "{\n \\"name\\" \\"validationerror\\",\n \\"message\\" \\"validation failed\\",\n \\"statuscode\\" 400,\n \\"error\\" \\"bad request\\",\n \\"details\\" \[\n {\n \\"saleamount\\" \\"\\\\\\"saleamount\\\\\\" is required\\"\n }\n ]\n}", "language" "400", "customlabel" "" }, { "id" "ba2hchi gsg71h meu6ex", "code" "{\n \\"message\\" \\"insufficient privileges \\"\n}", "language" "403", "customlabel" "" }, { "id" "xxhw2zz q 7je87xrecvd", "code" "{\n \\"message\\" \\"permisssion denied\\"\n}", "language" "401", "customlabel" "" } ], "selectedlanguageid" "f7xerd6frwj hnpq fibw" }, "examples" { "languages" \[ { "id" "v7krxe9elnzyiusjzxtgb", "code" "const fetch = require('node fetch');\n\nconst url = 'https //api cabcard services/v1/intents';\n\nconst body = {\n \\"saleamount\\" 1259,\n \\"currency\\" \\"gbp\\",\n \\"submerchantid\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"description\\" \\"payment request for taxi journey\\",\n \\"reference\\" \\"exmpl 01\\",\n \\"customername\\" \\"john smith\\",\n \\"brandidentifier\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"customerphonenumber\\" \\"+447763306128\\",\n \\"sendcustomersms\\" true,\n \\"expirynaturallanguage\\" \\"7 days\\"\n};\n\nconst options = {\n method 'post',\n headers {\n accept 'application/json',\n },\n body json stringify(body),\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "nodejs", "customlabel" "" } ], "selectedlanguageid" "v7krxe9elnzyiusjzxtgb" }, "description" "use this endpoint to create a payment link you can optionally send it to your customer \n\nthe only required parameters are saleamount and submerchantid note that transaction amounts should always be specified in currency minor units (for example pence) \n", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false } once created, you may wish to send the payment link directly to your customer (for example by embedding it within a message, email or invoice) use the clientaccessurl property for this alternatively, you can use the convenient clientaccessqrcode property, which is a qr code representation of the clientaccessurl { "tab" "examples", "url" "https //api cabcard services/v1/intents/\ id", "name" "retrieve a payment link", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id of the payment link to retrieve" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" " pwaeqqsypemdvaa1pos7", "code" "{\n \\"statusisfinal\\"\ false,\n \\"clientaccessurl\\" \\"https //pay cabcard services/?p=int l3bj84mc\&t=c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"clientaccessqrcode\\" \\"data\ image/png;base64,ivborw0kggoaaaansuheugaaaoeaaadhcaaaaaab2i2maaacreleqvr42u3bwxlqmawf0p7/t7+37xd3xhuintlzlqeshs9uwxi//55+/rasehisehisehisehisehkek/z5+/r14cux45u+eupv1/qocakjzxbej6cxpf9xxab4nltvmrmsem4vvmx96todonm7p1erehi+uhi5k3v1utez3r4sehisxituksmot32ehitpelbpropf6v3upqetehj+wpiekn/915er+osehj8txi3yq3pr8odgglnbpaihiehnheh+cvpn43z9eicsyiekjdxnoi43zxhv8boqtmuhr0jcwj2fqszlc+r95sjo8ne5mzcqchdhf1ib3ngf65lu9ggjcc8qzt5r7iczaze//60gishhqcjgbdfie9xat/dges2bkjdwvug4xjzwi6r9w7oift+okjbwu+fk7blfhjxa+fjvn5cq8fzhh/q43mrcsa9ozf63icqkvfxyjxpxivqbrr9lsei4sbdaw6wzst9cjl8mjxpcqsi9hembpvuynatwxf6+ge5islipcljthitukmwmaxspf0hishirmoint04qdgm/f68nishhkcjqi9appy9ddurg3aisehlukuwbyuhbkwjerywjebispkeynpbsnpae/edeiwkjctcwpqmwn/+z6jdvlw5cqskdhh1xpk1x/dqlkwsehirhcpoeffby0w1gck5mbqgjcc8rlo8zb5pgdglinpuqkhbp4wtjeqv7h4dtbrohieezwip1vt+/6btrvwupkjdwnghviuu/vg0bvumwkjdwxohk2fbft+7ph2/kpysehe8rvs2xyay/ishh84xpdsbxqe/3exishisclbuflemgq/avxepishircgwiebnmpr4m+l5vn5cq8hpcr12ehisehisehisehisehisez1z/aunjh4bw0sgfaaaaaelftksuqmcc\\",\n \\"receipturl\\"\ null,\n \\"id\\" \\"int l3bj84mc\\",\n \\"customersmssent\\"\ true,\n \\"customeremailsent\\"\ false,\n \\"saleamount\\" 1259,\n \\"currency\\" \\"gbp\\",\n \\"submerchantid\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"description\\" \\"payment request for taxi journey\\",\n \\"reference\\" \\"exmpl 01\\",\n \\"customername\\" \\"john smith\\",\n \\"brandidentifier\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"customerphonenumber\\" \\"+447763306128\\",\n \\"gratuityamount\\" 0,\n \\"gratuityenabled\\"\ true,\n \\"createdby\\" \\"usr 4fsacblknri74u8\\",\n \\"expiresat\\" \\"2022 05 25t12 00 12 770z\\",\n \\"paymentfacilitatorid\\" \\"pfc 3q12hkjyo6478c\\",\n \\"brand\\" {\n \\"payeename\\" \\"john smith\\",\n \\"smssendername\\" \\"taxi fleet\\",\n \\"payeeavatarurl\\" \\"https //pay cabcard services/default avatar png\\",\n \\"processorname\\" \\"cabcard services (uk) ltd\\",\n \\"receiptcontactinfo\\" \\"receipts\@cabcard services\\",\n \\"receiptsbaseurl\\" \\"https //receipts cabcard services\\"\n },\n \\"logs\\" \[\n \\"\[2022 05 18t12 00 12 900z] created by usr 4fsacblknri74u8\\",\n \\"\[2022 05 18t12 00 14 184z] customer sms sent to +447763306128\\"\n ],\n \\"updatedat\\" \\"2022 05 18t12 00 14 184z\\",\n \\"createdat\\" \\"2022 05 18t12 00 12 901z\\",\n \\"clientaccesstoken\\" \\"c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"status\\" \\"created\\",\n \\"amount\\" 1259,\n \\"statusexplanation\\"\ null,\n \\"customeripaddress\\"\ null,\n \\"customeripinfo\\"\ null,\n \\"customerdeviceinfo\\"\ null,\n \\"customeremailaddress\\"\ null,\n \\"threedsecuretoken\\"\ null,\n \\"cardtoken\\"\ null,\n \\"cardtokentype\\"\ null,\n \\"transactiondetails\\"\ null,\n \\"saleid\\"\ null,\n \\"succeededat\\"\ null\n}", "language" "200", "customlabel" "" }, { "id" "22kdssp5ngiciaumvc6 y", "code" "{\n \\"message\\" \\"payment intent not found\\"\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "22kdssp5ngiciaumvc6 y" }, "examples" { "languages" \[ { "id" "el2ltttdzwvszv9pwzp0r", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/int l3bj87hv';\nlet options = {\n method 'get',\n headers {\n accept 'application/json',\n }\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "nodejs", "customlabel" "" } ], "selectedlanguageid" "el2ltttdzwvszv9pwzp0r" }, "description" "get a payment link by its id", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "tab" "request", "url" "https //api cabcard services/v1/intents/", "name" "list payment links", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "optional", "name" "limit", "type" "number", "description" "limit the number of responses to be returned" }, { "kind" "optional", "name" "offset", "type" "number", "description" "offset the list start position use this to paginate results" }, { "kind" "optional", "name" "submerchantid", "type" "string", "description" "filter list by submerchant id" }, { "kind" "optional", "name" "status", "type" "string", "description" "filter list by payment link status" }, { "kind" "optional", "name" "amount", "type" "number", "description" "filter list by transaction amount (specify minor currency units)" }, { "kind" "optional", "name" "reference", "type" "string", "description" "filter list by payment link reference" } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "asylc qu5nywnhky7xgc3", "code" "\[\n {\n \\"statusisfinal\\"\ false,\n \\"clientaccessurl\\" \\"https //pay cabcard services/?p=int l3bj84mc\&t=c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"clientaccessqrcode\\" \\"data\ image/png;base64,ivborw0kggoaaaansuheugaaaoeaaadhcaaaaaab2i2maaacreleqvr42u3bwxlqmawf0p7/t7+37xd3xhuintlzlqeshs9uwxi//55+/rasehisehisehisehisehkek/z5+/r14cux45u+eupv1/qocakjzxbej6cxpf9xxab4nltvmrmsem4vvmx96todonm7p1erehi+uhi5k3v1utez3r4sehisxituksmot32ehitpelbpropf6v3upqetehj+wpiekn/915er+osehj8txi3yq3pr8odgglnbpaihiehnheh+cvpn43z9eicsyiekjdxnoi43zxhv8boqtmuhr0jcwj2fqszlc+r95sjo8ne5mzcqchdhf1ib3ngf65lu9ggjcc8qzt5r7iczaze//60gishhqcjgbdfie9xat/dges2bkjdwvug4xjzwi6r9w7oift+okjbwu+fk7blfhjxa+fjvn5cq8fzhh/q43mrcsa9ozf63icqkvfxyjxpxivqbrr9lsei4sbdaw6wzst9cjl8mjxpcqsi9hembpvuynatwxf6+ge5islipcljthitukmwmaxspf0hishirmoint04qdgm/f68nishhkcjqi9appy9ddurg3aisehlukuwbyuhbkwjerywjebispkeynpbsnpae/edeiwkjctcwpqmwn/+z6jdvlw5cqskdhh1xpk1x/dqlkwsehirhcpoeffby0w1gck5mbqgjcc8rlo8zb5pgdglinpuqkhbp4wtjeqv7h4dtbrohieezwip1vt+/6btrvwupkjdwnghviuu/vg0bvumwkjdwxohk2fbft+7ph2/kpysehe8rvs2xyay/ishh84xpdsbxqe/3exishisclbuflemgq/avxepishircgwiebnmpr4m+l5vn5cq8hpcr12ehisehisehisehisehisez1z/aunjh4bw0sgfaaaaaelftksuqmcc\\",\n \\"receipturl\\"\ null,\n \\"id\\" \\"int l3bj84mc\\",\n \\"customersmssent\\"\ true,\n \\"customeremailsent\\"\ false,\n \\"saleamount\\" 1259,\n \\"currency\\" \\"gbp\\",\n \\"submerchantid\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"description\\" \\"payment request for taxi journey\\",\n \\"reference\\" \\"exmpl 01\\",\n \\"customername\\" \\"john smith\\",\n \\"brandidentifier\\" \\"sub 2t4dp89kja9fnf79\\",\n \\"customerphonenumber\\" \\"+447763306128\\",\n \\"gratuityamount\\" 0,\n \\"gratuityenabled\\"\ true,\n \\"createdby\\" \\"usr 4fsacblknri74u8\\",\n \\"expiresat\\" \\"2022 05 25t12 00 12 770z\\",\n \\"paymentfacilitatorid\\" \\"pfc 3q12hkjyo6478c\\",\n \\"brand\\" {\n \\"payeename\\" \\"john smith\\",\n \\"smssendername\\" \\"taxi fleet\\",\n \\"payeeavatarurl\\" \\"https //pay cabcard services/default avatar png\\",\n \\"processorname\\" \\"cabcard services (uk) ltd\\",\n \\"receiptcontactinfo\\" \\"receipts\@cabcard services\\",\n \\"receiptsbaseurl\\" \\"https //receipts cabcard services\\"\n },\n \\"logs\\" \[\n \\"\[2022 05 18t12 00 12 900z] created by usr 4fsacblknri74u8\\",\n \\"\[2022 05 18t12 00 14 184z] customer sms sent to +447763306128\\"\n ],\n \\"updatedat\\" \\"2022 05 18t12 00 14 184z\\",\n \\"createdat\\" \\"2022 05 18t12 00 12 901z\\",\n \\"clientaccesstoken\\" \\"c7e4a40c552e4cc6a9c872fc54198c91\\",\n \\"status\\" \\"created\\",\n \\"amount\\" 1259,\n \\"statusexplanation\\"\ null,\n \\"customeripaddress\\"\ null,\n \\"customeripinfo\\"\ null,\n \\"customerdeviceinfo\\"\ null,\n \\"customeremailaddress\\"\ null,\n \\"threedsecuretoken\\"\ null,\n \\"cardtoken\\"\ null,\n \\"cardtokentype\\"\ null,\n \\"transactiondetails\\"\ null,\n \\"saleid\\"\ null,\n \\"succeededat\\"\ null\n }\n]", "language" "200", "customlabel" "" } ], "selectedlanguageid" "asylc qu5nywnhky7xgc3" }, "examples" { "languages" \[ { "id" "tuo9i9tig9lvs8vigjezu", "code" "fetch(\\"https //api cabcard services/v1/intents\\", {\n \\"method\\" \\"get\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "javascript", "customlabel" "" } ], "selectedlanguageid" "tuo9i9tig9lvs8vigjezu" }, "description" "list all payment links, optionally filtering the list", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "tab" "examples", "url" "https //api cabcard services/v1/intents/\ id", "name" "update a payment link", "method" "patch", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id of the payment link to update" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "saleamount", "type" "integer", "description" "payment amount in currency minor units e g pence" }, { "kind" "optional", "name" "customername", "type" "string", "description" "customer name" }, { "kind" "optional", "name" "description", "type" "string", "description" "payment link description" }, { "kind" "optional", "name" "reference", "type" "string", "description" "payment link reference" }, { "kind" "optional", "name" "currency", "type" "string", "description" "payment currency in iso 4217 alpha 3 format currently only gbp is supported " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bveiww tojobhpjzyphsd", "code" "{\n \\"name\\" \\"cake's name\\",\n}", "language" "200", "customlabel" "" }, { "id" "u6qscnmf5wds8b6yi6uov", "code" "{\n \\"message\\" \\"payment intent not found\\"\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "u6qscnmf5wds8b6yi6uov" }, "examples" { "languages" \[ { "id" "18ni 0wg0 n8p9inlnrut", "code" "", "language" "none", "customlabel" "" } ], "selectedlanguageid" "18ni 0wg0 n8p9inlnrut" }, "description" "this operation can only be carried out while the payment link is in allowed statuses, usually the 'created'", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //api cabcard services/v1/intents/\ id/reset", "name" "reset a payment link", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "payment link id" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "lieqlhnjcrkybyunzcplb", "code" "", "language" "200", "customlabel" "" }, { "id" "gwcsg2rerhevbd6egnvo9", "code" "{\n \\"message\\" \\"payment intent not found\\"\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "lieqlhnjcrkybyunzcplb" }, "examples" { "languages" \[ { "id" "42hgiej1awodmej94qgxd", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/reset';\nlet options = {\n method 'put',\nheaders {\n accept 'application/json',\n }\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "curl", "customlabel" "" }, { "id" "wxha5pqkvdveeadtll7vx", "code" "fetch(\\"https //api cabcard services/v1/intents/\ id/reset\\", {\n \\"method\\" \\"put\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "nodejs", "customlabel" "" }, { "id" "uasmsyhhg6xekey9g kzn", "code" "import requests\n\nurl = \\"https //api cabcard services/v1/intents/\ id/reset\\"\nheaders = {\\"accept\\" \\"application/json\\"}\nresponse = requests request(\\"get\\", url, headers=headers)\nprint(response text)", "language" "javascript", "customlabel" "" }, { "id" "r8iv0euqay3cyciedemsn", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/reset';\nlet options = {method 'put', headers {accept 'application/json'}};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "python", "customlabel" "" }, { "id" "a7x0dhwb9d6t9qyyjnlso", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/reset';\nlet options = {method 'put', headers {accept 'application/json'}};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "42hgiej1awodmej94qgxd" }, "description" "sometimes, a customer may get stuck when attempting a payment, for example due to 3ds problems this function resets the authorization state of the payment link, allowing the customer to try agin ", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "tab" "examples", "url" "https //api cabcard services/v1/intents/\ id/cancellation", "name" "cancel a payment link", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "payment link id" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "lieqlhnjcrkybyunzcplb", "code" "", "language" "200", "customlabel" "" }, { "id" "gwcsg2rerhevbd6egnvo9", "code" "{\n \\"message\\" \\"payment intent not found\\"\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "gwcsg2rerhevbd6egnvo9" }, "examples" { "languages" \[ { "id" "mroyaomolxv2zeogwgbxi", "code" "curl request put\n url https //api cabcard services/v1/intents/\ id/cancellation\n header 'accept application/json'", "language" "curl", "customlabel" "" }, { "id" "3blnfmdy umkrwgwafem", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/cancellation';\nlet options = {\n method 'put',\nheaders {\n accept 'application/json',\n }\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "nodejs", "customlabel" "" }, { "id" "jn2qamxltly jedrxrvxd", "code" "fetch(\\"https //api cabcard services/v1/intents/\ id/cancellation\\", {\n \\"method\\" \\"put\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "javascript", "customlabel" "" }, { "id" "ku6dqcwsf0b4zlpri6hss", "code" "import requests\n\nurl = \\"https //api cabcard services/v1/intents/\ id/cancellation\\"\nheaders = {\\"accept\\" \\"application/json\\"}\nresponse = requests request(\\"get\\", url, headers=headers)\nprint(response text)", "language" "python", "customlabel" "" }, { "id" "jin7sdiifcrbu3jyu v0x", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/cancellation';\nlet options = {method 'put', headers {accept 'application/json'}};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "mroyaomolxv2zeogwgbxi" }, "description" "if you need to cancel a payment link (for example, if the price of a booking has changed and you wish to invalidate the payment request), use this operation the customer will not be able to carry out a payment this operation is only available if the payment link status is not final ", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "tab" "examples", "url" "https //api cabcard services/v1/intents/\ id", "name" "delete a payment link", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "payment link id" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "d8p dlezpr9bjktcqxeoh", "code" "", "language" "204", "customlabel" "" }, { "id" "gwcsg2rerhevbd6egnvo9", "code" "{\n \\"message\\" \\"payment intent not found\\"\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "gwcsg2rerhevbd6egnvo9" }, "examples" { "languages" \[ { "id" "mroyaomolxv2zeogwgbxi", "code" "curl request put\n url https //api cabcard services/v1/intents/\ id/cancellation\n header 'accept application/json'", "language" "curl", "customlabel" "" }, { "id" "3blnfmdy umkrwgwafem", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/cancellation';\nlet options = {\n method 'put',\nheaders {\n accept 'application/json',\n }\n};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "nodejs", "customlabel" "" }, { "id" "jn2qamxltly jedrxrvxd", "code" "fetch(\\"https //api cabcard services/v1/intents/\ id/cancellation\\", {\n \\"method\\" \\"put\\",\n \\"headers\\" {\n \\"accept\\" \\"application/json\\"\n }\n})\n then(response => {\n console log(response);\n})\n catch(err => {\n console error(err);\n});", "language" "javascript", "customlabel" "" }, { "id" "ku6dqcwsf0b4zlpri6hss", "code" "import requests\n\nurl = \\"https //api cabcard services/v1/intents/\ id/cancellation\\"\nheaders = {\\"accept\\" \\"application/json\\"}\nresponse = requests request(\\"get\\", url, headers=headers)\nprint(response text)", "language" "python", "customlabel" "" }, { "id" "jin7sdiifcrbu3jyu v0x", "code" "const fetch = require('node fetch');\n\nlet url = 'https //api cabcard services/v1/intents/\ id/cancellation';\nlet options = {method 'put', headers {accept 'application/json'}};\nfetch(url, options)\n then(res => res json())\n then(json => console log(json))\n catch(err => console error('error ' + err));", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "mroyaomolxv2zeogwgbxi" }, "description" "if you need to delete a previously cancelled payment link, use this operation this operation is only available if the payment link status is cancelled ", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } { "name" "capture payment link authorization", "method" "put", "url" "https //api cabcard services/v1/intents/\ id/authorization/capture", "description" "used for intents with manual capture mode", "tab" "examples", "examples" { "languages" \[ { "id" "xzvqkcf o1hp z2hjjk i", "language" "curl", "code" "curl location globoff request put 'https //api cabcard services/v1/intents/\ id/authorization/capture/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" }, { "id" "btjsblkwtfwuablbjqtc4", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //api cabcard services/v1/intents/\ id/authorization/capture/{id}',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "uiu eokebj4wdggoj9kbm", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api cabcard services/v1/intents/\ id/authorization/capture/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "x0a7f98tmh nqxdrzh yi", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api cabcard services/v1/intents/\ id/authorization/capture/{id}\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "57y2gblvys1mtixy1i2ox", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api cabcard services/v1/intents/\ id/authorization/capture/{id}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "uiu eokebj4wdggoj9kbm" }, "results" { "languages" \[ { "id" "niimbrxug9jpzcpzso1nr", "language" "200", "customlabel" "", "code" "" }, { "id" "jya3tsiismc6jtg9qcyoy", "language" "400", "code" "{\n \\"message\\" \\"requested capture amount exceeds authorized amount\\"\n}", "customlabel" "" }, { "id" "mnrpcqtoxd3ux5aezmylk", "language" "403", "code" "{\n \\"message\\" \\"not permitted to capture authorization for this payment intent\\"\n}", "customlabel" "" } ], "selectedlanguageid" "mnrpcqtoxd3ux5aezmylk" }, "request" { "pathparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "payment link id", "" "id" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "amount", "kind" "optional", "type" "integer", "description" "amount to capture must be equal to or below the authorized amount", "" "amount to capture must be equal to or below the authorized amount" } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "hastryitout" false }