Get all orders from an consent

{ "name" "get all orders from an consent", "method" "get", "url" "https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders", "description" "returns the paged list of the orders created through the given automatic pix consent", "tab" "examples", "examples" { "languages" \[ { "id" "asea13tnudcnkw0ukgxuh", "language" "curl", "code" "curl location globoff 'https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" }, { "id" "qvl69tdh0 bwuxc f8kui", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders',\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" "ms6ofgcodcgs3kluzwgoc", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "ih0dyunipcwwsmq2vwbwh", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders\\"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "39kexmbhvvpoc3aa17xxf", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api sandbox klavi ai/payment/management/v1/merchants/automatic/{appid}/consents/{consentid}/orders\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "asea13tnudcnkw0ukgxuh" }, "results" { "languages" \[ { "id" "rd19o3figr2rimmu85ykm", "language" "200", "code" "{\n \\"data\\" \[\n {\n \\"id\\" \\"bd4de72f 550b 421b ba5c 28190e754d58\\",\n \\"appid\\" \\"ax2regress\\",\n \\"clientrequestid\\" \\"retry15\\",\n \\"institutionid\\" \\"c8f0bf49 4744 4933 8960 7add6e590841\\",\n \\"customer\\" {\n \\"identifiertype\\" \\"cpf\\",\n \\"identifier\\" \\" 092 776 \\",\n \\"name\\" \\"kbms 10086\\",\n \\"phone\\" \\"12 00\\",\n \\"email\\" \\"q @klavi ai\\"\n },\n \\"date\\" \\"2025 09 08\\",\n \\"consentid\\" \\"17d9d5be 073f 4706 86d4 8fdd36b90aed\\",\n \\"endtoendid\\" \\"e4445979920250908132600000000005\\",\n \\"ibgetowncode\\" \\"\\",\n \\"amount\\" \\"90 1200\\",\n \\"currency\\" \\"brl\\",\n \\"remittanceinformation\\" \\"batata\\",\n \\"debtoraccount\\" {\n \\"ispb\\" \\"\\",\n \\"issuer\\" \\"\\",\n \\"number\\" \\"\\",\n \\"accounttype\\" \\"\\"\n },\n \\"creditoraccount\\" {\n \\"ispb\\" \\"00000000\\",\n \\"issuer\\" \\" \\",\n \\"number\\" \\" \\",\n \\"accounttype\\" \\"cacc\\",\n \\"holder\\" {\n \\"identifier\\" \\" 708/0001 \\",\n \\"identifiertype\\" \\"cnpj\\",\n \\"name\\" \\"john doe\\"\n }\n },\n \\"externalinfo\\" {\n \\"batata\\" \\"batata\\"\n },\n \\"cancellation\\" {\n \\"cancelledfrom\\" \\"\\",\n \\"cancelledat\\" \\"\\",\n \\"cancelledby\\" {\n \\"identifier\\" \\"\\",\n \\"identifiertype\\" \\"\\"\n }\n },\n \\"status\\" \\"payment rejected\\",\n \\"statusreason\\" {\n \\"code\\" \\"unknown\\",\n \\"message\\" \\"unknown server error\\"\n },\n \\"createat\\" \\"2025 09 07t22 26 14z\\",\n \\"statusupdateat\\" \\"2025 09 07t22 26 48z\\",\n \\"firstpayment\\" false,\n \\"originalpaymentid\\" \\"6aef77ea f4e1 44c2 92af f5cda0413154\\",\n \\"paymentreference\\" \\"03 09 2025/p1m\\"\n }\n ],\n \\"paging\\" {\n \\"nextcursor\\" \\"xx3tsz4uq9c70kuy63wutkl8jjdy mpgs6e4dgr6pq3exhxgaltdvprdqpb7hlnvcemtez3cta3td ncikhtxw\\",\n \\"prevcursor\\" \\"\\",\n \\"hasnext\\" true,\n \\"hasprev\\" false\n }\n}", "customlabel" "" } ], "selectedlanguageid" "rd19o3figr2rimmu85ykm" }, "request" { "pathparameters" \[ { "name" "appid", "kind" "required", "type" "string", "description" "id of application for partner", "" "required" }, { "name" "consentid", "kind" "required", "type" "string", "description" "id of consent", "" "id of consent" } ], "queryparameters" \[ { "name" "startdate", "kind" "optional", "type" "string", "description" "start date\nfor example 2025 06 01", "" "start date\nfor example 2025 06 01" }, { "name" "enddate", "kind" "optional", "type" "string", "description" "end date\nfor example 2025 06 01", "" "end date\nfor example 2025 06 01" }, { "name" "pagesize", "kind" "optional", "type" "string", "description" "page size(default 20, max 200)", "" "page size(default 20, max 200)" }, { "name" "cursor", "kind" "optional", "type" "string", "description" "page cursor", "" "page cursor" } ], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer access token, it returned by the /auth", "" "bearer access token, it returned by the /auth" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "hastryitout" false, "response" \[ { "name" "data", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "" }, { "name" "appid", "kind" "optional", "type" "string", "description" "app id for partner" }, { "name" "clientrequestid", "kind" "optional", "type" "string", "description" "your internal orderid only can be used for once \nyou can use it to associate a payment and you can use uuid generation algorithm to generate it" }, { "name" "institutionid", "kind" "optional", "type" "string", "description" "id from the bank chosen by the user" }, { "name" "customer", "kind" "optional", "type" "object", "description" "id from the bank chosen by the user", "children" \[ { "name" "identifiertype", "kind" "optional", "type" "string", "description" "type of the user identification document cnpj or cpf\nif value is cpf \nmaxlength 3\nexample cpf\npattern ^\[a z]{3}$\n\nif value is cnpj\nmaxlength 4\nexample cnpj\npattern ^\[a z]{4}$" }, { "name" "identifier", "kind" "optional", "type" "string", "description" "the number of the user identification document\nif identifiertype value is cpf \nmaxlength 11\nexample 11111111111\npattern ^\\\d{11}$\n\nif identifiertype value is cnpj \nmaxlength 14\nexample 11111111111111\npattern ^\\\d{14}$" }, { "name" "name", "kind" "optional", "type" "string", "description" "username" }, { "name" "phone", "kind" "optional", "type" "string", "description" "user's phone number" }, { "name" "email", "kind" "optional", "type" "string", "description" "user's email" } ] }, { "name" "date", "kind" "optional", "type" "string", "description" "maxlength 10\npattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])$\nexample 2021 01 01\ndate of payment creation" }, { "name" "consentid", "kind" "optional", "type" "string", "description" "pattern ^urn \[a za z0 9]\[a za z0 9\\\\ ]{0,31} \[a za z0 9()+,\\\\ =@;$ ! '%\\\\/?#]+$\nmaxlength 256\nconsent id" }, { "name" "endtoendid", "kind" "optional", "type" "string", "description" "minlength 32\nmaxlength 32\npattern ^(\[e])(\[0 9]{8})(\[0 9]{4})(0\[1 9]|1\[0 2])(0\[1 9]|\[1 2]\[0 9]|3\[0 1])(2\[0 3]|\[01]\[0 9])(\[0 5]\[0 9])(\[a za z0 9]{11})$\nexample e9040088820241225150000123873170\nit should be filled in the default format exxxxxxxxyyyymmddhhmmkkkkkkkkk (32 characters; \\"case sensitive\\", i e , case sensitive)" }, { "name" "ibgetowncode", "kind" "optional", "type" "string", "description" "ibge town code\nminlength 7\nmaxlength 7\npattern ^\\\d{7}$\nexample 5300108" }, { "name" "amount", "kind" "optional", "type" "string", "description" "amount that will be paid by the user\nminlength 4\nmaxlength 19\npattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nexample 100000 12\n\[restriction] the value with 2 decimal places " }, { "name" "currency", "kind" "optional", "type" "string", "description" "maxlength 3\npattern ^(\[a z]{3})$\nexample brl\nnational currency code according to iso 4217, i e , 'brl' all reported monetary values are represented with the current currency of brazil " }, { "name" "remittanceinformation", "kind" "optional", "type" "string", "description" "payment description\nmaxlength 140\npattern \[\\\w\\\w\\\s] \nexample pagamento da nota xpto035 002 \nit must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient " }, { "name" "debtoraccount", "kind" "optional", "type" "object", "description" "payer's origin account information", "children" \[ { "name" "ispb", "kind" "optional", "type" "string", "description" "minlength 8\nmaxlength 8\npattern ^\[0 9]{8}$\nexample 12345678\nit must be filled in with the ispb (brazilian payment system identifier) of the spi participant (instant payment system) with numbers only " }, { "name" "issuer", "kind" "optional", "type" "string", "description" "minlength 1\nmaxlength 4\npattern ^\[0 9]{1,4}$\nexample 1774\ncode of the agency issuing the account without digit \n \[restriction] mandatory for the following account types cacc (conta deposito a vista) and svgs (conta poupanca) " }, { "name" "number", "kind" "optional", "type" "string", "description" "minlength 1\nmaxlength 20\npattern ^\[0 9]{1,20}$\nexample 1234567890\nit must be filled in with the paying user's transactional account number, with verification digit (if any),\nif there is an alphanumeric value, it should be converted to 0 " }, { "name" "accounttype", "kind" "optional", "type" "string", "description" "types of accounts used for payment \nexample cacc\nenum \[ cacc, svgs, tran]\n cacc current current account\n svgs savings saving account\n tran transactingaccount prepaid payment account" } ] }, { "name" "creditoraccount", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "ispb", "kind" "optional", "type" "string", "description" "minlength 8\nmaxlength 8\npattern ^\[0 9]{8}$\nexample 12345678\nit must be filled in with the ispb (brazilian payment system identifier) of the spi participant (instant payment system) with numbers only " }, { "name" "issuer", "kind" "optional", "type" "string", "description" "minlength 1\nmaxlength 4\npattern ^\[0 9]{1,4}$\nexample 1774\ncode of the agency issuing the account without digit \n \[restriction] mandatory for the following account types cacc (conta deposito a vista) and svgs (conta poupanca) " }, { "name" "number", "kind" "optional", "type" "string", "description" "minlength 1\nmaxlength 20\npattern ^\[0 9]{1,20}$\nexample 1234567890\nit must be filled in with the paying user's transactional account number, with verification digit (if any),\nif there is an alphanumeric value, it should be converted to 0 " }, { "name" "accounttype", "kind" "optional", "type" "string", "description" "types of accounts used for payment \nexample cacc\nenum \[ cacc, svgs, tran]\n cacc current current account\n svgs savings saving account\n tran transactingaccount prepaid payment account" }, { "name" "holder", "kind" "optional", "type" "object", "description" "holder object", "children" \[ { "name" "identifier", "kind" "optional", "type" "string", "description" "the number of the user identification document\nif identifiertype value is cpf \nmaxlength 11\nexample 11111111111\npattern ^\\\d{11}$\n\nif identifiertype value is cnpj \nmaxlength 14\nexample 11111111111111\npattern ^\\\d{14}$" }, { "name" "identifiertype", "kind" "optional", "type" "string", "description" "type of the user identification document cnpj or cpf\nif value is cpf \nmaxlength 3\nexample cpf\npattern ^\[a z]{3}$\n\nif value is cnpj\nmaxlength 4\nexample cnpj\npattern ^\[a z]{4}$" }, { "name" "name", "kind" "optional", "type" "string", "description" "username" } ] } ] }, { "name" "externalinfo", "kind" "optional", "type" "object", "description" "metadata, user customizable" }, { "name" "cancellation", "kind" "optional", "type" "object", "description" "object containing the data relating to the paying user who requested the cancellation, the channel used by him and the reason ", "children" \[ { "name" "cancelledfrom", "kind" "optional", "type" "string", "description" "example initiator\nenum \n \[ initiator, holder ]" }, { "name" "cancelledat", "kind" "optional", "type" "string", "description" "maxlength 20\npattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])t(? \[01]\\\d|2\[0123]) (? \[012345]\\\d) (? \[012345]\\\d)z$\nexample 2021 05 21t08 30 00z" }, { "name" "cancelledby", "kind" "optional", "type" "object", "description" "cancel object", "children" \[ { "name" "identifier", "kind" "optional", "type" "string", "description" "the number of the user identification document\nif identifiertype value is cpf \nmaxlength 11\nexample 11111111111\npattern ^\\\d{11}$\n\nif identifiertype value is cnpj \nmaxlength 14\nexample 11111111111111\npattern ^\\\d{14}$" }, { "name" "identifiertype", "kind" "optional", "type" "string", "description" "type of the user identification document cnpj or cpf\nif value is cpf \nmaxlength 3\nexample cpf\npattern ^\[a z]{3}$\n\nif value is cnpj\nmaxlength 4\nexample cnpj\npattern ^\[a z]{4}$" } ] } ] }, { "name" "status", "kind" "optional", "type" "string", "description" "consent status" }, { "name" "statusreason", "kind" "optional", "type" "object", "description" "status reason object", "children" \[ { "name" "code", "kind" "optional", "type" "string", "description" "example consent awaiting authorization\nenum \n\[not informed,infrastructure failure,authorization expired time, user rejected, origin destination accounts equal, account does not allow payment, divergent authentication, not informed, revoked user, revoked merchant ]" }, { "name" "message", "kind" "optional", "type" "string", "description" "pattern \[wws] \nlength 2048\nexample user refused consent\nstatus message" } ] }, { "name" "createat", "kind" "optional", "type" "string", "description" "maxlength 20\npattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])t(? \[01]\\\d|2\[0123]) (? \[012345]\\\d) (? \[012345]\\\d)z$\nexample 2020 07 21t08 30 00z" }, { "name" "statusupdateat", "kind" "optional", "type" "string", "description" "maxlength 20\npattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])t(? \[01]\\\d|2\[0123]) (? \[012345]\\\d) (? \[012345]\\\d)z$\nexample 2020 07 21t08 30 00z" }, { "name" "firstpayment", "kind" "optional", "type" "boolean", "description" "is it a first payment" }, { "name" "originalpaymentid", "kind" "optional", "type" "string", "description" "minlength 1\nmaxlength 100\npattern ^\[a za z0 9]\[a za z0 9\\\\ ]{0,99}$\nexample txprmu9uqtromwhzv2xsu1fuazjsmdl" }, { "name" "paymentreference", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "paging", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "nextcursor", "kind" "optional", "type" "string", "description" "" }, { "name" "prevcursor", "kind" "optional", "type" "string", "description" "" }, { "name" "hasnext", "kind" "optional", "type" "string", "description" "" }, { "name" "hasprev", "kind" "optional", "type" "string", "description" "" } ] } ] }