Skip to main content
PATCH
Update a barcode

Authorizations

Authorization
string
header
required

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

Path Parameters

barcode_id
string<uuid>
required

ID of the generated barcode.

Example:

"123e4567-e89b-12d3-a456-426614174002"

Body

application/json
status
enum<string>

Status of the barcode.

Available options:
BLOCKED

Response

Successful update of barcode

account_id
string<uuid>
required

ID of the account for which the barcode was generated.

Example:

"123e4567-e89b-12d3-a456-426614174001"

barcode_number
string
required

The generated barcode number.

Example:

"839650172948537162049873516238"

creation_time
string<date-time>
required

Timestamp of when the barcode was created.

Example:

"2023-10-01T12:00:00Z"

currency
enum<string>
required

ISO 4217 Alpha-3 currency code for the cash transaction.

Available options:
USD
customer_id
string<uuid>
required

ID of the customer for whom the barcode was generated.

Example:

"123e4567-e89b-12d3-a456-426614174000"

customer_latitude
number<float>
required

Latitude of the customer location.

Required range: -90 <= x <= 90
Example:

40.73061

customer_longitude
number<float>
required

Longitude of the customer location.

Required range: -180 <= x <= 180
Example:

-73.935242

id
string<uuid>
required

ID of the generated barcode.

Example:

"123e4567-e89b-12d3-a456-426614174002"

last_updated_time
string<date-time>
required

Timestamp of the last update to the barcode.

Example:

"2023-10-01T12:00:00Z"

max_amount
number<float>
required

Maximum amount for the cash transaction.

Example:

1000

min_amount
number<float>
required

Minimum amount for the cash transaction.

Example:

10

status
enum<string>
required

Status of the barcode.

Available options:
AVAILABLE,
REDEEMED,
BLOCKED
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

timestamp_valid_to
string<date-time>
required

Timestamp indicating the expiration time of the barcode. Always set to 15 minutes after the creation time.

Example:

"2023-10-01T12:00:00Z"

type
enum<string>
required

Type of the barcode.

Available options:
CASH_DEPOSIT
external_device_id
string

ID of the external device used for the barcode generation.

Maximum string length: 64
Example:

"device123"

memo
string

A short memo that will be inherited by all transactions created with this barcode.

Maximum string length: 255
Example:

"Cash deposit - Downtown 5th Ave store"

metadata
object

Any additional custom metadata related to the barcode. * Can contain up to 10 key-value pairs with up to 200 characters each.