FinvyPayAPI Docs

Status API

Check the status of a payment or transaction by FinvyPay transaction ID.

Get Payment Status (Production)

GET/api/production/status/:id
Requires API Key

Returns the current status of a payment or transaction. Use the FinvyPay transaction ID from the payment response as the path segment :id.

Path Parameters

ParameterTypeRequiredDescription
idstringYesFinvyPay transaction ID (e.g. from card or APM payment response)

Example Request

GET /api/production/status/FP260231SJWKL80027

Success — transaction found

200
{
  "success": true,
  "data": {
    "transactionId": "FP260231SJWKL80027",
    "orderId": "ORD-12345",
    "status": "SUCCESS",
    "amount": 100,
    "currency": "USD",
    "paymentMethod": "card",
    "createdAt": "2024-03-07T12:00:00.000Z",
    "completedAt": "2024-03-07T12:00:05.000Z",
    "metadata": {}
  }
}

Not found

404
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "No transaction found for the given transaction ID."
  }
}
Possible status values: PENDING, REDIRECT (awaiting 3DS or APM completion), SUCCESS, FAILED, DECLINED, CANCELLED.

Get Payment Status (Sandbox)

GET/api/sandbox/status/:id
Requires API Key

Returns the status of a payment or transaction in sandbox. Same path parameter and response shape as production.

Path Parameters

Same as production: id is the FinvyPay transaction ID.

GET /api/sandbox/status/FP2603YFGPKSWF0060

Success — sandbox

200
{
  "success": true,
  "data": {
    "transactionId": "FP2603YFGPKSWF0060",
    "orderId": "e21be056-d0c2-4003-be28-28dc88684b35",
    "status": "SUCCESS",
    "amount": 11,
    "currency": "USD",
    "paymentMethod": "card",
    "createdAt": "2024-03-07T14:32:00.000Z",
    "completedAt": "2024-03-07T14:32:08.000Z",
    "metadata": {}
  }
}