Sign in
BillPay

Delete Payee

Deletes an existing payee from a user’s account using the payeeIdentifier. Once the payee is deleted, all associated scheduled bill payments will be canceled as well.

delete/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 delete. 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

OK

payeeStatusstring nullable

The status of the payee after deletion. Typical values are "inactive" or "deleted" to indicate the payee is no longer available for bill payments.

Changes