v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

BillPay

Get Payee by Payee Identifier

<br/>•Retrieves payee information for a given payee identifier. <br/>•If a customer has been enrolled in BillPay and has added at least one Payee, <br/>•call the endpoint and include the payeeID. <br/>•The API will use the payeeID provided to retrieve and return the associated Payee information in the response.

get/programs/{programCode}/accounts/{accountIdentifier}/billpayPayees/{payeeIdentifier}

Path parameters

programCodestring required

The program code associated with the partner implementation.

accountIdentifierstring required

The unique identifier of the account associated with the payee. Must be a valid GUID.

payeeIdentifierstring required

The unique identifier of the payee to retrieve. 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.

Response

payeeIdentifierstring nullable

The unique identifier of the payee.

payeeStatusstring nullable

The status of the payee (e.g., "active", "inactive").

payeeTypestring nullable

The type of payee (e.g., "Merchant", "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.

zipCodestring nullable

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

countryCodestring nullable

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

typestring nullable

The type of account associated with the payee, if applicable.

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.