Dunning v4

A unique identifier specific to the dunning session. Automatically generated if not provided. This should be submitted in the request to obtain subsequent retry attempts. It informs the system what retry attempt number the dunning session is on.

The Payment Account Number (PAN) or Bank Identification Number (BIN) is linked to the payment method and should consist of a minimum of 6 digits when utilized.

The payment provider or gateway used for the transaction. e.g., NMI, Stripe

The reason provided by the payment provider for the payment failure. The parameter is used to input the decline reason string response from the gateway. Should be populated with the decline reason as a string response. This helps in accurately capturing the reason for payment failure as provided by the payment provider. e.g., Do Not Honor, Insufficient Funds

An issuer-provided code that advises whether or not a declined transaction should be retried. Primarily used for Mastercard, this value helps optimize retry behavior by indicating if a retry should be avoided, delayed, or attempted using a different method.

A numeric value (e.g., “51”, “05") returned by the payment processor, not the gateway, indicating the standardized reason for decline per ISO 8583 (e.g., “51” = Insufficient Funds, “05" = Do Not Honor).

Actual value of the payment that is being processed.

ISO 4217 Code for the type of currency in which the payment is being made. e.g., USD, CAD.

The email address associated with the payment transaction.

The phone number associated with the payment transaction.

Gateway transaction ID of the original decline transaction used for payment recovery.

Identifier for the payment gateway profile to be used for recovery attempts.

The decline response code returned by the payment gateway, indicating the specific reason the transaction was rejected.

The Address Verification Service (AVS) result code returned by the gateway or processor, indicating whether the billing address provided matches the information on file with the card issuer.

The Card Verification Value (CVV) result code returned by the gateway or processor, indicating whether the CVV provided matches the value on file with the card issuer.

The Cardholder Authentication Verification Value (CAVV) result code returned by the gateway or processor, typically used for 3-D Secure transactions to indicate the authentication outcome.

The name of the payment processor handling the transaction.

Unique identifier for the customer.

Unique identifier for the tokenized payment method.

An ISO 8601 UTC timestamp representing the earliest time a retry may be recommended. When provided, the recommendation engine guarantees the returned retry datetime will be strictly after this value. If omitted, standard retry logic applies. Format: YYYY-MM-DDTHH:mm:ssZ
Example: "retryHoldUntilUTC": "2025-08-10T18:00:00Z"

An optional merchant-defined reference ID used to identify the transaction externally.

UTC timestamp indicating when the original transaction was declined, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ), e.g., 2026-06-19T21:05:00Z.