API Documentation
Get balance
1 min
this api returns balance for accounts configured for checkout and payout transactions a list of balance objects is returned are for a given client id if for a given currency, there are multiple partners configured based on payment methods, the response will contain balances for those multiple partners { "name" "get balance", "method" "get", "url" "https //your hostname pay3 app/v1/client/fiat/balance", "description" "get balance for a client id", "tab" "examples", "examples" { "languages" \[ { "id" "r kjeovwrgdjxk9y79kwl", "language" "curl", "code" "curl location 'https //your hostname pay3 app/v1/client/fiat/balance?clientid=your client id' \\\\\n header 'access token access token in jwt'", "customlabel" "" } ], "selectedlanguageid" "r kjeovwrgdjxk9y79kwl" }, "results" { "languages" \[ { "id" " wpelu7c1gj3rysstvfco", "language" "200", "customlabel" "", "code" "{\n \\"balances\\" \[\n {\n \\"currencyid\\" \\"brl bz\\",\n \\"currency\\" \\"brl\\",\n \\"balance\\" \\"6348 22\\",\n \\"partner\\" \\"partnerid\\"\n }\n ]\n}" }, { "id" "nv086wqvdyra6yxpqpfit", "language" "400", "customlabel" "", "code" "{\n \\"error\\" {\n \\"code\\" \\"400\\",\n \\"message\\" \\"could not verify the client\\"\n }\n}" } ], "selectedlanguageid" " wpelu7c1gj3rysstvfco" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "clientid", "kind" "required", "type" "string", "description" "client id", "children" \[] } ], "headerparameters" \[ { "name" "access token", "kind" "required", "type" "string", "description" "access token received from access token api you can reuse the access token across multiple api calls till it is expired ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } }