gd_retailer_key

Int

Y

Y

Retailer for which the barcode is being generated. The barcode number might be different based on the retailer. GD will provide the list of RetailerKeys to the consumer of the API.

gd_barcode_type

Int

Y

Y

• 0 = None

• 1 = BarcodeLink

• 2 = BarcodeNumberForPrint

• 3 = BarcodeNumberForViewNote:

• Use 1 to send a barcode link so the customer can generate a barcode at a later stage.Note: If this is selected. then notification_channel_type must be either SMS or Email.

• Use 2 when online web and print option is selected. Default barcode expiration time is 48 hours.

• Use 3 for mobile barcodes. Default barcode expiration time is 1 hour. The default value can be overwritten if there is a value configured in DB.

amount

Decimal

C

C

This is the amount for which the barcode is being generated. It is required when parameter amount_match_type = 1 or 2.

amount_match_type

Int

N

N

0 = Default. No constraints. Barcode can be consumed without constraint on amount.
1 = Partial consumption. Barcode must be consumed less than or equal to the amount specified in amount parameter (Not currently supported).
2 = Full consumption. Barcode must be consumed with exact amount specified in the amount parameter.

partner_transaction_refer ence

String

Y

Y

This is the transaction reference for the current transaction (i.e., send money request, etc.). The partner generates/maintains this value. Green Dot uses it for audit purposes.

sender_customer_ref

String

Y

Y

Identifier/Reference which the partner generates for the source (sender) of this transaction.

Example: If A is sending money to B, this field identifies A's account.

• *Note:** If applicable, sender risk controls are calculated off this identifier.

sender_first_name

String

Y

Y

For Add Cash type, this field passes the depositor’s first Name. For Bill Pay type, it passes the bill payer’s first name.

sender_last_name

String

Y

Y

For Add Cash type, this field passes the cash depositor’s last name. For Bill Pay type, it passes the bill payer’s last name.

sender_email

String

Y

N

For Add Cash type, this field passes the cash depositor’s email address. For Bill Pay type, it passes the bill payer’s email address.

sender_phone

String

Y

N

For Add Cash type, this field passes the cash depositor’s phone number. For Bill Pay type, it passes the bill payer’s phone number.

sender_address

String

N

Y

For Add Cash type, this field passes the cash depositor’s address. For Bill Pay type, it passes the bill payer’s address.

sender_zipcode

String

N

Y

For Add Cash type, this field passes the cash depositor’s zip code. For Bill Pay type, it passes the bill payer’s zip code.

recipient_customer_ref

String

Y

Y

This is the Identifier/Reference the partner generates for the target/receiver of this transaction.

Example: If A is trying to send money to B, this is an identifier/ reference of B's account.

• *Note:** If applicable, receiver risk controls are calculated off this identifier.

recipient_first_name

String

Y

N

For Add Cash type, this field passes the recipient’s first name. For Bill Pay type, it passes the payee’s first name.

• *Note:** If the bill pay partner cannot pass this data, we will block certain states during program configuration. For more details, contact your account manager.

recipient_last_name

String

Y

N

For Add Cash type, this field passes the recipient’s last name. For Bill Pay type, it passes the payee’s last name.

• *Note:** If the bill pay partner cannot provide this data, we will block certain states during program configuration. For more details, contact your account manager.
• *Note:** If the payee is a business, only provide a name in the recipient_first_name field.

recipient_email

String

Y

N

For Add Cash type, this field passes the recipient’s email address. For Bill Pay type, it passes the payee’s email address.

recipient_phone

String

Y

N

For Add Cash type, this field passes the recipient’s phone number. For Bill Pay type, it passes the payee’s phone number.

recipient_address

String

N

N

For Add Cash type, this field passes the recipient’s address. For Bill Pay type, it passes the payee’s address.

• *Note:** If the bill pay partner cannot pass this data, we will block certain states during program configuration. For more details, contact your account manager.

recipient_zipcode

String

N

N

For Add Cash type, this field passes the recipient’s zip code. For Bill Pay type, it passes the payee’s zip code.

• *Note:** If the bill pay partner cannot pass this data, we will block transactions in certain states. For more details, contact your account manager.

notification_channel_type

String

N

N

0 = none,
1 = SMS
2 – Email (only if Green Dot is sending barcode notifications on the partner’s behalf.)

gd_barcode_payment_type

Int

N

N

0 = Default. None. Barcode for cash-in.
1 = Deposit
2 = Payment
3 = Debit. Barcode for cash-out.