Get a payment initiation order

{ "name" "orders", "method" "get", "url" "https //api sandbox klavi ai/payment/management/v1/merchants/{appid}/orders/{id}", "description" "get a payment initiation order", "tab" "examples", "examples" { "languages" \[ { "id" "ffhhcb0fkwtnkmbbixgh3", "language" "curl", "code" "curl location globoff 'https //api sandbox klavi ai/payment/management/v1/merchants/{appid}/orders/{id}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" }, { "id" "5aun4ljgurvpiu4mcxwnb", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api sandbox klavi ai/payment/management/v1/merchants/{appid}/orders/{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" "zhhwfy rs4mxfisydeug4", "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/{appid}/orders/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "fgmje5bmx i3ak2gr9arc", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api sandbox klavi ai/payment/management/v1/merchants/{appid}/orders/{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" "ds vp1tvdeybej v3v4wu", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api sandbox klavi ai/payment/management/v1/merchants/{appid}/orders/{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" "ffhhcb0fkwtnkmbbixgh3" }, "results" { "languages" \[ { "id" "ovpio0txzmbo 0y0lzbc0", "language" "200", "code" "{\n \\"id\\" \\"fcb72e3a b346 4f71 b044 971dc23232c9\\", // required\n \\"appid\\" \\"0b59d801 08e0 4e84 9ecd 569f34e32279\\", // required\n \\"clientrequestid\\" \\"fcb72e3a b346 4f71 b044 dsndsnmnkdsmk\\", // required\n \\"institutionid\\" \\"c8f0bf49 4744 4933 8960 7add6e590841\\", // required\n \\"customer\\" {\n \\"identifiertype\\" \\"cpf\\", // required, cpf | cnpj\n \\"identifier\\" \\"76109277673\\", // required\n \\"name\\" \\"joão silva\\", // optional\n \\"phone\\" \\"12345\\", // optional\n \\"email\\" \\"123\@123 com\\" // optional\n }, // required\n \\"date\\" \\"2023 01 23\\", // required, utc 3\n \\"consentid\\" \\"yyt72e3a b846 i771 b044 971dc232ujd8\\", // required\n \\"endtoendid\\" \\"e9040088820210128000800123873170\\", // required after the status consent authorized\n \\"transactionidentification\\" \\"cxf0bf49 4744 4933 8960 7add6e5908cc\\", // optional\n \\"loggedusercpf\\" \\"76109277673\\", // required if customer identifiertype = cnpj\n \\"ibgetowncode\\" \\"5300108\\", // optional\n \\"proxy\\" \\"xxxxx\\", // required if method = pix dict\n \\"qrcode\\" \\"xxxxx\\", // required if method = pix qrcode\n \\"inittype\\" \\"pix inic\\", // required\n \\"amount\\" \\"1333 04\\", // required\n \\"currency\\" \\"brl\\", // required\n \\"remittanceinformation\\" \\"any description\\", // optinal, payment description\n \\"debtoraccount\\" {\n \\"ispb\\" \\"00000000\\", // required, ispb (brazilian payment system identifier) of the spi (instant payment system)\n \\"issuer\\" \\"0001\\", // optional, code of the issuing agency of the account without digit \n \\"number\\" \\"324223\\", // required, account number\n \\"accounttype\\" \\"cacc\\" // required, cacc(current account)|svgs(savings account)|tran(transactingaccount)\n }, // optinal, payer's account\n \\"creditoraccount\\" {\n \\"ispb\\" \\"00000000\\", // required\n \\"issuer\\" \\"0001\\", // optional\n \\"number\\" \\"324223\\", // required\n \\"accounttype\\" \\"cacc\\", // required\n \\"holder\\" {\n \\"identifier\\" \\"76109277673\\", // required\n \\"name\\" \\"john doe\\", // required\n \\"identifiertype\\" \\"cpf\\" // required\n } // required\n }, // required if mthod = pix manu\n \\"externalinfo\\" {\n \\"key\\" \\"value\\"\n }, // optional\n \\"cancellation\\" {\n \\"cancelledfrom\\" \\"merchant\\", // required, the cancellation source, merchant|initiator|institution\n \\"cancelledat\\" \\"2021 05 21t08 30 00z\\", // required\n \\"cancelledby\\" {\n \\"identifier\\" \\"76109277673\\", // required\n \\"identifiertype\\" \\"cpf\\" // required\n } // required\n }, // required if the status is canceled\n \\"status\\" \\"canceled\\", // required\n \\"statusreason\\" {\n \\"code\\" \\"nao informado\\", // required\n \\"message\\" \\"erro não informado na iniciadora ou detentora de conta \\" // required\n }, // optional\n \\"createat\\" \\"2023 01 23t14 17 06 45z\\", // required\n \\"statusupdateat\\" \\"2023 01 23t14 17 06 45z\\", // required\n \\"paymentmethod\\" \\"automatic pix\\",\n \\"paymentmethodconfig\\" {\n \\"firstpayment\\" false,\n \\"originalpaymentid\\" \\"fcb72e3a b346 4f71 b044 971dc23231b1\\",\n \n },\n \\"authorisationflow\\" \\"jsr flow\\",\n \\"retries\\" \[\n {\n \\"id\\" \\"36970380 8f6a 4303 b2a8 dbd0ef532664\\",\n \\"appid\\" \\"ax2regress\\",\n \\"clientrequestid\\" \\"retry1\\",\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\\" \\"e4445979920250908132400000000000\\",\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 07t21 25 00z\\",\n \\"statusupdateat\\" \\"2025 09 07t21 25 10z\\",\n \\"firstpayment\\" false,\n \\"originalpaymentid\\" \\"6aef77ea f4e1 44c2 92af f5cda0413154\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "ovpio0txzmbo 0y0lzbc0" }, "request" { "pathparameters" \[ { "name" "appid", "kind" "required", "type" "string", "description" "app id", "" "app id" }, { "name" "id", "kind" "required", "type" "string", "description" "payment initiation id, it will be returned when post /orders is called", "" "payment initiation id, it will be returned when post /orders is called" } ], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer access token, it returned by the /auth\n", "" "bearer access token, it returned by the /auth\n" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "id of the payment order" }, { "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" "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", "children" \[] }, { "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", "children" \[] }, { "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)", "children" \[] }, { "name" "transactionidentification", "kind" "optional", "type" "string", "description" "pattern ^\[a za z0 9]{1,35}$\nmaxlength 35\nexample e00038166201907261559y6j6\nthis is a transaction identifier that must be transmitted intact by the payer’s psp when generating the payment order this information will allow the recipient to identify and correlate the transfer, when received, with the presentation of the instructions to the payer the characters allowed in the pix context for the txid field (emv 62 05) are low case letters, from 'a' to 'z' upper case letters, from 'a' to 'z' decimal digits, from '0' to '9' ", "children" \[] }, { "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" "ibgetowncode", "kind" "optional", "type" "string", "description" "minlength 7\nmaxlength 7\npattern ^\\\d{7}$\nexample 5300108\nthe ibgetowncode field in the pix array has the same behavior as the codmun field described in item 1 6 6 of the pix manual if the municipality information is not sent, the recipient's psp will assume that there are no state and municipal holidays in the period in question;", "children" \[] }, { "name" "proxy", "kind" "optional", "type" "string", "description" "pattern \[\\\w\\\w\\\s] \nexample 11221131242\nif inittype = pix dict or pix inic\nkey registered in the dict belonging to the recipient the types of keys can be phone, e mail, cpf/cnpj or random key in the case of mobile phone should be reported in the e 1641 standard email must have the format xxxxxxxx\@xxxxxxx xxx ( xx) and maximum 77 characters in the case of cpf, it should be indicated with 11 numbers, without dots or dashes in the case of cnpj, it must be reported with 14 numbers, without dots or dashes in the case of a random key, the uuid generated by dict must be reported, as specified in rfc4122 ", "children" \[] }, { "name" "qrcode", "kind" "optional", "type" "string", "description" "if inittype = pix qrcode", "children" \[] }, { "name" "inittype", "kind" "optional", "type" "string", "description" "example pix inic\nenum \[ pix inic, pix manu,pix dict，pix qrcode ]", "children" \[] }, { "name" "amount", "kind" "optional", "type" "string", "description" "minlength 4\nmaxlength 19\npattern ^((\\\d{1,16}\\\\ \\\d{2}))$\nexample 100000 12\ntransaction value with 2 decimal places", "children" \[] }, { "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", "children" \[] }, { "name" "remittanceinformation", "kind" "optional", "type" "string", "description" "maxlength 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 ", "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" "externalinfo", "kind" "optional", "type" "object", "description" "metadata, user customizable", "children" \[ { "name" "key", "kind" "optional", "type" "string", "description" "" } ] }, { "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" "example payment pending\nenum \n\[payment pending,payment ready for settlement,payment scheduled,payment settlement processing, payment completed,payment rejected]", "children" \[] }, { "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", "children" \[] }, { "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", "children" \[] }, { "name" "paymentmethod", "kind" "optional", "type" "string", "description" "instant pix or automatic pix", "children" \[] }, { "name" "paymentmethodconfig", "kind" "optional", "type" "object", "description" "field intended for the configuration of the different recurring payment products ", "children" \[ { "name" "firstpayment", "kind" "optional", "type" "string", "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" "authorisationflow", "kind" "optional", "type" "string", "description" "enum \[hybrid flow,jsr flow]" }, { "name" "paymentreference", "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" "retries", "kind" "optional", "type" "object", "description" "retries object", "children" \[ { "name" "id", "kind" "optional", "type" "string", "description" "retries id" }, { "name" "appid", "kind" "optional", "type" "string", "description" "applications id created by merchants\nminlength 1\nmaxlength 100\npattern ^\[a za z0 9]\[a za z0 9\\\\ ]{0,99}$\nexample txprmu9uqtromwhzv2xsu1fuazjsmdl" }, { "name" "clientrequestid", "kind" "optional", "type" "string", "description" "merchant's internal orderid only can be used for once " }, { "name" "institutionid", "kind" "optional", "type" "string", "description" "id from the bank chosen by the user" }, { "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" }, { "name" "identifier", "kind" "optional", "type" "string", "description" "identifier" }, { "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" "payment initiation date, the date here must be utc 3\nmaxlength 10\npattern ^(\\\d{4}) (1\[0 2]|0?\[1 9]) (3\[01]|\[12]\[0 9]|0?\[1 9])$\nexample 2021 01 01" }, { "name" "consentid", "kind" "optional", "type" "string", "description" "unique identifier of the consent created for the initiation of the requested payment\nmaxlength 256\npattern ^urn \[a za z0 9]\[a za z0 9\\\\ ]{0,31} \[a za z0 9()+,\\\\ =@;$ ! '%\\\\/?#]+$\nexample urn\ bancoex\ c1dd33123" }, { "name" "endtoendid", "kind" "optional", "type" "string", "description" "it is a unique identifier, generated in the initiating payment institution and received in the account holding institution, permeating the entire payment journey pix \nminlength 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 e9040088820210128000800123873170" }, { "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" "required if mthod = pix manu", "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" "required if inittype is pix manu", "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, merchant customizable" }, { "name" "cancellation", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "cancelledfrom", "kind" "optional", "type" "string", "description" "" }, { "name" "cancelledat", "kind" "optional", "type" "string", "description" "canceled date" }, { "name" "cancelledby", "kind" "optional", "type" "object", "description" "", "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" "status" }, { "name" "statusreason", "kind" "optional", "type" "object", "description" "status update reason", "children" \[ { "name" "code", "kind" "optional", "type" "string", "description" "code" }, { "name" "message", "kind" "optional", "type" "string", "description" "message" } ] }, { "name" "createat", "kind" "optional", "type" "string", "description" "create time utc time format\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" "status update time utc time format\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" } ] } ] }