Retry Policies

Update a Retry Policy

Update an existing Retry Policy by its ID

post/retry-policies/{id}

Path parameters

idstring required

Request body

titlestring

Comment for the configuration

Example request

{
  "title": "Simple Recovery configuration that uses multiple different rules",
  "steps": []
}

Response

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the retry policy

titlestring required

Human-readable name for the retry policy

isDefaultboolean required

Whether this policy is the default retry policy applied when no specific policy is configured

isEnabledboolean

Whether payment retries are active for this policy

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "title": "Default Retry Policy",
  "isEnabled": true,
  "steps": [
    {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "position": 8,
      "isEnabled": true,
      "useInitialGateway": true,
      "priceReductionPercentage": 15,
      "retryDelay": 3
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.