List planned maintenances

API references

Search documentation... ⌘K

Open merchant dashboard

Merchant API

- available-api-versions
- retrieve-configuration
- retrieve-merchant-settings
- supported-payment-methods
- update-merchant-settings
- find-key
- list-keys
- revoke-key
- update-key
- balance-history
- get-balance
- find-bank-account
- link-bank-account
- set-primary-contact-bank-account
- unlink-bank-account
- update-bank-account
- validate-bank-account
- confirm-payment-link-batch
- create-payment-link-batch
- prepare-payment-link-batch
- find-batch
- list-batches
- find-invoice
- list-invoices
- list-monthly-billing-archives
- list-plans
- list-statements
- retrieve-current-plan
- retrieve-monthly-billing-archive
- select-plan
- confirm-branding-upload
- generate-branding-upload-url
- remove-branding-document
- retrieve-branding
- retrieve-branding-font
- update-branding
- find-card
- forget-card
- save-card
- set-default-card
- retrieve-checkout
- start-checkout
- add-contact
- filter-contacts
- list-contacts
- remove-contact
- retrieve-contact
- update-contact
- challenge-dispute
- concede-dispute
- confirm-dispute-evidence-upload
- escalate-dispute
- find-dispute
- generate-dispute-evidence-upload-url
- list-disputes
- list-disputes-by-payment
- retrieve-dispute-performance
- find-export
- list-exports
- request-contact-export
- request-payment-by-contact-export
- request-payment-export
- request-payout-by-contact-export
- request-payout-export
- disable-installation
- enable-installation
- find-installation
- list-installations
- reconfigure-installation
- remove-installation
- add-to-metadata-set
- list-metadata
- remove-from-metadata-set
- remove-in-metadata
- retrieve-metadata
- sync-metadata
- list-email-subscribers
- retrieve-email-subscriber
- retrieve-notification-topics
- subscribe-to-topics
- unsubscribe-from-all-topics
- add-payment-link
- clone-payment-link
- disable-payment-link
- enable-payment-link
- filter-payment-links
- find-payment-link
- list-payment-link-payments
- list-payment-links
- remove-payment-link
- abort-payment-on-terminal
- capture-payment
- filter-payments
- find-payment
- initiate-payment-flow
- list-activity-logs
- list-payment-activities
- list-payments
- list-payments-by-contact
- list-payments-by-terminal
- refund-payment
- request-payment
- resume-payment-on-terminal
- retrieve-refund-performance
- retrieve-sales-performance
- reverse-payment
- start-payment-on-terminal
- void-payment
- authorize-payout
- filter-payouts
- find-payout
- list-payout-activities
- list-payouts
- list-payouts-by-contact
- reject-payout
- retrieve-primary-bank-account
- send-payout
- send-payout-to-contact
- set-primary-bank-account
- turn-off-auto-payout
- turn-on-auto-payout
- list-planned-maintenances
- find-refund
- list-refunds-by-payment
- assign-role
- list-permissions
- list-roles
- list-api-request-logs
- add-terminal
- disable-terminal
- enable-terminal
- filter-terminals
- find-terminal
- generate-temporary-terminal-challenge
- list-terminals
- remove-terminal
- reset-terminal
- update-terminal
- add-topup
- filter-topups
- find-topup
- list-topups
- list-user-invitations
- list-users
- find-virtual-account
- list-virtual-accounts
- disconnect-webhook
- find-webhook
- list-webhooks
- pause-webhook
- reconnect-webhook
- resume-webhook

All our references

Retrieve recent and upcoming planned maintenance windows for our services.

Endpoint signature

POST https://api.reservepay.com/merchants/list-planned-maintenances HTTP/1.1

Content-Type: application/json

Accept: application/json

{

language: string?,

}

Returns: array<object.planned_maintenance>

New to Reservepay? Read our guide on how to call endpoints to get started.

Request arguments

language string

Optional. The language for localized text attributes (e.g. 'en', 'th'). Defaults to 'en'.

Allowed values:

en
th

Planned maintenance attributes

Attribute	Description
`id` string	Always present. Unique identifier of the planned maintenance window.
`service_name` string	Always present. Name of the service undergoing maintenance, in the requested locale.
`status` string	Always present. Current lifecycle status of the planned maintenance window. Possible values: `pending` `in_progress` `completed`
`start_at` number	Always present. Scheduled start time as a Unix timestamp.
`end_at` number	Always present. Scheduled end time as a Unix timestamp.
`expected_impact` string	Always present. Category of expected service impact during the maintenance window. Possible values: `no_impact` `intermittent_service` `temporary_unavailable`
`expected_impact_description` string	Always present. Description of the expected service impact, in the requested locale.
`purpose` string	Always present. Detailed description of the maintenance purpose, in the requested locale.
`action_required` string	Always present. Action required by merchants or partners during the maintenance window. Possible values: `no_action` `pause_transactions`

Errors common to all endpoints


          UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.


          INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.


          BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown