Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
BillPay

Update Scheduled Bill Payment

Update Scheduled Bill Payment. This endpoint allows the scheduled bill payment to be updated, using the paymentIdentifier. <br/>• A one-time Bill Pay schedule cannot be changed to a recurring schedule by changing the frequencyType, because one time and recurring bill pay are under different model schema. <br/>• To change Bill Pay schedules, the customer must delete the one-time bill Pay schedule and create a new recurring bill Pay schedule. <br/>• The frequencyType for recurring bill Pay schedules cannot be changed to oneTime or the frequencyType that was previously set for the bill Pay schedule. <br/>• The frequencyType of 'oneTime' cannot be updated to another frequencyType. Recurring frequencyType can be updated to another recurring frequencyType (i.e. weekly or every2weeks, etc.), except oneTime.

put/programs/{programCode}/accounts/{accountIdentifier}/billpayPayments/{paymentIdentifier}

Path parameters

programCodestring required

The program code associated with the partner implementation.

accountIdentifierstring required

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

paymentIdentifierstring required

The unique identifier of the payment 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

accountIdentifierstring nullable

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

paymentIdentifierstring nullable

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

amountnumber double

The new amount to be paid to the payee.

paymentDatestring nullable

The new date the payment is to be sent (format: yyyy-MM-dd).

paymentEndDatestring nullable

The new end date for recurring payments (format: yyyy-MM-dd). Null for one-time payments.

frequencyTypestring nullable

The new frequency type for the payment (e.g., "oneTime", "weekly", "monthly").

paymentMemostring nullable

An optional memo to include with the payment.

notestring nullable

An optional note for the payment.

Response

OK