Get Status with Flex

Allows a partner to get status information about one of their accounts in Flex.

note

This endpoint is hosted by Flex. If you are a multi biller partner, you must use the endpoint with both biller and account params, if you are a single biller partner, you should use the endpoint with just an account parameter.

Endpoint

GET /sbi/account/:accountId/status

Base URL: https://partner-bridge.{env}.getflex.com

Request

Headers

Header	Type	Required	Description
X-Client-Id	string	Yes	Your client ID (provided by Flex)
X-Api-Key	string	Yes	Your API key (provided by Flex)
Content-Type	string	Yes	Must be application/json

Request Params

Param	Required	Description
account_id	yes	The account id in the partner’s system

Response

Success (200 OK)

{
  "status": "active",
  "last_payment_status": "completed",
  "last_payment_date": "2026-01-15",
  "last_payment_amount_in_cents": 10000
}

Response Fields

Field	Type	Description
status	enum<active, canceled>	The current status of this account in Flex
last_payment_status	enum<pending, processing, processed, sent, canceled>, nullable	The status of the last payment to the biller
last_payment_date	YYYY-MM-DD, nullable	The date the last payment was started.
last_payment_amount_in_cents	Int, nullable	The amount of the last payment

last_payment_status The last_payment_status field gives the Partner insight into the current status of the last payment to the biller Flex has processed for this user. Below is an overview of what the statuses mean.

• pending: Flex has seen the bill and will begin processing it soon.
• in_progress: Flex is processing the payment to the Partner.
• processed: The notification to the biller has been sent and marked as received. Funds are guaranteed.
• complete: The funds have been sent to the partner.
• canceled: The payment was canceled. Most commonly because the user didn’t take action in time.

Error Responses

404 Not Found

Returned when the client ID is not recognized or the account cannot be found.

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

500 Internal Server Error

Returned when an unexpected error occurs on the Flex side.

{
  "code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred"
}