GRgreendot
BillPay

Delete Scheduled Bill Payment

Deletes or cancels a scheduled bill payment using the paymentIdentifier. Both one-time and recurring scheduled bill payments can be deleted. Once deleted, the payment will no longer be processed or available for future operations.

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

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

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 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

paymentStatusstring nullable

The status of the payment after deletion. Typical values are "canceled" or "deleted" to indicate the payment is no longer scheduled or available for processing.

Changes

No recorded changes to this operation across all 2 revisions of this API.