Sign in
error-state-recovery

Clear error state for payment request (PAY access required)

Changed on

Clears error states for payment requests in WaitingForManualAction state and resets them up for retry or other actions. This endpoint provides manual intervention capability to recover from error states by clearing error fields.

post/payment/error-state-recovery

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/payment/error-state-recovery
  • Auth: API key in header token

Request body

blockchainIdentifierstring required

The blockchain identifier of the payment request

network'Preprod' | 'Mainnet' required

The network the transaction was made on

retryPreviousActionboolean

When true, retry the failed action. When false or omitted, only clear the error state.

Example request

{
  "blockchainIdentifier": "blockchain_identifier",
  "updatedAt": "1970-01-20T20:00:36.260Z",
  "network": "Preprod"
}

Response

Error state cleared successfully for payment request

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "id": "cmf40vg7h0016ucj1u1ro6651"
  }
}

Changes

  • 315a2a763fb7Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property / to the response with the status

  • 87b151d07425Revision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status