Recover v3

post

https://api.sticky.io/processing-hub/v3/api/recovery/recover

The Recovery endpoint allows merchants to fully delegate recovery to Sticky. Sticky handles the retry schedule, gateway resubmissions, and transaction orchestration automatically based on our optimized recovery logic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentProfileId

string

required

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

initiatedBy

string

required

Indicates who initiated the transaction. Use CIT for customer-initiated and MIT for merchant-initiated transactions.

isRecurring

boolean

required

Boolean indicating whether the transaction is part of a recurring billing cycle.

externalId

string

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

dunningProfileId

string

Identifier for the dunning (retry) strategy to be applied during payment recovery.

billingAddress

object

The billing address details associated with the payment.

customer

object

Unique identifier for the customer in the gateway.

paymentMethod

object

required

Specifies the payment method used for the transaction.

originalTransaction

object

required

Contains details of the initial transaction related to the current request.

mitReferenceTransactionId

string

Identifier linking the current transaction to a prior successful charge. Used to improve authorization for merchant-initiated transactions.

mitReferenceSettlementDate

string

The settlement date of the original successful transaction referenced by mitReferenceTransactionId. Required if mitReferenceTransactionId is included and the transaction is being submitted to Mastercard

billingStatementDescription

string

Optional string to customize how the charge appears on the customer’s card statement. Use it to override the default descriptor set by your processor, if supported.

subscriptionId

string

Unique identifier for the subscription tied to this transaction. Useful for correlating recovery attempts with subscription lifecycle events.

subscriptionStartDate

string

Timestamp marking when the customer’s subscription first began billing.

gatewayAdditionalInfo

object

priorAttemptCount

integer

Indicates how many recovery attempts were already made by the merchant before sending the transaction to Sticky.

priorDeclines

array of objects

Captures the reasons for the decline from previous recovery attempts performed by the merchant.

priorDeclines

Headers

API-Key

string

required

API key used for authentication and authorization of API requests.

Responses

200

400400