Get a payment initiation

name payments method get url https api sandbox klavi ai payment customer v1 instant payments id description get a payment initiation inform tab examples examples languages id rdvu8l8ov99numizxsxqq language curl code curl location globoff https api sandbox klavi ai payment customer v1 instant payments id n header accept application json n header content type application json customlabel id cbwoh6l4ndw31uq1ywqpg language nodejs code var request require request ; nvar options n method get n url https api sandbox klavi ai payment customer v1 instant payments 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 ya6lgqghxjxsm5uaq1kwp 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 instant payments id requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id q4xttiu0dspko0s9a8nav language python code import requests nimport json n nurl https api sandbox klavi ai payment customer v1 instant payments 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 l2uap4p73d4amvmewi2zn language ruby code require uri nrequire json nrequire net http n nurl uri https api sandbox klavi ai payment customer v1 instant payments 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 l2uap4p73d4amvmewi2zn results languages id ovpio0txzmbo 0y0lzbc0 language 200 customlabel 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 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 or if method pix inic 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 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 n ispb 00000000 required n issuer 0001 optional n number 324223 required n accounttype cacc required n holder n n identifier 76109277673 required n name john doe required n identifiertype cpf required n required n required if mthod pix manu n externalinfo n n key value n optional n cancellation n n cancelledfrom merchant required the cancellation source merchant initiator institution n cancelledat 2021 05 21t08 30 00z required n cancelledby n n identifier 11111111111 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 id qrv7oys2phfed9yt5 yxc language 409 customlabel code n statuscode 409 n error conflict n message insufficient permissions requested n selectedlanguageid qrv7oys2phfed9yt5 yxc request pathparameters name id kind required type string description payment initiation id it will be returned when post payments is called payment initiation id it will be returned when post payments is called queryparameters headerparameters name authorization kind required type string description jwt bearer token children bodydataparameters formdataparameters currentnewparameter label path parameter value pathparameters response name id kind optional type string description id of the payment order nminlength 1 nmaxlength 100 npattern a za z0 9 a za z0 9 0 99 nexample txprmu9uqtromwhzv2xsu1fuazjsmdl 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 children name clientrequestid kind optional type string description merchant s internal orderid only can be used for once 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 name identifier kind optional type string description the number of the user identification document 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 children 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 children 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 children name transactionidentification kind optional type string description pattern a za z0 9 1 35 nmaxlength 35 nexample e00038166201907261559y6j6 children name loggedusercpf kind optional type string description user natural person who is logged in to the payment initiator institution nmaxlength 11 nexample 11111111111 npattern d 11 n restriction required if customer identifiertype is cnpj children name ibgetowncode kind optional type string description ibge town code nminlength 7 nmaxlength 7 npattern d 7 nexample 5300108 children name proxy kind optional type string description pix key nmaxlength 77 npattern w w s nexample 12345678901 nthe types of keys can be phone e mail cpf cnpj or random key nin the case of a mobile phone it must be informed in the e 1641 standard nin the case of e mail it must have the format xxxxxxxx xxxxxxx xxx xx and a maximum of 77 characters nin the case of cpf it must be informed with 11 numbers without dots or dashes in the case of cnpj it must be informed with 14 numbers without dots or dashes n restriction if inittype is pix manu the proxy field should not be filled in if inittype is pix inic pix dict pix qrcode the proxy field should always be filled with the pix key children name qrcode kind optional type string description qr code nmaxlength 512 npattern w w s nexample 00020104141234567890123426660014br gov bcb pix014466756c616e6f32303139406578616d706c652e636f6d27300012 br com outro011001234567895204000053039865406123 455802br5915nomedorecebedor6008brasilia61087007490062 530515rp12345678 201950300017br gov bcb brcode01051 0 080450014br gov bcb pix0123padrao url pix 0123ab cd81390012br com outro01190123 abcd 3456 wxyz6304eb76 nthis field should be in utf 8 format n restriction required for pix qrcode payments with a maximum size of 512 bytes children name inittype kind optional type string description payment initiation type npix inic pre registration of payee s account npix manu the creditor object must be sent with all payee information npix dict the pixkey field represents creditor information npix qrcode the qrcode field represents creditor information children 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 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 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 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 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 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 externalinfo kind optional type object description metadata merchant customizable children name cancellation kind optional type object description children name cancelledfrom kind optional type string description name cancelledat kind optional type string description name cancelledby kind optional type object description children name identifiertype kind optional type string description name identifier kind optional type string description name status kind optional type string description status children 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 children 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 children