Overview

sequenceDiagram
    participant LMS as Merchant/LMS
    participant API as FLEX API / CORE
    participant RTP as RTP Network
    participant Bank as Bank

critical Verification
    LMS->>API: 1. Request Token
    API->>LMS: 2. Token Verified + Sent Back
    end

    LMS->>API: 3. Post Instant RTP Transaction
    API->>API: 4. Validate + Check limits
    API->>RTP: 5. Submit transaction
    RTP->>Bank: 6. Settle payment instantly
    RTP-->>API: 7. Settlement confirmation
    API-->>LMS: 8. Response (status = settled or failed)

Transaction Lifecycle

Instant RTP (Real Time Payment) allows your LMS platform to send disbursements directly to a borrower’s bank account within seconds. This is ideal for high priority use cases such as loan funding, refunds, or payouts.

Your system will communicate directly with our API network to post and receive updates about each payment’s outcome.

Simply put…

LMS —> Flex API —> RTP Network —> Borrower’s Bank

1. LMS calls our API to create an RTP transaction.
2. Flex API validates the request and attempts the transfer.
3. The RTP Network settles the payment in real time.
4. You receive successfully sent transaction, or failure.

Instant RTP Transaction Example

Here is a step-by-step example flow of a basic Instant RTP transaction:

Step 1: Authentication (prior to setup)

Diagram

flowchart TD
    merchant[Merchant/LMS]
    api[FLEX API / AUTH]

    merchant -->|Request Token|api
    api -->|Token Verified 
    + Sent Back|merchant

Request authentication token from API for first time setup.

For information on how to authenticate, please see our dedicated page.

Step 2: Initiate RTP Payment

Diagram

flowchart TD
    merchant[Merchant/LMS]
    api[FLEX API / CORE]

    merchant -->|Post Instant RTP Transaction|api

Submit a new transaction with these instructions.

Some parameters include:

• amount: Transaction amount
• cardNumber: The card number associated with the transaction
• nameOnCard: The name the card is associated with

Full Parameter Info

You can view the full API documentation in our Swagger Collection. This collection provides detailed information about all available endpoints, including request and response schemas, parameters, and examples.

Step 3: API Validates the Request

Diagram

flowchart TD
    api[FLEX API / CORE]
    api -->|Validate + check limits|api

Behind the scenes, compliance checks are performed, and then the transaction is submitted to the RTP Network.

Step 4: RTP Rail Sends the Payment

Diagram

flowchart TD
    api[FLEX API / CORE]
    rtp[RTP Network]
    bank[Bank]

    api-->|Submit transaction|rtp
    rtp-->|Settle payment instantly|bank
    rtp-. Settlement confirmation .->api

• The API formats and sends the RTP message to the RTP Network.
• The recipient’s bank receives the message and accepts the payment.
• Funds are posted in real-time to the borrower’s account (within seconds)

Step 5: LMS Gets confirmation

Diagram

flowchart TD
    api[FLEX API / CORE]
    merchant[Merchant/LMS]

    api-. Response (status = settled or failed).->merchant

Within seconds, the LMS will receive a response from the API indicating whether the transaction was successfully settled or if it failed.

• If successful, the LMS can update the borrower’s account and notify them of the disbursement.
• If failed, the LMS should handle the error and inform the user accordingly.