Get account

GET/v1/accountRun

Any API key can call this.

Response (200)

dataobjectrequired

The returned object, or an array of objects for a list.

livemodebooleanrequired

true means this object belongs to live and can involve real payments; false means it belongs to the sandbox.

merchantobjectrequired

Merchant account associated with this key.

idstringrequired

The id of your business.

Example: mer_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with mer_.

projectobject | nullrequired

The project of this key; null for a merchant key.

idstringrequired

The id of the project.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

keyobjectrequired

The key that made this request.

idstringrequired

The id of the key (never its secret).

Example: apk_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with apk_.

kindstringrequired

project limits this key to one project; merchant lets it access every project in the account, subject to its scopes.

Example: project

Possible values: project, merchant

scopesarray of stringrequired

The operations this key is allowed to call, such as payments:read. A key needs the matching scope for each request.

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/account" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": {
    "livemode": false,
    "merchant": {
      "id": "mer_01k7q3m8x2v5t9n4b6c1d0e7fa"
    },
    "project": {
      "id": "prj_01k7q3m8x2v5t9n4b6c1d0e7fa"
    },
    "key": {
      "id": "apk_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "kind": "project",
      "scopes": [
        "payments:read"
      ]
    }
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}