Create New Payee

post

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

Create a new payee for a customer’s account.
• A payee can be a merchant or a person.
• A Person payee is a custom individual not listed in Green Dot’s vendor payee directory, so the full address information must be provided in order to send the bill payment.
• This endpoint allows the creation of a new payee for a customer’s account.
• The payee can be used for future bill payments.
• The response includes the new payee identifier and status.
• The payeeType must be either 'Merchant' or 'Person'.
• For merchant payees, merchantId should be provided.
• For person payees, full address and contact information must be provided.
• The accountIdentifier must be a valid GUID.
• The requestId must be provided in the X-GD-RequestId header for idempotency and tracking.

Path Params

programCode

string

required

The program code associated with the partner implementation. This identifies the specific program context for the payee.

accountIdentifier

string

required

The unique identifier of the account to which the payee will be added. Must be a valid GUID.

Body Params

The Gd.Bos.DataTransfer.Request.CreatePayeeRequest object containing payee details such as name, type, and address information.

payeeType

string | null

The type of payee. Expected values: "Merchant" or "Person".

name

string | null

The name of the payee (merchant or person).

nickName

string | null

An optional nickname for the payee.

address1

string | null

The first line of the payee's address.

address2

string | null

The second line of the payee's address (optional).

city

string | null

The city of the payee's address.

state

string | null

The state or province of the payee's address.

country

string | null

The country of the payee's address (e.g., "US").

zip

string | null

The ZIP or postal code of the payee's address.

accountNumber

string | null

The account number associated with the payee, if applicable.

phoneNumber

string | null

The payee's phone number.

string | null

The payee's email address.

merchantId

string | null

The merchant ID for merchant payees (if applicable).

Headers

X-GD-RequestId

string

required

The unique request identifier for idempotency and tracking. Must be provided in the X-GD-RequestId header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

201Created

403Forbidden

500Internal Server Error

503Service Unavailable