Biklo for developersTESTsandbox-api.biklo.comchange

Payout onboarding state

GET/v1/wallet/account

scope wallet.read

Check this BEFORE offering a withdrawal button. Payout onboarding runs on Stripe Connect, which collects identity documents directly in a hosted browser flow — it CANNOT be completed through this API and no endpoint for it will ever exist. requirements.currently_due carries Stripe's own field names for what is still missing, and next_step says what to tell your user.

Response#

FieldTypeDescription
dataobjectYour payout account — the identity checks that must pass before money can leave the platform. This is a Stripe Connect account behind the scenes, and these fields mirror what it reports.
data.has_accountbooleanWhether a payout account exists at all. false means nobody has started onboarding.
data.can_withdrawbooleanThe one field to branch on. Everything else explains WHY it is false.
data.onboarding_statusstringHow far onboarding has got.
data.payouts_enabledbooleanWhether the account may receive money.
data.details_submittedbooleanWhether the required details have been provided. They can be submitted and still not verified.
data.requirementsobjectWhat is still outstanding. Onboarding is finished in a browser, not over this API — a partner reads this to tell the seller what to go and do.
data.requirements.currently_duestring[]Needed now. Payouts stay blocked until these are supplied.
data.requirements.past_duestring[]Overdue. Worse than currently_due: the account may already be restricted.
data.requirements.pending_verificationstring[]Supplied and being checked. Nothing to do but wait.
data.requirements.disabled_reasonstring|nullWhy payouts are switched off, when they are.
data.bank_accountsarrayWhere money would go. Full numbers are never returned.
data.bank_accounts[].last4stringLast four digits, enough to tell two accounts apart.
data.bank_accounts[].currencystringWhich currency this account receives. A payout needs a bank account in the BALANCE currency: holding RON with a EUR-only account leaves the money stuck.
data.bank_accounts[].countrystringISO-2 of the bank.
data.next_stepobjectWhat to do next, in one place, so an integration does not have to interpret the requirement lists.
data.next_step.actionstringA stable key for the next action; none when nothing is needed.
data.next_step.messagestringThe same thing in words, safe to show a seller.

Example

{
    "data": {
        "has_account": true,
        "can_withdraw": true,
        "onboarding_status": "complete",
        "payouts_enabled": true,
        "details_submitted": true,
        "requirements": {
            "currently_due": [],
            "past_due": [],
            "pending_verification": [],
            "disabled_reason": null
        },
        "bank_accounts": [
            {
                "last4": "0000",
                "currency": "RON",
                "country": "RO"
            }
        ],
        "next_step": {
            "action": "none",
            "message": "This account can receive payouts."
        }
    }
}

Failures use the shared error envelope — a machine-readable code and a request_id to quote to support. Error handling.

curl -X GET "https://sandbox-api.biklo.com/v1/wallet/account" \
  -H "Authorization: Bearer bk_test_YOUR_KEY"
<?php

$ch = curl_init('https://sandbox-api.biklo.com/v1/wallet/account');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer bk_test_YOUR_KEY',
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "bk_test_YOUR_KEY");

var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://sandbox-api.biklo.com/v1/wallet/account");

var response = await client.SendAsync(request);
var json = await response.Content.ReadAsStringAsync();

import requests

response = requests.get(
    "https://sandbox-api.biklo.com/v1/wallet/account",
    headers={"Authorization": "Bearer bk_test_YOUR_KEY"},
)

data = response.json()

const response = await fetch("https://sandbox-api.biklo.com/v1/wallet/account", {
  method: "GET",
  headers: {
    Authorization: "Bearer bk_test_YOUR_KEY"
  }
});

const data = await response.json();

import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox-api.biklo.com/v1/wallet/account"))
    .header("Authorization", "Bearer bk_test_YOUR_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());