Get the consent resource

{ "name" "/consent/{id}", "method" "get", "url" "https //api sandbox klavi ai/payment/customer/v1/automatic/consents/{id}", "description" "get the consent resource", "tab" "examples", "examples" { "languages" \[ { "id" "orrtudrwttql v7rao5oi", "language" "curl", "code" "curl location globoff 'https //api sandbox klavi ai/payment/customer/v1/automatic/consents/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" }, { "id" "km2xifbxkojcwdwtxsmk7", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api sandbox klavi ai/payment/customer/v1/automatic/consents/{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" "afntcmph9jzea2wmupqeb", "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/customer/v1/automatic/consents/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "5htzuurmjge6x1fgd6lou", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api sandbox klavi ai/payment/customer/v1/automatic/consents/{id}\\"\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" "oah2ly5uxkfxef7ppacq7", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api sandbox klavi ai/payment/customer/v1/automatic/consents/{id}\\")\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" "orrtudrwttql v7rao5oi" }, "results" { "languages" \[ { "id" "3g6wrksrglqr0c cysqo0", "language" "200", "code" "{\n \\"id\\" \\"fcb72e3a b346 4f71 b044 971dc23232c9\\", \n \\"appid\\" \\"0b59d801 08e0 4e84 9ecd 569f34e32279\\", \n \\"clientrequestid\\" \\"fcb72e3a b346 4f71 b044 dsndsnmnkdsmk\\", \n \\"institutionid\\" \\"c8f0bf49 4744 4933 8960 7add6e590841\\", \n \\"customer\\" \n {\n \\"identifiertype\\" \\"cpf\\", \n \\"identifier\\" \\"76109277673\\", \n \\"name\\" \\"joão silva\\", \n \\"phone\\" \\"12345\\",\n \\"email\\" \\"123\@123 com\\" \n },\n \\"loggedusercpf\\" \\"76109277673\\", \n \\"redirecturl\\" \\"//close\\", \n \\"additionalinformation\\" \\"any description\\",\n \\"debtoraccount\\" \n {\n \\"ispb\\" \\"00000000\\", \n \\"issuer\\" \\"0001\\", \n \\"number\\" \\"324223\\", \n \\"accounttype\\" \\"cacc\\" \n }, \n \\"creditoraccount\\" \n {\n \\"ispb\\" \\"00000000\\", \n \\"issuer\\" \\"0001\\", \n \\"number\\" \\"324223\\", \n \\"accounttype\\" \\"cacc\\", \n \\"holder\\" \n {\n \\"identifier\\" \\"76109277673\\", \n \\"name\\" \\"john doe\\", \n \\"identifiertype\\" \\"cpf\\" \n } \n }, \n \\"paymentmethod\\" \\"automatic pix\\", \n \\"paymentmethodconfig\\" {\n \\"contractid\\" \\"premiumplan123456\\", \n \\"fixedamount\\" \\"10000 05\\", \n \\"minimumvariableamount\\" \\"100 01\\", \n \\"maximumvariableamount\\" \\"100 01\\", \n \\"currency\\" \\"brl\\", \n \\"interval\\" \\"monthly\\", \n \\"referencestartdate\\" \\"2025 06 01\\",\n \\"contractdebtor\\" {\n \\"identifiertype\\" \\"cpf\\", \n \\"identifier\\" \\"76109277673\\", \n \\"name\\" \\"joão da silva\\" \n },\n \\"isretryaccepted\\" true, \n \\"useoverdraftlimit\\" true, \n \\"firstpayment\\" {\n \\"id\\" \\"fcb72e3a b346 4f71 b044 dsndsnmnkdsmk\\", \n \\"clientrequestid\\" \\"fcb72e3a b346 4f71 b044 dsndsnmnkdsmk\\", \n \\"remittanceinformation\\" \\"description\\", \n \\"date\\" \\"2025 05 15\\", \n \\"amount\\" \\"3000 02\\", \n \\"currency\\" \\"brl\\" \n } \n },\n \\"externalinfo\\" \n {\n \\"key\\" \\"value\\"\n }, \n \\"expirationdatetime\\" \\"2023 01 23t23 59 59\\", \n \\"status\\" \\"canceled\\", \n \\"statusreason\\" {\n \\"code\\" \\"nao informado\\", \n \\"message\\" \\"erro não informado na iniciadora ou detentora de conta \\" \n }, \n \\"createat\\" \\"2023 01 23t14 17 06 45z\\", \n \\"statusupdateat\\" \\"2023 01 23t14 17 06 45z\\"\n}", "customlabel" "" } ], "selectedlanguageid" "3g6wrksrglqr0c cysqo0" }, "request" { "pathparameters" \[ { "name" "id", "kind" "required", "type" "string", "description" "pattern ^urn \[a za z0 9]\[a za z0 9\\\\ ]{0,31} \[a za z0 9()+,\\\\ =@;$ ! '%\\\\/?#]+$\nmaxlength 256\nconsent id", "" "pattern ^urn \[a za z0 9]\[a za z0 9\\\\ ]{0,31} \[a za z0 9()+,\\\\ =@;$ ! '%\\\\/?#]+$\nmaxlength 256\nconsent id" } ], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "jwt bearer token", "" "jwt bearer token" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "hastryitout" false, "response" \[ { "name" "id", "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" "appid", "kind" "optional", "type" "string", "description" "app id for partner", "children" \[] }, { "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", "children" \[] }, { "name" "institutionid", "kind" "optional", "type" "string", "description" "id from the bank chosen by the user", "children" \[] }, { "name" "customer", "kind" "optional", "type" "object", "description" "user (natural person) who is logged in to the payment initiator institution", "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" "loggedusercpf", "kind" "optional", "type" "string", "description" "user (natural person) who is logged in to the payment initiator institution \nrequired if customer identifiertype = cnpj", "children" \[] }, { "name" "redirecturl", "kind" "optional", "type" "string", "description" "return rediect url after user checkout in klavi env", "children" \[] }, { "name" "additionalinformation", "kind" "optional", "type" "string", "description" "must be filled in whenever the paying user enters some additional information in the consent\nexample minha recorrência\npattern \[\\\w\\\w\\\s] \nmaxlength 140", "children" \[] }, { "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" "object containing the data of the recipient (creditor)", "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" "name", "kind" "optional", "type" "string", "description" "username" }, { "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" "paymentmethod", "kind" "optional", "type" "string", "description" "field intended for the configuration of the different recurring payment products ", "children" \[] }, { "name" "paymentmethodconfig", "kind" "optional", "type" "object", "description" "field intended for the configuration of the different recurring payment products ", "children" \[ { "name" "contractid", "kind" "optional", "type" "string", "description" "pattern ^\[a za z0 9]{1,35}$\nminlength 1\nmaxlength 35\nexample xe00038166201907261559y6j6\ntransaction contract identifier" }, { "name" "fixedamount", "kind" "optional", "type" "number", "description" "pattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nminlength 4\nmaxlength 19\nexample 100000 12\nfixed charge amount, if filled in, represents a consent for payments of fixed amounts, or not subject to change during the validity of the consent " }, { "name" "minimumvariableamount", "kind" "optional", "type" "number", "description" "pattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nminlength 4\nmaxlength 19\nexample 1000000 12\nvalue defined by the receiving user if the paying user assigns a maximum amount for payments of that authorization (field “maximumvariableamount”), it cannot be lower than the floor set by the receiving user " }, { "name" "maximumvariableamount", "kind" "optional", "type" "number", "description" "pattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nminlength 4\nmaxlength 19\nexample 1000000 12\nmaximum allowed value per charge, if filled in, represents consent to payments of variable amounts " }, { "name" "currency", "kind" "optional", "type" "string", "description" "maxlength 3\npattern ^(\[a z]{3})$\nexample brl" }, { "name" "interval", "kind" "optional", "type" "string", "description" "example monthly\nenum \[ weekly,monthly,yearly,semiannual,quarterly ]\ndefines the allowed periodicity for transaction execution" }, { "name" "referencestartdate", "kind" "optional", "type" "string", "description" "pattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])$\nexample 2023 05 21\nrepresents the expected date for the start of the collection cycle for payments associated with recurrence it is a string with date according to rfc 3339 specification, following brasília time (utc 3) the initial bulk payment, declared in the firstpayment object of the consent, is not subject to this date " }, { "name" "contractdebtor", "kind" "optional", "type" "object", "description" "information about the customer who owes the contract ", "children" \[ { "name" "identifiertype", "kind" "optional", "type" "string", "description" "enum \[ cpf, cnpj ]\ntype of the user identification document cnpj or cpf" }, { "name" "identifier", "kind" "optional", "type" "string", "description" "maxlength 14\nexample 11111111111111\npattern ^(\[0 9]{11})$|^(\[0 9a z]{12}\[0 9]{2})$\nthe number of the user identification document" }, { "name" "name", "kind" "optional", "type" "string", "description" "pattern ^(\[a za zà öø öø ÿ, @ & + <>()!?/\\\\\\\\$%\\\d' ]+)$\nmaxlength 120\nexample policarpo quaresma" } ] }, { "name" "isretryaccepted", "kind" "optional", "type" "boolean", "description" "example false\nindicates whether the receiving customer is allowed to make payment attempts (extradition), according to the rules set out in the pix arrangement " }, { "name" "useoverdraftlimit", "kind" "optional", "type" "boolean", "description" "default true\nexample true\nindicates whether the paying user has authorized the use of pre approved limit (special check) in his account for making payments, if the customer owns the product " }, { "name" "firstpayment", "kind" "optional", "type" "object", "description" "definitions for the first payment it is considered as the payment of membership to the service by the paying user ", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "payment id" }, { "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" "remittanceinformation", "kind" "optional", "type" "string", "description" "maxlength 140\npattern \[\\\w\\\w\\\s] \nexample pagamento da nota rsto035 002\nit must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient " }, { "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\ndefines the target date for payment settlement the brasília time zone should be used to create and streamline the data in this field " }, { "name" "amount", "kind" "optional", "type" "string", "description" "minlength 4\nmaxlength 19\npattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nexample 100000 12\nthe transaction 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" "externalinfo", "kind" "optional", "type" "object", "description" "metadata, user customizable", "children" \[ { "name" "key", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "expirationdatetime", "kind" "optional", "type" "string", "description" "the date and time when the consent shall cease to be valid a string with date and time as specified in rfc 3339, always using the utc time format \nexample 2021 05 21t08 30 00z\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$\nmaxlength 20", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "example consent awaiting authorization\ncurrent status of recurring consent according to the state machine\nenum \n \[ started,expired,consent awaiting authorization, consent authorized, consent rejected, consent partially accepted, consent revoked, consent period expired, canceled, error ]", "children" \[] }, { "name" "statusreason", "kind" "optional", "type" "object", "description" "status reson 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" "example 2021 05 21t08 30 00z\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$\nmaxlength 20\ncreate time", "children" \[] }, { "name" "statusupdateat", "kind" "optional", "type" "string", "description" "example 2021 05 21t08 30 00z\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$\nmaxlength 20\nstatus update time", "children" \[] } ] }