Offers details

POST https://api.altermal.com/api:phZLPvsb/Offers/{OffersID}

Offers details



Authentication: required

Get offers details by Offers ID

Authentication: required

Returns only pending offers

This end point allows you to query for offers by Offers ID that are generated by Alter-Mal

You can utilize this query to check on the status of offers for your clients

Example of the input body of this end point:

JSON

{
  "OffersID": "3809668ee4dc40d9b90e6f9047c7c12f"
}

🚧

Offers vs Advance ID

Offers ID are related to the set of three offers sent to your client

The Advance ID is an unique combination of the Offer ID and the serial number of the offer sent (1 or 2 or 3)

Advance ID are to be used when the client select one of the three offers

While Offers ID can be used to query existing set of offers

Example of a Response

JSON

[
    {
        "AdvanceID": "3809668ee4dc40d9b90e6f9047c7c12f-1",
        "IntegrationPartnerID": 83,
        "Status": "Pending",
        "Advancepurpose": "Other",
        "OffersID": "3809668ee4dc40d9b90e6f9047c7c12f",
        "Description": "Best Value",
        "Loan_Amount": 175000,
        "Max_Term": 6,
        "Factor": 1.1,
        "Rev_Share": 0.08,
        "CounterpartyID": "B-ec274af3e3c447be9bcdcac66fa5c507",
        "their_ID": "24b40ac30778469c969e5f2ed116bd1d"
    },
    {
        "AdvanceID": "3809668ee4dc40d9b90e6f9047c7c12f-2",
        "IntegrationPartnerID": 83,
        "Status": "Pending",
        "Advancepurpose": "Other",
        "OffersID": "3809668ee4dc40d9b90e6f9047c7c12f",
        "Description": "More Money",
        "Loan_Amount": 355000,
        "Max_Term": 9,
        "Factor": 1.2,
        "Rev_Share": 0.09,
        "CounterpartyID": "B-ec274af3e3c447be9bcdcac66fa5c507",
        "their_ID": "24b40ac30778469c969e5f2ed116bd1d"
    },
    {
        "AdvanceID": "3809668ee4dc40d9b90e6f9047c7c12f-3",
        "IntegrationPartnerID": 83,
        "Status": "Pending",
        "Advancepurpose": "Other",
        "OffersID": "3809668ee4dc40d9b90e6f9047c7c12f",
        "Description": "More time",
        "Loan_Amount": 280000,
        "Max_Term": 12,
        "Factor": 1.3,
        "Rev_Share": 0.05,
        "CounterpartyID": "B-ec274af3e3c447be9bcdcac66fa5c507",
        "their_ID": "24b40ac30778469c969e5f2ed116bd1d"
    }
]

📘

Key Terms

Alter-Mal provide advances (loans) based on a Revenue Based Financing model (RBF) it is important to note the following terms:

Loan_Amount

Represent the Amount of Loan disbursed and paid to your merchant.

Rev_Share

The amount of revenues to be shared with Alter-Mal as part of the repayment of the loan

Factor

A multiple of the loan amount at which the loan is considered repaid as an example if the loan is SR 50k and the factor is 1.1x then when the revenue sharing from the actual revenues reaches SR55k (or 50k x 1.1x) the loan is considered repaid.

Max Term

This is maximum term of the loan, after which the loan RBF becomes due.