Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
BillPay

Create New Payee

Create a new payee for a customer’s account.<br/> • A payee can be a merchant or a person.<br/> • 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.<br/> • This endpoint allows the creation of a new payee for a customer’s account.<br/> • The payee can be used for future bill payments.<br/> • The response includes the new payee identifier and status.<br/> • The payeeType must be either 'Merchant' or 'Person'.<br/> • For merchant payees, merchantId should be provided.<br/> • For person payees, full address and contact information must be provided.<br/> • The accountIdentifier must be a valid GUID.<br/> • The requestId must be provided in the X-GD-RequestId header for idempotency and tracking.<br/>

post/programs/{programCode}/accounts/{accountIdentifier}/billpayPayees

Path parameters

programCodestring required

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

accountIdentifierstring required

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

Headers

X-GD-RequestIdstring required

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

Request body

payeeTypestring nullable

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

namestring nullable

The name of the payee (merchant or person).

nickNamestring nullable

An optional nickname for the payee.

address1string nullable

The first line of the payee's address.

address2string nullable

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

citystring nullable

The city of the payee's address.

statestring nullable

The state or province of the payee's address.

countrystring nullable

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

zipstring nullable

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

accountNumberstring nullable

The account number associated with the payee, if applicable.

phoneNumberstring nullable

The payee's phone number.

emailstring nullable

The payee's email address.

merchantIdstring nullable

The merchant ID for merchant payees (if applicable).

Response

Created

payeeIdentifierstring nullable

The unique identifier assigned to the newly created payee. Use this identifier for future operations involving this payee.

payeeStatus'active' | 'inactive' nullable

The status of the payee after creation. Possible values are defined in Gd.Bos.DataTransfer.Response.CreatePayeeResponse.PayeeStatus (e.g., Active, Inactive).