About Payment Downtime API
Downtimes on payment methods and how to receive notifications.
Downtime is when one or more payment options underperform, leading to considerable delays in payment processing. These downtimes are due to technical issues or outages at Curlec's partner or issuing banks. Curlec informs you about the downtime to communicate it to your customers and display only the unaffected payment methods while accepting payments from them.
You can poll the API or configure Webhooks to be notified of the downtimes and plan the remediation steps accordingly.
Downtime communication for the payment methods such as cards and FPX is available.
Given below is a list of the downtime entity parameters.
id
string Unique identifier of the downtime's occurrence.
entity
string Here, it will be payment.downtime.
method
string The payment method that is experiencing downtime. Possible values include:
cardfpx
begin
integer Timestamp (in Unix) that indicates the start of the downtime. Applicable for both scheduled and unscheduled downtimes.
end
integer Timestamp (in Unix) that indicates the end of the downtime.
Available only for scheduled downtimes, where the end-time is known. Set to null when the end-time is unknown, possibly during unscheduled downtimes.
status
string Status of the downtime.
Possible statuses are.
scheduled- A downtime is scheduled to happen at a later time.started- The downtime has started and is ongoing.resolved- The downtime is resolved.cancelled- A scheduled downtime that is invalidated. For example, when a scheduled downtime was communicated but was later cancelled by the bank.
scheduled
boolean Possible values:
true- This is a scheduled downtime by the issuer, network, or the bank, which was informed to Curlec.false- This is an unscheduled downtime.
severity
string Severity of the downtime.
Possible values:
high- Possible when all the payment methods are affected by downtime. Observed when the issuer, bank or network is down.medium- Possible when a higher number of declines in transactions or low success rates are observed with the payment methods.low- Possible when the reason for the downtime is unknown. Impact on payment methods is minimal.
instrument
Payment method that is underperforming.
bank
if method=fpx
string Bank code of the affected bank.
issuer
if method=card
string Issuer bank code. For example, HSBC.
network
if method=card
string Card network. Possible values:
MCVISAALL
created_at
integer Timestamp (in Unix) that indicates the time at which the downtime was recorded in Curlec servers.
updated_at
integer Timestamp (in Unix) that indicates the time at which the downtime record was updated in Curlec servers.
card_type
string The card type used to process the payment. Possible values:
creditdebit
To retrieve details of payment downtimes, see this
.To retrieve details of payment downtimes by ID, see this
.The table below lists the webhook events available for payments downtime.
| Webhook Event | Description |
|---|---|
payment.downtime.started | Triggered at the beginning of the downtime. |
payment.downtime.resolved | Triggered when a downtime is resolved. |
payment.downtime.updated | Triggered when a downtime is updated. |
Was this page helpful?