Get the payment resource

name consents consentid payments paymentid method get url https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid description get the payment resouce tab examples examples languages id 1q ftbouqdudpnagphucx language curl code curl location globoff https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid n header accept application json n header content type application json customlabel id jqityj5mwrn8ycfzq np1 language nodejs code var request require request ; nvar options n method get n url https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid 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 orl0ki91wfafbzyclq6ok 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 consentid payments paymentid requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id dmgps0ypj3ixekua4vly8 language python code import requests nimport json n nurl https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid 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 rtuyy4onwitvne78ors b language ruby code require uri nrequire json nrequire net http n nurl uri https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid 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 1q ftbouqdudpnagphucx results languages id lsmaap3sbla0trenfk9xt 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 consentid yyt72e3a b846 i771 b044 971dc232ujd8 required n customer n n identifiertype cpf required cpf cnpj n identifier 76109277673 required mask this field n name jo o silva required n phone 12345 optional mask this field n email 123 123 com required mask this field n required n date 2023 01 23 required utc 3 n consentid yyt72e3a b846 i771 b044 971dc232ujd8 optional n endtoendid e9040088820210128000800123873170 optional 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 amount 1333 04 required n currency brl required n redirecturl close optional return url after user checkout in klavi env 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 mask this field n number 324223 required account number mask this field 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 mask this field if method ! pix manu n number 324223 required mask this field if method ! pix manu n accounttype cacc required n holder n n identifier 76109277673 required mask this field 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 institution required the cancellation source 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 optional n paymentmethod automatic pix required n paymentmethodconfig n t firstpayment true required n t originalpaymentid optional n required n customlabel selectedlanguageid lsmaap3sbla0trenfk9xt request pathparameters name consentid 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 required name paymentid kind required type string description pattern urn a za z0 9 a za z0 9 0 31 a za z0 9 ; ! ? nmaxlength 256 npayment id required 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 npayment 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 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 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 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 redirecturl kind optional type string description return rediect url after user checkout in klavi env 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 fixed value automatic pix children name paymentmethodconfig kind optional type object description children 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