FastFlowPe is a payment orchestration platform. This documentation covers integration of our unified API for payments and payouts, SDKs, and workflows

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/status' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription status fetched successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "auth_status": "AUTHENTICATED",
    "subscription_status": "SUCCESS"
  },
  "meta": null
}

{
  "status": "error",
  "status_code": 404,
  "message": "Subscription not found",
  "detail": null,
  "data": null,
  "meta": null
}

{
  "status": "failure",
  "status_code": 400,
  "message": "Get subscription status failed",
  "detail": null,
  "data": {
    "error_message": "Error returned by PSP",
    "raw_response": {}
  },
  "meta": null
}

Use the internal subscription_id returned by the subscription initialize API. Do not use merchant_ref_id or the PSP subscription ID for this endpoint. Use the API key in the x-api-key header. Do not send it in the Authorization header.

Quick ReferenceRequired: subscription_idReturns: subscription_id, auth_status, subscription_statusMethod: POST

Endpoint Details

Field	Value
Method	`POST`
Payload	`JSON`
URL	`https://api.fastflowpe.com/merchant/recurring/subscription/status`

Request Headers

string

required

Your secret merchant API key issued by FastFlowPe.

string

required

Must be application/json.

string

required

Must be application/json.

Request Body

string

required

Internal FastFlowPe subscription UUID returned by the subscription initialize API.Do not pass merchant_ref_id or the PSP subscription ID.Example:4cbbd450-b326-4cac-9913-f772c57824b8

This is a POST API even though it retrieves subscription status.

Request Example

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/status' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID"
  }'

Replace YOUR_SUBSCRIPTION_UUID with the internal subscription_id returned by /merchant/recurring/subscription/initialize.

Response

A successful request returns the current mandate authorization status and subscription lifecycle status.

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription status fetched successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "auth_status": "AUTHENTICATED",
    "subscription_status": "SUCCESS"
  },
  "meta": null
}

{
  "status": "error",
  "status_code": 404,
  "message": "Subscription not found",
  "detail": null,
  "data": null,
  "meta": null
}

{
  "status": "failure",
  "status_code": 400,
  "message": "Get subscription status failed",
  "detail": null,
  "data": {
    "error_message": "Error returned by PSP",
    "raw_response": {}
  },
  "meta": null
}

Response Fields

string

Indicates whether the API request succeeded or failed.Possible values include success, error, and failure.

integer

HTTP-style status code associated with the response.

string

Human-readable message describing the result of the status request.

object

Additional response details when available.This may be null.

string

Internal FastFlowPe subscription UUID.This is the same subscription_id used in the request.

string

Current mandate authorization status.

string

Current lifecycle status of the subscription.

string

Error message returned when the status check fails.This field is present in failure responses.

object

Raw response returned by the underlying PSP when the status check fails.

object

Optional response metadata.This may be null.

Authorization Status Values

Status	Meaning
`PENDING`	Mandate authorization is awaiting customer or bank confirmation.
`AUTHENTICATED`	Mandate was approved successfully.
`FAILED`	Mandate authorization failed.
`REVOKED`	Customer cancelled or revoked the mandate.
`DEACTIVATED`	Mandate expired or was disabled.

Subscription Status Values

Status	Meaning
`CREATED`	Subscription was created, but authorization may still be pending.
`PENDING`	Subscription or bank approval is pending.
`SUCCESS`	Subscription is active.
`HOLD`	Subscription is paused.
`CANCELED`	Subscription has been cancelled.
`COMPLETED`	All billing cycles have completed.

Always use the internal FastFlowPe subscription_id for subscription status checks and management operations.Do not use merchant_ref_id or the PSP subscription ID.

Store the subscription_id returned by the initialize API. This identifier should be used for future subscription status and management operations.

curl --location 'https://api.fastflowpe.com/merchant/recurring/subscription/status' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_MERCHANT_X_API_KEY' \
  --data-raw '{
    "subscription_id": "YOUR_SUBSCRIPTION_UUID"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Subscription status fetched successfully",
  "detail": null,
  "data": {
    "subscription_id": "4cbbd450-b326-4cac-9913-f772c57824b8",
    "auth_status": "AUTHENTICATED",
    "subscription_status": "SUCCESS"
  },
  "meta": null
}

{
  "status": "error",
  "status_code": 404,
  "message": "Subscription not found",
  "detail": null,
  "data": null,
  "meta": null
}

{
  "status": "failure",
  "status_code": 400,
  "message": "Get subscription status failed",
  "detail": null,
  "data": {
    "error_message": "Error returned by PSP",
    "raw_response": {}
  },
  "meta": null
}

Get Started

Collections

Payment Links

Fund Transfer

Refunds

Callbacks

subscription

Check Subscription Status

Endpoint Details

Request Headers

Request Body

Request Example

Response

Response Fields

Authorization Status Values

Subscription Status Values

​Endpoint Details

​Request Headers

​Request Body

​Request Example

​Response

​Response Fields

​Authorization Status Values

​Subscription Status Values

Endpoint Details

Request Headers

Request Body

Request Example

Response

Response Fields

Authorization Status Values

Subscription Status Values