API Reference

Update Payee

put
https://example.com/programs//accounts//billpayPayees/

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.

Path Params
string
required

The program code associated with the partner implementation.

string
required

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

string
required

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

Body Params

The Gd.Bos.DataTransfer.Request.UpdatePayeeRequest object containing updated payee information.

string | null

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

string | null

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

string | null

The name of the payee (merchant or person).

string | null

An optional nickname for the payee.

string | null

The first line of the payee's address.

string | null

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

string | null

The city of the payee's address.

string | null

The state or province of the payee's address.

string | null

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

string | null

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

string | null

The account number associated with the payee, if applicable.

string | null

The payee's phone number.

string | null

The payee's email address.

Headers
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

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago