Jump to Content
FlexPayFlexPay HomeTrust CenterStatus
DocumentationAPI ReferenceChangelog
FlexPay HomeTrust CenterStatusContact SupportFlexPay
API Reference
Contact Support
DocumentationAPI ReferenceChangelog

API basics

  • Introduction
  • Authentication
  • API Health Check
  • Response Codes

invisible recovery api

  • Charge
    • Chargepost
  • Authorize
    • Authorizepost
  • Capture
    • Capturepost
  • Void
    • Voidpost
  • Refunds
    • Refundpost
    • Refund-Paymentpost
    • Refunded Paymentpost
  • Transaction Details
    • Listget
    • Payment Statusget
    • Show Transaction (by merchantTransactionId)get
    • Show Transaction (by transactionId)get
  • Payment Methods
    • Create a Payment Methodpost
    • Listget
    • Showget
    • Updateput
    • Redactput
    • Recacheput
  • Successful Payment
    • Successful Paymentpost

gateway management api

  • Introduction
  • List Gateways
    • List Gatewaysget
  • Gateway Details
    • Gateway Detailsget
  • Create Gateway
    • Create Gatewaypost
  • Update Gateway
    • Update Gatewaypatch
  • Supported Gateways

Engaged Recovery API

  • Introduction
  • Customers
    • Upsert Customerpost
    • Complete Campaignpost
Powered byΒ 

API Health Check

FlexPay provides a dedicated Health Check endpoint:

https://api.flexpay.io/api/test

Upon successful connection to the Health Check endpoint, you will receive the following confirmation message:

{"message":"Your client successfully connects with FlexPay!"}

πŸ“˜

NOTE

No authentication is required for accessing the endpoint. Please limit test intervals to 5 minutes minimum.