API REFERENCE
...
Automatic Pix
Cancel the payment
1 min
name consents consentid payments paymentid cancel method post url https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid cancel description cancel the payment tab examples examples languages id 196pg1jemj9ffz8wwrmo1 language curl code curl location globoff https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid cancel n header accept application json n header content type application json n data cancelledby string identifiertype string customlabel id llqwi1jeinmrc lfmtsmb language nodejs code var request require request ; nvar options n method post n url https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid cancel n headers n accept application json n content type application json n n body json stringify n cancelledby string n identifiertype string n n n ; nrequest options function error response n if error throw new error error ; n console log response body ; n ; n customlabel id bxdhg7ako9u3kmgtydl0g language javascript code var myheaders new headers ; nmyheaders append accept application json ; nmyheaders append content type application json ; n nvar raw json stringify n cancelledby string n identifiertype string n ; n nvar requestoptions n method post n headers myheaders n body raw n redirect follow n ; n nfetch https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid cancel requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id cx7fgpgvnptvvjgfh8fcu language python code import requests nimport json n nurl https api sandbox klavi ai payment customer v1 automatic consents consentid payments paymentid cancel n npayload json dumps n cancelledby string n identifiertype string n nheaders n accept application json n content type application json n n nresponse requests request post url headers headers data payload n nprint response text n customlabel id dsdp23y7pphpbbzcewxin 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 cancel n nhttps net http new url host url port nhttps use ssl true n nrequest net http post new url nrequest accept application json nrequest content type application json nrequest body json dump n cancelledby string n identifiertype string n n nresponse https request request nputs response read body n customlabel selectedlanguageid 196pg1jemj9ffz8wwrmo1 results languages id wnzklfoz8xmki83grqna6 language 200 code customlabel selectedlanguageid wnzklfoz8xmki83grqna6 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 pattern urn a za z0 9 a za z0 9 0 31 a za z0 9 ; ! ? nmaxlength 256 nconsent id 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 pattern urn a za z0 9 a za z0 9 0 31 a za z0 9 ; ! ? nmaxlength 256 npayment id queryparameters headerparameters name authorization kind required type string description jwt bearer token jwt bearer token bodydataparameters name cancelledby kind required 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 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 required 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 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 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