Nhảy tới nội dung

Installments API

Use Case​

API này sẽ được sử dụng để trả về các gói trả góp có sẵn cho người dùng.

Request​

POST/v2/installments/packages

ParameterTypeRequiredDescription
merchantIdStringFundiin cung cấp MID như một định danh duy nhất cho mỗi đối tác.
langStringNgôn ngữ của message (vi or en)
amount.valueIntegerSố tiền giao dịch
amount.currencyStringVND
firstInstallmentPercentDouble% Số tiền người dùng phải trả trước cho một giao dịch trả góp,
mặc định lấy giá trị thấp nhất
descriptionStringMô tả cho đơn đặt hàng.
itemsJsonArrayItems

Data of each items​

AttributeTypeRequiredDescription
productIdStringThe Id of item.
productNameStringThe name of item.
descriptionStringThe description of item.
categoryStringThe type of item.
currencyStringVND
quantityIntegerQuantity number of each item. It must be greater than 0
priceIntegerPrice of single unit item
totalAmountIntegerprice x quantity
imageUrlStringLink image of product.

Example Request

{
    "merchantId": "Your merchant code",
    "lang": "vi",
    "description": "description",
    "firstInstallmentPercent" : 0.3,
    "amount": {
        "currency": "VND",
        "value": 1000000
    },
    "items": [
        {
            "id": "170594",
            "productId": "170594",
            "productName": "clothes",
            "quantity": 2,
            "price": 200000,
            "totalAmount": 400000,
            "purchaseAmount": 400000
        }
    ]
}

Response​

ParameterTypeRequiredDescription
merchantIdStringFundiin cung cấp MID như một định danh duy nhất cho mỗi đối tác
responseTimeStringNgày & Giờ của phản hồi:
Format: YYYY-MM-DD hh:mm:ss
firstInstallmentPercentString% Số tiền người dùng phải trả trước cho một giao dịch trả góp
firstInstallmentsJsonArrayDanh sách thông tin các gói trả góp
installmentPacksJsonArrayXác định các gói trả góp hiện tại được cung cấp trong trường "firstInstallmentPercent".
resultStatusStringTrạng thái kết quả
resultMsgStringChi tiết kế quả

Data of installmentPacks​

AttributeTypeRequiredDescription
packageIdStringId của gói trả góp.
packageTypeStringCác loại gói trả góp: 30_days,3_months, 6_months, 9_months, 12_months
firstInstallmentPercentDouble% Số tiền người dùng phải trả trước cho một giao dịch trả góp
firstInstallmentAmountLongSố tiền người dùng phải trả trước cho một giao dịch trả góp ứng với tỷ lệ phần trăm trả trước
subSeqInstallmentAmountLongCác số tiền sau đó mà khách hàng phải trả cho từng kì
interestRateDoubleTỷ lệ phần trăm bị tính phí
totalAmountDueLongTổng tiền đã bao gồm phí dịch vụ
tenureIntegerSố kỳ cần thanh toán
installmentFeeLongPhí dịch vụ cho toàn bộ đơn hàng ứng với số tiền cần trả trước
{
    "responseTime": "2023-08-03 04:10:14",
    "resultStatus": "APPROVED",
    "resultMsg": "The transaction was approved.",
    "merchantId": "your merchant code",
    "amount": {
        "currency": "VND",
        "value": 1000000
    },
    "firstInstallmentPercent": 0.3,
    "firstInstallments": [
        {
            "firstInstallmentPercent": 0.3,
            "firstInstallmentAmount": 300000
        },
        {
            "firstInstallmentPercent": 0.4,
            "firstInstallmentAmount": 400000
        },
        {
            "firstInstallmentPercent": 0.5,
            "firstInstallmentAmount": 500000
        },
        {
            "firstInstallmentPercent": 0.6,
            "firstInstallmentAmount": 600000
        },
        {
            "firstInstallmentPercent": 0.7,
            "firstInstallmentAmount": 700000
        }
    ],
    "installmentPacks": [
        {
            "packageId": "067000",
            "packageType": "6_months",
            "firstInstallmentPercent": 0.7,
            "firstInstallmentAmount": 700000,
            "subSeqInstallmentAmount": 53000,
            "interestRate": 0.05,
            "installmentFee": 15000,
            "totalAmountDue": 1015000,
            "tenure": 6
        },
        {
            "packageId": "097000",
            "packageType": "9_months",
            "firstInstallmentPercent": 0.7,
            "firstInstallmentAmount": 700000,
            "subSeqInstallmentAmount": 35000,
            "interestRate": 0.05,
            "installmentFee": 15000,
            "totalAmountDue": 1015000,
            "tenure": 9
        },
        {
            "packageId": "127000",
            "packageType": "12_months",
            "firstInstallmentPercent": 0.7,
            "firstInstallmentAmount": 700000,
            "subSeqInstallmentAmount": 27000,
            "interestRate": 0.05,
            "installmentFee": 15000,
            "totalAmountDue": 1015000,
            "tenure": 12
        }
    ]
}

Demo​

Số tiền thanh toán : 1.000.000 đ
Vui Lòng Chọn Số Tiền Muốn Trả Trước:
Kỳ hạn
Phí dịch vụ
Góp mỗi tháng
Tổng cộng
6 Tháng35.000 ₫123.000 ₫1.073.000 ₫
9 Tháng35.000 ₫82.000 ₫1.073.000 ₫
12 Tháng35.000 ₫62.000 ₫1.079.000 ₫

Result Status & Messages​

Status codeDescriptionAction to take
APPROVEDThe transaction was successfully initial.
ACCESS_DENIEDAccess denied.Please check your settings in merchant portal, or contact Fundiin for configurations.
INVALID_REQUESTInvalid request. e.g. Invalid currency, invalid amout etc.
INVALID_FIRST_INSTALLMENT_PERCENTThe first installment percent is invalidPlease retry with a correct firstInstallmentPercent.
INVALID_CLIENT_IDThe cliendId is not registered
INVALID_SIGNATUREThe signature is invalid.
INVALID_MERCHANT_IDThe merchant is not registered.
INVALID_HTTP_METHODThe server does not implement the requested HTTPS method.
INVALID_APIAPI is not defined.Check whether the request URL is correct. Ensure that the endpoint of the called API is correct.
INVALID_AMOUNTPayment amount is invalid.
AMOUNT_EXCEEDED_UPPER_LIMITThe payment amount exceeds the limit at merchant level or account level
AMOUNT_BELOW_MINIMUM_LIMITThe payment amount is below minimun limit.
REQUEST_PROCESSINGThe request already processed or in progress
DOWNSTREAM_ERRORPartner downstream timeout. (Retriable)
ERROR_GENERALDeclined due to general reasons other than the specific decline error codes provided.
INSTALLMENT_UNAVAILABLEThe installment package information is invalid.

Contents