Authentication

endpoint	link to documentation
POST /oauth2/token	Retrieve an access token

Payment endpoints

The transactions APIs are used in different levels of the payment activities and interactions.

endpoint	link to documentation
POST /v1/tokenize	Vault the PAN with FlexFactor
POST /v1/evaluate	Send transactions over to FlexFactor to analyze and rescue/decline it.
POST /v1/capture	Capture authorized payment transactions.

Orders endpoints

Use Order APIs to manage orders that were processed through FlexFactor.

endpoint	link to documentation
GET /v1/orders/	Retrieve the status of multiple orders at once.
GET /v1/orders/{id}	Retrieve the status on a specific order.
POST /v1/orders/{id}/refund	Issue partial or total refunds for a specific order.
POST /v1/orders/{id}/cancel	Cancel a pending order.

Merchant Onboarding

Programmatically onboard a merchant on FlexFactor services.

Application endpoints

Use the Application APIs to create and manage application forms on behalf of merchants.

endpoint	link to documentation
POST /v1/onboarding/application	Create a new applicant
GET /v1/onboarding/application/{id}	Retrieve the details on a specific application.
PUT /v1/onboarding/application/{id}	Edit the details of a specific application
POST /v1/onboarding/application/{id}/submit	Send an application for underwriting review
GET /v1/onboarding/application/list	Retrieve the status of multiple applications
POST /v1/onboarding/application/{id}/cancel	Cancel a pending application

Document Management Endpoints

Use the Documents APIs to attach and manage application documents.

endpoint	link to documentation
POST /v1/onboarding/application/{id}/documents/	Attach a document to an application.
GET /v1/onboarding/application/{id}/documents/	Retrieve all documents attached to a specific application.
GET /v1/onboarding/application/{id}/documents/{documentID}	Retrieve the list of documents attached to an application.
DELETE /v1/onboarding/application/{id}/documents/{documentID}	Delete a document associated with an application.

Merchants Endpoints

Merchant details include comprehensive metadata about merchants, such as their company information, contact details, banking information, and associated sites.

endpoint	link to Documentation
GET /v1/merchants/{mid}	Retrieve the details of a specific merchant.
GET /v1/merchants	Retrieve a list of onboarded merchants.

API Keys Endpoints

You can create, view, manage, and delete API keys on behalf of your merchants. Store them securely to authenticate your merchants when using the FlexFactor APIs

endpoint	link to documentation
POST /v1/api-keys	Create an API key
GET /v1/api-keys/{id}	Get an API key
GET /v1/api-keys/{mid}	Retrieve all the API keys related to a merchant
DELETE /v1/api-keys/{id}	Revoke an API key

Webhooks

endpoint	link to documentation
Webhooks	Set up and manage webhook configurations to receive real-time event notifications.

Testing scenarios

Use our whitelisted testing cards for your testing scenarios .

System Health

endpoint	link to documentation
GET /v1/health	Check the health and availability of the API services.