NEnexiopay
Decline Recovery

View a recovery

Returns a single decline recovery transaction.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.<br/><br/>Include the retry ID in the path parameter of the request.

<div style="display:none;">

Request parameters

  • retryId

Response parameters

  • id
  • cardToken
  • retryDate
  • transactionDate
  • originalAmount
  • originalDeclinePaymentId
  • retryEngineType
  • retryProviderRefNumber
  • orderNumber
  • recoveryStatus
  • retryCount
  • merchantId
  • originalPaymentRequest
  • retryMetadata
  • userName
  • isEnabledForRecovery
  • retryProviderBody
  • declineMessage
  • createdAt
  • updatedAt
</div>
get/recovery/v3/retry/{retryId}

Request

  • Base URL
    https://api.nexiopaysandbox.com
  • URL
    https://api.nexiopaysandbox.com/recovery/v3/retry/{retryId}
  • Auth
    HTTP basic

Path parameters

retryIdinteger required
Example:22391

The Nexio decline recovery identifier from the webhook.

Response

Success

idId (unresolved $ref)
cardTokenstring

The TokenEx card token. This is the saved card token. Card tokens can be used to process through any MID on your account. They are not restricted to a specific merchant account or currency.

retryDatestring date-time

The date and time at which the transaction will be retried. Will be null if the transaction is not scheduled to be retried.

transactionDatestring date-time

The transaction date of the original transaction.

originalAmountnumber

The original transaction amount.

originalDeclinePaymentIdstring

The payment ID of the original (declined) transaction.

retryEngineTypeinteger

<span style="background-color: #FFFF00; display:none;">NEED TEXT HERE. OPTIONS?</span>

retryProviderRefNumberstring

<span style="background-color: #FFFF00; display:none;">NEED TEXT</span>

orderNumberstring

The order number.

recoveryStatusinteger

The recovery status of the transaction. For possible values see the recoveryStatus table in the "Constant transaction values" topic.

retryCountinteger

The number of times the transaction has been retried. (The transaction will be retried up to 11 times within a 30 day period).

merchantIdstring

The merchant ID.

originalPaymentRequeststring

<span style="background-color: #FFFF00; display:none;">TEXT</span>

retryMetadatastring

<span style="background-color: #FFFF00; display:none;">TEXT</span>

userNamestring

The username under which the transaction was run.

isEnabledForRecoveryboolean

Will be true if decline recovery has been enabled for this transaction.

retryProviderBodystring

<span style="background-color: #FFFF00; display:none;">TEXT</span>

declineMessagestring

Message about the decline from the gateway provider.

createdAtstring

The date the transaction for this decline recovery record was created in your system. The format returned matches the format used in the request.

updatedAtstring date-time

The date and time at which the transaction record was most recently updated in Nexio.

Changes

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