Generates a new barcode for a given eCash partner (retailer).

post

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/barcodes

Generates a new barcode for an eCash Partner (retailer). Barcodes are retailer specific and can only be used once. Expiration date and time will be returned in the response.

Path Params

programCode

string

required

The program code associated with the request.

accountIdentifier

string

required

The unique identifier of the account.

Body Params

The request payload containing barcode generation details.

partnerId

string | null

The unique identifier of the eCash partner (retailer) for which the barcode is generated.

amount

double | null

The transaction amount to be associated with the barcode, if applicable.

zipCode

string | null

The ZIP code relevant to the transaction or location.

transactionType

string

enum

The type of eCash transaction (e.g., "send", "load").

Allowed:

recipient

object

Recipient – Represents the recipient of an eCash transaction. Used to provide recipient details such as phone number, first name, and last name for barcode generation and eCash operations.

memo

string | null

An optional memo or note to include with the barcode transaction.

geoLocation

object

GeoLocation – Represents a geographic location using latitude and longitude coordinates. Used to specify the physical location for eCash partner searches, barcode generation, and other location-based operations.

Headers

X-GD-RequestId

string

required

The unique request identifier for tracking.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

201Created

403Forbidden

500Internal Server Error

503Service Unavailable