API REFERENCE
...
Institutions
Get a list of institutions
1 min
name institutions method get url https api sandbox klavi ai payment customer v1 institutions description get institution for your end user debtor tab examples examples languages id 4iujwh7nklwndqr9abkfs language curl code curl location https api sandbox klavi ai payment customer v1 institutions n header accept application json n header content type application json customlabel id ka7kjgejyxhhvvgthjszz language nodejs code var request require request ; nvar options n method get n url https api sandbox klavi ai payment customer v1 institutions 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 bbaug0wxclnj2ajebvrm1 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 institutions requestoptions n then response response text n then result console log result n catch error console log error error ; customlabel id 10qj nmkdxnlzvztciwty language python code import requests nimport json n nurl https api sandbox klavi ai payment customer v1 institutions 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 lzdunzuxdakyzzzmxuoy2 language ruby code require uri nrequire json nrequire net http n nurl uri https api sandbox klavi ai payment customer v1 institutions 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 4iujwh7nklwndqr9abkfs results languages id 5we2iaztrcjc5olllklma language 200 customlabel code n t n t t id 81bada34 a509 43d6 9ac3 23f95b066411 n t t name mock bank 1 n t t avatar https example server com mockbank1 svg n t t description mock sandbox 1 n t t businesstype pj n t t outage false n t t outagereason outage a litte time n t t authmethod redirection bio metric n t t parentorganizationname testtest001 n parentorganizationid 1234124 n organizationname test001 n organizationid 56789 n t n t n t t id 81bada34 a509 43d6 9ac3 23f95b066411 n t t name mock bank 2 n t t avatar https example server com mockbank2 svg n t t description mock sandbox 2 n t t businesstype pj n t t outage false n t t outagereason outage a litte time n t t authmethod redirection bio metric n t t parentorganizationname testtest001 n parentorganizationid 1234124 n organizationname test001 n organizationid 56789 n t n selectedlanguageid 5we2iaztrcjc5olllklma request pathparameters queryparameters headerparameters name authorization kind required type string description bearer access token it returned by the auth bearer access token it returned by the auth bodydataparameters formdataparameters currentnewparameter label query parameter value queryparameters response name id kind optional type string description institution id name name kind optional type string description name of institution n children name avatar kind optional type string description avatar of institution children name description kind optional type string description description children name businesstype kind optional type string description nbusiness types supported by the payer s bank npj only support cnpj npf only support cpf nboth support both cnpj and cpf n children name outage kind optional type boolean description is the current status of the institution in outage state nfalse available status ntrue unavailable status children name outagereason kind optional type string description reason for unavailability status children name authmethod kind optional type array description the authorization methods supported by this institution nredirection redirection nbio metric without redirection children