Skip to main content
GET
/
cash
/
barcodes
Get a list of barcodes
curl --request GET \
  --url https://api.synctera.com/v1/cash/barcodes \
  --header 'Authorization: Bearer <token>'
{
  "barcodes": [
    {
      "account_id": "123e4567-e89b-12d3-a456-426614174001",
      "barcode_number": "839650172948537162049873516238",
      "creation_time": "2023-10-01T12:00:00Z",
      "currency": "USD",
      "customer_id": "123e4567-e89b-12d3-a456-426614174000",
      "customer_latitude": 40.73061,
      "customer_longitude": -73.935242,
      "id": "123e4567-e89b-12d3-a456-426614174002",
      "last_updated_time": "2023-10-01T12:00:00Z",
      "max_amount": 1000,
      "min_amount": 10,
      "status": "AVAILABLE",
      "tenant": "abcdef_ghijkl",
      "timestamp_valid_to": "2023-10-01T12:00:00Z",
      "type": "CASH_DEPOSIT",
      "external_device_id": "device123",
      "metadata": {}
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
barcode_number_like
string

Case insensitive wildcard search for barcode_number, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
upc_like
string

Case insensitive wildcard search for upc, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
barcode_number
string[]
​
to_timestamp_valid_to
string<date-time>
​
account_id
string<uuid>[]
​
from_creation_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
type
enum<string>[]

Type of the barcode.

Available options:
CASH_DEPOSIT
​
upc
string[]
​
to_last_updated_time
string<date-time>
​
tenant
string[]

The id of the tenant containing the resource.

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
biller_id_like
string

Case insensitive wildcard search for biller_id, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
status
enum<string>[]

Status of the barcode.

Available options:
AVAILABLE,
BLOCKED,
REDEEMED
​
from_timestamp_valid_to
string<date-time>
​
sort_by
enum<string>[]
Available options:
creation_time:asc,
creation_time:desc,
last_updated_time:asc,
last_updated_time:desc,
timestamp_valid_to:asc,
timestamp_valid_to:desc
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
to_creation_time
string<date-time>
​
customer_id
string<uuid>[]
​
biller_id
string[]
​
id
string<uuid>[]

Response

Successful retrieval of barcodes

​
barcodes
object[]
required
​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"