Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
BillPay

Update Payee

Update existing payee information. This endpoint allows an existing payee’s information to be updated using the payeeIdentifier. The payee can be a merchant or a person. You must provide the payeeIdentifier, accountIdentifier, and the updated payee details in the request body. The response contains the result of the update operation.

put/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 update. 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

payeeIdentifierstring nullable

The unique identifier of the payee to update. Must be a valid GUID.

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.

zipstring nullable

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

countrystring nullable

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

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.

Response

OK