Payment retry rule object

Learn how to automatically retry payments in Mambu Payments (formerly Numeral)

Use payment retry rules to automatically retry failed or rejected payment orders and maximise payment success rate.

Attribute

Description

id string

The payment retry rule ID.

object
string

Always payment_retry_rule.

name
string

The payment retry rule name.

description
string

The payment retry rule description.

retry_conditions
object

The conditions to retry a payment:

retries
array

This array includes the sequence of retries, with their payment type and time interval. Every retry includes:

  • retry_to_payment_type: the type of the payment retry. See existing payment types
  • retry_after: the time interval before retrying a payment, expressed in alphanumeric shorthand (”30s” for 30 seconds, “15m” for 15 minutes, “1hr” for 1 hour, “7d” for 7 days, etc.)

created_at
timestamp

The UTC timestamp of the creation of the payment retry rule.

{
  "id": "1e5cf32f-c97e-4ca2-a427-63b10eeadfba",
  "object": "payment_retry_rule",
  "name": "Retry SCT Inst once then fall back to SCT",
  "description": "Retry SCT Inst once then fall back to SCT",
  "retry_conditions": {
    "payment_type": "sepa_instant",
    "payment_direction": "credit",
    "statuses": [
      "rejected"
    ],
    "reason_codes": [
      "AB05",
      "AB06",
      "AB07",
      "AB08",
      "AB09",
      "AB10",
      "TECH",
      "CNOR"
    ]
  },
  "retries": [
    {
      "retry_to_payment_type": "sepa_instant",
      "retry_after": "15s"
    },
    {
      "retry_to_payment_type": "sepa",
      "retry_after": "15s"
    }
  ],
  "created_at": "2024-03-29T16:00:02Z"
}