List wallet ledger entries

GET

/wallet/entries

curl --request GET \
  --url 'https://shipjay.com/api/v1/wallet/entries?limit=25' \
  --header 'Authorization: Bearer <token>'

The ledger is append-only. Negative amounts are spending.

Authorizations

• bearerAuth
  wallet:read

Parameters

Query Parameters

limit

integer

default: 25 >= 1 <= 100

before

integer

> 0 <= 9007199254740991

Responses

200

Success.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

number

kind

required

string

amount_cents

required

number

balance_after_cents

required

number

currency

required

string

shipment_id

required

string | null

description

required

string | null

created_at

required

string

next_cursor

required

string | null

Example ^generated

{
  "data": [
    {
      "id": 1,
      "kind": "example",
      "amount_cents": 1,
      "balance_after_cents": 1,
      "currency": "example",
      "shipment_id": "example",
      "description": "example",
      "created_at": "example"
    }
  ],
  "next_cursor": "example"
}

401

Missing or invalid API key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

403

The key lacks the required permission, or the account is suspended.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

404

The resource does not exist.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

422

The request is not valid. error.details.issues lists the problems.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

429

Too many requests. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}