Busha Developer Documentation

List voucher purchases

curl --request GET \
  --url https://api.sandbox.busha.so/v1/vouchers \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "bus_123456789",
      "merchant_name": "SPAR",
      "voucher_code": "58556806",
      "currency": "BTC",
      "status": "used",
      "picture": "https://example.com",
      "current_value": "100",
      "voucher_value": "100",
      "expires_at": "2023-10-15T12:15:30Z",
      "created_at": "2023-10-15T12:15:30Z",
      "voucher_pin": "<string>",
      "redemptions": [
        {
          "amount_used": "100",
          "timestamp": "2023-10-15T12:15:30Z",
          "point_of_usage": "Gold Cat Wigs Store 1"
        }
      ]
    }
  ]
}

GET

vouchers

List voucher purchases

curl --request GET \
  --url https://api.sandbox.busha.so/v1/vouchers \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "bus_123456789",
      "merchant_name": "SPAR",
      "voucher_code": "58556806",
      "currency": "BTC",
      "status": "used",
      "picture": "https://example.com",
      "current_value": "100",
      "voucher_value": "100",
      "expires_at": "2023-10-15T12:15:30Z",
      "created_at": "2023-10-15T12:15:30Z",
      "voucher_pin": "<string>",
      "redemptions": [
        {
          "amount_used": "100",
          "timestamp": "2023-10-15T12:15:30Z",
          "point_of_usage": "Gold Cat Wigs Store 1"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer Authentication

Headers

X-BU-PROFILE-ID

string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

cursor

string<string>

The cursor

sort

enum<string>

The order to sort the results

Available options:

asc,

desc

Example:

"asc"

limit

integer

The number of items to return

Example:

10

active

boolean

Filter vouchers by active state.

status

string[]

Filter vouchers by status (can accept multiple values).

Response

Default

General response Values

status

enum<string>

required

Available options:

success,

error

Example:

"success"

message

string

required

Example:

"message for success"

pagination

object

required

Show child attributes

pagination.current_entries_size

integer

required

Example:

20

pagination.next_cursor

string

Example:

"MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA="

pagination.previous_cursor

string

Example:

"MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="

data

object[]

required

Show child attributes

data.id

string<nanoid>

required

A valid id

Example:

"bus_123456789"

data.merchant_name

string

required

Example:

"SPAR"

data.voucher_code

string

required

Example:

"58556806"

data.currency

string<string>

required

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.status

enum<string>

required

Available options:

pending,

used,

expired,

new,

inactive

Example:

"used"

data.picture

string<url>

required

A valid url

Example:

"https://example.com"

data.current_value

string

required

decimal value

Example:

"100"

data.voucher_value

string

required

decimal value

Example:

"100"

data.expires_at

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.created_at

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.voucher_pin

string

data.redemptions

object[]

History of partial or full voucher redemptions.

Show child attributes

data.redemptions.amount_used

string

required

decimal value

Example:

"100"

data.redemptions.timestamp

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.redemptions.point_of_usage

string

required

Example:

"Gold Cat Wigs Store 1"

Get transfer Create Voucher Purchase

⌘I

API reference

Authorizations

Headers

Query Parameters

Response