Getting Started

Introduction

Simplifying Buying

Kredivo checkout API allows you to implement our checkout process so Kredivo users can make a transaction on your platform, be it web based or app based. Our checkout API will ask User to enter his/her Kredivo phone number & PIN, followed by an OTP, to do a transaction from our embedded page.

Preparation

Prepare your site

To complete the Kredivo Checkout integration process as simply and quickly as possible, we recommend that you start by setting up the following.

Checkout page and confirmation page

Both the checkout page and the checkout confirmation page are hosted by you. Both these pages must include a div that you will populate with the Kredivo Checkout button. You will learn what the Kredivo Checkout is in our first tutorial, embed the checkout. Kredivo Checkout is responsive, which means that it will always use the full width of the container.

Tip! Place the Kredivo Checkout button so that your customers can see it instantly after loading the checkout page without scrolling. Provide clear calls to action to improve your conversion rates, such as "Finalize your purchase now".

An example of what the checkout looks like on different devices.

Push notification URI

As you will learn in the Confirm purchase tutorial, Kredivo needs a URI to inform you of the order status. You will need to include a placeholder in the push URI, which Kredivo will then replace with the order URI when we send the push request. You can download example push URI Here

Developer Help

If you need any help with the documentation and sandbox environment, please email merchops@finaccel.co and we will respond as soon as possible.

If you do not have a merchant account, please email merchops@finaccel.co to get setup with one.

Developer FAQ

1. Does Kredivo work on desktop and mobile? Yes, desktop, mobile, and tablet web.
2. I am not a retailer but I want to offer Kredivo financial products in my site/app do you have an API for that? See previous answer. If you are interested in using Kredivo for your site/app, email us at merchops@finaccel.co
3. Is Kredivo another payment processor? No. Kredivo is a point of sale credit solution for your customers.

2-click Checkout

This is the most basic checkout feature suitable for either a web based platform or app based platform. Here is the API structure:

First, you will need to call the checkout API by passing all the required parameters. If successful, you will receive a redirect URL as a response. This URL will redirect the user to Kredivo payment page. There are at least 3 components that are required to obtain the payment page:

• server_key

You will need a server_key to interact with the Kredivo server. Please send an email to merchops@finaccel.co to sign up as an Kredivo merchant and get the server_key.

• Order Id
• Transaction Amount

Initiate 2-click Checkout

To initiate 2-click checkout with Kredivo, you will need to call checkout/init API.

Using the API: POST /checkout/init

The Request JSON structured like this:

{
  "server_key": "MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
  "tenure": 1,
  "amount": 6505000,
  "order_id": "KD14721",
  "source": "ecom",
  "items": [
    {
      "id": "BB12345678",
      "name": "iPhone 5S",
      "price": 6000000,
      "type": "Smartphone",
      "url": "http://merchant.com/cellphones/iphone5s_64g",
      "quantity": 1
    },
    {
      "id": "AZ14565678",
      "name": "Hailee Sneakers Blink Silver",
      "price": 250000,
      "url": "http://merchant.com/fashion/shoes/sneakers-blink-shoes",
      "type": "Sneakers",
      "quantity": 2
    },
    {
      "id": "taxfee",
      "name": "Tax Fee",
      "price": 1000,
      "quantity": 1
    },
    {
      "id": "shippingfee",
      "name": "Shipping Fee",
      "price": 9000,
      "quantity": 1,
      "parent_type": "SELLER",
      "parent_id": "SELLER456"
    },
    {
      "id": "discount",
      "name": "Discount",
      "price": 5000,
      "quantity": 1
    }
  ],
  "sellers": [
    {
      "id": "SELLER123",
      "name": "Sunrise",
      "email": "sunrise@gmail.com",
      "url": "https://onlineshop/seller/sunrise",
      "mobile_number": "+84-123456789",
      "address_detail": {
        "name": "Ngo Thuy Duong",
        "address": "180 Bui Thi Xuan",
        "province": "ho chi minh",
        "district": "Phu Nhuan",
        "ward": "3"
      }
    },
    {
      "id": "SELLER456",
      "name": "Sunshine",
      "email": "sunshine@gmail.com",
      "url": "https://onlineshop/seller/sunshine",
      "mobile_number": "+84-987654321",
      "address_detail": {
        "name": "Ngo Anh Tuan ",
        "address": "180 Ly Tu Trong",
        "province": "ho chi minh",
        "district": "Phu Nhuan",
        "ward": "Vo Thi Sau"
      }
    }
  ],
  "buyers": [
    {
      "name": "Nguyen Van Long",
      "email": "long123@gmail.com",
      "mobile_number": "+84-983123456"
    }
  ],
  "shipping_addresses": [
    {
      "name": "Nguyen Van Long",
      "address": "100 Nguyen Tu Luc",
      "province": "Ho Chi Minh",
      "district": "Tan Binh",
      "ward": "5",
      "mobile_number": "+84-983123456"
    }
  ],
  "push_url": "https://pushurlofmerchant.com",
  "back_to_store_url": "https://successtransaction.com",
  "cancel_url": "https://cancel.com",
  "ip_address": "123.23.24.11",
  "user_agent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36",
  "device_id": "samsung"
}

The Response returns JSON structured like this:

Positive Response :
{
    "status": 1,
    "message": "Success",
    "checkout_url": "https://pay-vn-sandbox.kredivo.com/signIn?tk=c94c431-ab34-1234",
    "transaction_id": "c01ec51e-9322-4545-aba5-c0f5eae671fc"
}

Negative response:
{
    "status": 2012,
    "message": "Invalid Merchant"
}

Request Body

Response

Items

Sellers

Buyers

Address

HTTP(S) Header

Confirm Transaction

In this tutorial you will learn how to confirm that you have received and created an order in your system. This confirmation is needed in response to a push notification from Kredivo, indicating that the user has completed the transaction. Once you have received the push notification, you should update the status of the transaction.

1. Receive notification from Kredivo

Once a consumer has completed a purchase, Kredivo will inform you via a POST request. The POST request will be made to the push notification URI you provided when you created the checkout order.

HTTP Notification example of transaction::

{
  "amount": "1000000.0",
  "discount_amount": "200000.0",
  "disbursed_amount": "800000.0",
  "tenure": 1,
  "trx_status": "pending",
  "order_id": "KD125262",
  "transaction_time": 1501846094,
  "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
  "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpH",
  "message": "pending merchant’s confirmation",
  "voucher_code": "PROMO123"
}

Response Body

2. Merchant Response

merchant response should be in JSON, structured like this:

{
  "status": "OK",
  "message": "Message from merchant if any"
}

3. Confirm the order status

Once you receive a push notification from Kredivo with trx_status "pending", that means Kredivo has already approved the transaction. You need to call Update API to Confirm and Approve the transaction.

Using the API: POST /checkout/update

The Request JSON structured like this:

{
  "signature_key": "Lrgsmk09S0f8biAf/bYGrfDXJXvk7ftLMZ3L1b4o7+4LxARUGA9e1wsA64OTE33eiV7ULiOv/ZPy4SJ7TDT9ugxECGLtuMF65cmZyLLkaLY=",
  "transaction_id": "9ce1596f-bd4e-4fa2-b49f-3537de3f4128",
  "status": "settled"
}

Example response after call API update:

{
  "status": "settlement",
  "message": "Success",
  "tenure": 1,
  "transaction_time": 1645289475,
  "order_id": "B21145",
  "amount": "4000000.0",
  "discount_amount": "300000.0",
  "disbursed_amount": "2100000.0",
  "user_token": null
}

Request Body

Response

4. Settle an order in your system

You should now settle the order in your system if transaction*status from the response is _SETTLED*.

0-click Checkout

0-click Checkout is a feature that allows Kredivo users to tokenize their Kredivo account inside the merchant's platform. A tokenized user will then be able enjoy our express checkout feature. Whereas our regular checkout requires the user to enter his/her phone number, PIN, and OTP to confirm the transaction, the 0-click Checkout will essentially allow the user to checkout without entering anything. In the case where our security system flags a transaction as suspicious, we will throw an OTP challenge to the user. Here is the API structure:

0-click Checkout is a great leap forward even when compared to our already smooth 2-click regular checkout. It is the smoothest checkout process in the market today, giving unparalleled user experience.

This feature is only available for select merchants. Contact us if you're interested in using this feature.

Initiate 0-click Checkout

This step will show you how you can tokenize the user through our regular checkout page. If you are interested in tokenizing the user separately from the transaction, read the Tokenize Kredivo Account guide below.

The first time you call this API, you will need to pass the parameter tokenizer_user as true to enable tokenization. If that transaction is successful, you will get a user_token in our response. Any subsequent transaction will now become 0-click once you start passing this user_token.

To initiate 0-click Checkout with Kredivo, you will need to call checkout/init API.

Using the API: POST /checkout/init

The Request JSON structured like this:

{
  "server_key": "MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
  "tenure": 1,
  "client_user_key": "useremail@gmail.com",
  "user_token": "XXXX-XXXX",
  "amount": 6505000,
  "order_id": "KD14721",
  "source": "ecom",
  "items": [
    {
      "id": "BB12345678",
      "name": "iPhone 5S",
      "price": 6000000,
      "type": "Smartphone",
      "url": "http://merchant.com/cellphones/iphone5s_64g",
      "quantity": 1
    },
    {
      "id": "AZ14565678",
      "name": "Hailee Sneakers Blink Silver",
      "price": 250000,
      "url": "http://merchant.com/fashion/shoes/sneakers-blink-shoes",
      "type": "Sneakers",
      "quantity": 2
    },
    {
      "id": "taxfee",
      "name": "Tax Fee",
      "price": 1000,
      "quantity": 1
    },
    {
      "id": "shippingfee",
      "name": "Shipping Fee",
      "price": 9000,
      "quantity": 1,
      "parent_type": "SELLER",
      "parent_id": "SELLER456"
    },
    {
      "id": "discount",
      "name": "Discount",
      "price": 5000,
      "quantity": 1
    }
  ],
  "sellers": [
    {
      "id": "SELLER123",
      "name": "Sunrise",
      "email": "sunrise@gmail.com",
      "url": "https://onlineshop/seller/sunrise",
      "mobile_number": "+84-123456789",
      "address_detail": {
        "name": "Ngo Thuy Duong",
        "address": "180 Bui Thi Xuan",
        "province": "ho chi minh",
        "district": "Phu Nhuan",
        "ward": "3"
      }
    },
    {
      "id": "SELLER456",
      "name": "Sunshine",
      "email": "sunshine@gmail.com",
      "url": "https://onlineshop/seller/sunshine",
      "mobile_number": "+84-987654321",
      "address_detail": {
        "name": "Ngo Anh Tuan ",
        "address": "180 Ly Tu Trong",
        "province": "ho chi minh",
        "district": "Phu Nhuan",
        "ward": "Vo Thi Sau"
      }
    }
  ],
  "buyers": [
    {
      "name": "Nguyen Van Long",
      "email": "long123@gmail.com",
      "mobile_number": "+84-983123456"
    }
  ],
  "shipping_addresses": [
    {
      "name": "Nguyen Van Long",
      "address": "100 Nguyen Tu Luc",
      "province": "Ho Chi Minh",
      "district": "Tan Binh",
      "ward": "5",
      "mobile_number": "+84-983123456"
    }
  ],
  "push_url": "https://pushurlofmerchant.com",
  "back_to_store_url": "https://successtransaction.com",
  "cancel_url": "https://cancel.com",
  "ip_address": "123.23.24.11",
  "user_agent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36",
  "device_id": "samsung"
}

The Response returns JSON structured like this:

Positive Response (Code 2007 indicate transaction valid for tokenization):
{
    "status": 1,
    "message": "This transaction is ready for tokenization",
    "checkout_url": "https://pay-vn-staging.kredivo.com/signIn?tk=30ce9850-db4d-4742-9f12-e2a32a03bb5",
    "transaction_id": "30ce9850-db4d-4742-9f12-e2a22ad03bb5",
    "code": 2007
}

Neutral Response (Transaction not valid for tokenization, but the user can still check out with 2-click checkout link):
{
    "status": 1,
    "message": "Success",
    "checkout_url": "https://pay-vn-staging.kredivo.com/signIn?tk=e8c186c6-9221-4175-a6-4745783c",
    "transaction_id": "e8c186c6-9221-4175-a4b6-4745bb783c"
}

Negative response:
{
    "status": 2012,
    "message": "Invalid Merchant"
}

Request Body

Response

Product Item

Buyers

Address

Sellers

HTTP(S) Header

Confirm Transaction

In this tutorial you will learn how to confirm that you have received and created an order in your system. This confirmation is needed in response to a push notification from Kredivo, indicating that the user has completed the transaction. Once you have received the push notification, you should update the status of the transaction.

1. Receive notification from Kredivo

Once a consumer has completed a purchase, Kredivo will inform you via a POST request. The POST request will be made to the push notification URI you provided when you created the checkout order.

HTTP Notification example of transaction:

{
  "amount": "1000000.0",
  "discount_amount": "200000.0",
  "disbursed_amount": "800000.0",
  "tenure": 1,
  "trx_status": "pending",
  "order_id": "KD125262",
  "transaction_time": 1501846094,
  "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
  "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpH",
  "message": "pending merchant’s confirmation",
  "voucher_code": "PROMO123"
}

Response Body

2. Merchant Response

merchant response should be in JSON, structured like this:

{
  "status": "OK",
  "message": "Message from merchant if any"
}

3. Confirm the order status

Once you receive a push notification from Kredivo with trx_status "pending", that means Kredivo has already approved the transaction. You need to call Update API to Confirm and Approve the transaction.

Using the API: POST /checkout/update

The Request JSON structured like this:

{
  "signature_key": "Lrgsmk09S0f8biAf/bYGrfDXJXvk7ftLMZ3L1b4o7+4LxARUGA9e1wsA64OTE33eiV7ULiOv/ZPy4SJ7TDT9ugxECGLtuMF65cmZyLLkaLY=",
  "transaction_id": "9ce1596f-bd4e-4fa2-b49f-3537de3f4128",
  "status": "settled"
}

Example response after call API update:

{
  "status": "settlement",
  "message": "Success",
  "tenure": 1,
  "transaction_time": 1645289475,
  "order_id": "B21145",
  "amount": "4000000.0",
  "discount_amount": "300000.0",
  "disbursed_amount": "2100000.0",
  "user_token": "XXXX-XXXX"
}

Request Body

Response

4. Settle an order in your system

You should now settle the order in your system if transaction*status from the response is _SETTLED*.

Get User Credit Details

Once the user is tokenized, you can then call this API to know about the remaining limit, account status, and account type of the user. You will need the user token to call this API.

Using the API: POST /get_credit_details

The Request JSON structured like this:

{
  "server_key": "ABCD-XXXX-1234",
  "user_token": "XXXX-YYYY"
}

Request Body

Response

{
  "status": 1,
  "message": "Success",
  "limit": {
    "1": 3449094,
    "3": 9618221,
    "6": 18305674,
    "12": 23500000
  }
}

Negative response JSON should be structured like this:

{
  "status": 2012,
  "message": "Invalid Merchant"
}

Success Response

Limit

Error Response

Tokenize Kredivo Account

We highly recommend tokenizing the users along with the transaction using the 0 click check out flow (reference to Initiate 0-click Checkout).

This will result in a higher tokenization and transaction rate. However, if you wish to tokenize the user separately from the transaction, you can use this API instead to tokenize the user. A push notification will be sent to your callback url with the user_token.

To tokenizing the user with Kredivo, you will need to call user/tokenize/init API.

Using the API: POST /user/tokenize/init

The Request JSON structured like this:

{
  "client_user_key": "6d0a32af-60c0-492d-bbe0-55e48118a296",
  "server_key": "85c1c3086f8d448682ff5ff98149b271",
  "callback_url": "https://api-merchant.io/tokenize/callback",
  "back_to_store_url": "https://api-merchant.io/user/tokenize",
  "signature_key": "3fb0eb199aa5c747c43f36319896af83a03277a7"
}

The Response JSON structured like this:

Positive Response
{
  "status": 1,
  "message": "success",
  "tokenize_url": "https://pay-vn.kredivo.com/signIn?cid=6d0a32af-60c0-492d-bbe0-55e48118a296"
}

Negative Response (Invalid server_key):
{
  "status": 2012,
  "message": "Invalid Merchant"
}

Negative Response (Client_user_key and user_token already exists and status of Tokenization is Active):
{
  "status": 2009,
  "message": "Sorry, There's a conflict in tokenization request"
}

Negative Response (Invalid signature_key):
{
  "status": 2030,
  "message": "Invalid Signature Key"
}

Request Body

Success Response Body

Failed Response Body

Push Notif

Once Kredivo has received and processed the tokenization request from the users, we will send a push notification to your callback url to notify the result.

The Success Request JSON structured like this:

{
  "client_user_key": "6d0a32af-60c0-492d-bbe0-55e48118a296",
  "user_token": "eaeb2c20-8321-4e4f-9344-21c06dbe27ef",
  "status": "success",
  "message": "Tokenization Success"
}

The Failed Request JSON structured like this:

{
  "client_user_key": "6d0a32af-60c0-492d-bbe0-55e48118a296",
  "status": "failed",
  "message": "Wallet is inactive"
}

Push Notif Request Body

Kredivo expect Merchants should accept this request in their callback_url

Push Notif Response Body

It's expected for merchant to send below response when merchant server already received the notification from Kredivo server.

Offline Checkout

This is the offline checkout feature suitable for app based platform.

First, you will need to call the checkout API by passing all the required parameters. If successful, the user will have a button to checkout the order. There are at least 3 components that are required to obtain the checkout page:

• Server Key

You will need a server_key to interact with the Kredivo server. Please send an email to merchops@finaccel.co to sign up as an Kredivo merchant and get the server_key.

• Order Id
• Transaction Amount
• Dealer Code

You will need a dealer_code,a submerchant unique ID to initiate an offline checkout. Please send an email to merchops@finaccel.co to add submerchants to your group and get the dealer code.

Initiate Offline Checkout

To initiate offline checkout with Kredivo, you will need to call checkout/init API.

Using the API: POST /checkout/init

The Request JSON structured like this:

{
  "server_key": "MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
  "dealer_code": "SF241290",
  "tenure": 1,
  "expiry_time": 1708489655,
  "amount": 1400000,
  "source": "offline",
  "order_id": "KD14723",
  "items": [
    {
      "id": "items",
      "name": "Xiaomi pocophone",
      "price": 1500000,
      "type": "Smartphone",
      "quantity": 1,
      "url": "https://tokopedia.com/barang/anu"
    },
    {
      "id": "downpayment_SKU",
      "name": "Down Payment",
      "price": 200000,
      "quantity": 1
    },
    {
      "id": "item_001",
      "name": "Xiaomi pocophone",
      "price": 100000,
      "type": "Smartphone",
      "quantity": 1,
      "url": "https://tokopedia.com/barang/anu"
    }
  ],
  "buyers": [
    {
      "name": "Pete Hamill",
      "email": "Morton3@gmail.com",
      "mobile_number": "+84-987668348"
    }
  ],
  "push_url": "https://api-staging-vn.kredivo.com/healthcheck",
  "back_to_store_url": " https://api-staging-vn.kredivo.com",
  "metadata": {}
}

The Response returns JSON structured like this:

Positive Response :
{
    "status": 1,
    "message": "Success",
    "transaction_id": "e54af0b0-ee15-4267-8536-ccb8a9f21ab5",
    "qr_link": "https://finaccel-api-vietnam-staging.s3.amazonaws.com/offline_transaction/documents/qr_image/offline_qr_99713.png"
}

Negative Responses:
Code 2012 - Invalid server key:
- Ensure that server key is the same as given by our team.
{
    "status": 2012,
    "message": "Invalid Merchant"
}

Negative Response
Code 1002 - Invalid Request:
- Ensure that dealer code is registered
- Ensure that expiry time is greater than current time.
- Ensure that the amount is above the minimum required amount.
{
    "status": 1002,
    "message": "Bad request, please check your request."
}

Request Body

Response

Items

Buyers

HTTP(S) Header

Confirm Transaction

In this tutorial you will learn how to confirm that you have received and created an order in your system. This confirmation is needed in response to a push notification from Kredivo, indicating that the user has completed the transaction. Once you have received the push notification, you should update the status of the transaction.

1. Receive notification from Kredivo

Once a consumer has completed a purchase, Kredivo will inform you via a POST request. The POST request will be made to the push notification URI you provided when you created the checkout order.

HTTP Notification example of transaction::

{
  "amount": "1200000.0",
  "discount_amount": "200000.0",
  "disbursed_amount": "800000.0",
  "total_downpayment": "200000.0",
  "tenure": 1,
  "trx_status": "pending",
  "order_id": "KD125262",
  "transaction_time": 1501846094,
  "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
  "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpH",
  "message": "pending merchant’s confirmation",
  "metadata": {},
  "voucher_code": "PROMO123"
}

Response Body

2. Merchant Response

merchant response should be in JSON, structured like this:

{
  "status": "OK",
  "message": "Message from merchant if any"
}

3. Confirm the order status

Once you receive a push notification from Kredivo with trx_status "pending", that means Kredivo has already approved the transaction. You need to call Update API to Confirm and Approve the transaction.

Using the API: POST /checkout/update

The Request JSON structured like this:

{
  "signature_key": "Lrgsmk09S0f8biAf/bYGrfDXJXvk7ftLMZ3L1b4o7+4LxARUGA9e1wsA64OTE33eiV7ULiOv/ZPy4SJ7TDT9ugxECGLtuMF65cmZyLLkaLY=",
  "transaction_id": "9ce1596f-bd4e-4fa2-b49f-3537de3f4128",
  "status": "settled"
}

Example response after call API update:

{
  "status": "settlement",
  "message": "Success",
  "tenure": 1,
  "transaction_time": 1645289475,
  "order_id": "KD125262",
  "amount": "4000000.0",
  "discount_amount": "300000.0",
  "disbursed_amount": "2100000.0",
  "user_token": null
}

Request Body

Response

4. Settle an order in your system

You should now settle the order in your system if transaction*status from the response is _SETTLED*.

Aborting an order (Offline Transaction Only)

If you want to abort an order, you can call the following API. Note that abort is only for PRE settlement, please use cancellation API once it reached SETTLED status.

Using the API: POST checkout/<transaction_id>/abort

The Request JSON structured like this:

{
  "server_key": "MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
  "dealer_code": "STORE123123",
  "order_id": "KD125262"
}

Example response after call API update:

{
  "transaction_id": "9ce1596f-bd4e-4fa2-b49f-3537de3f4128"
}

Request Body

Response

Additional APIs

You will find other APIs here that will help you check the transaction status (in case our push notification failed), cancel the transaction, and calculate the interest and payment.

Check Transaction Status

Once your customer is done processing the transaction on their side, you will need to call check transaction status API.

Using the API: POST /transaction/status

The Request JSON structured like this:

{
  "server_key": "8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7",
  "transaction_id": "7401e873-ea77-455e-9f31-4ca2268304dc"
}

Response:

{
  "status": 1,
  "message": "Success",
  "order_id": "K12345",
  "checkout_amount": 4000000.0,
  "tenure": 1,
  "items": [
    {
      "name": "Máy lọc không khí",
      "unit_price": "1900000.0",
      "total_amount": "3800000.0",
      "quantity": 2,
      "sku": "items",
      "sku_type": 0,
      "category": "Smartphone1"
    },
    {
      "name": "Shipping_Fee",
      "unit_price": "200000.0",
      "total_amount": "200000.0",
      "quantity": 1,
      "sku": "shipping_fee",
      "sku_type": 1,
      "category": null
    },
    {
      "name": "Platform Fee",
      "unit_price": "40000.0",
      "total_amount": "40000.0",
      "quantity": 1,
      "sku": "platform_fee",
      "sku_type": 2,
      "category": "Fees"
    }
  ],
  "trx_status": "settlement"
}

Request Body

Response Body

Cancel Transaction

Transaction can be cancelled with this API if transaction has been completed.

Using the API: POST /transaction/cancel

The Request JSON structured like this:

{
  "transaction_id": "7ab07794-8ccf-4406-bd52-91bf6b7e7c03",
  "server_key": "merchant_server_key",
  "reason": "Out of stock",
  "cancelled_by": "merchant_name",
  "amount": 90500,
  "order_id": "KB-3dfa4b15"
}

Request Body

Response:

 Positive Response :

{
    "status": 1,
    "message": "API cancel received"
}

 Negative Response:

{
    "status": 2011,
    "message": "Field amount is negative."
}

Response Body

Kredivo Loan Calculator

This API will give you the breakdown of the monthly payment of Kredivo installment.

Using the API: POST /loan/calculator

The Request JSON structured like this:

{
  "tenure": 1,
  "amount": 1000000,
  "source": "ecom",
  "server_key": "kredivovietnamECOM123"
}

Request Body

Example Response:

{
  "status": 1,
  "message": "Success",
  "1": {
    "interest_rate": "0%",
    "interest_amount": 0,
    "monthly_installment": 1000000,
    "processing_fee": 10000,
    "processing_fee_rate": "1.0%",
    "initial_amount": 1000000,
    "total_amount": 1000000,
    "payback_amount": 1010000
  }
}

Response Body

API Error Code

API Init/Checkout response error code

API Confirm Transaction response error code

API Cancel Transaction response error code

API Abort Transaction (Offline Transaction Only) response error code

API User Tokenization response error code

Branding & Visual

Logos

Using Kredivo's logotype generates trust and increases your conversion.

Your website's background

Depending on if you have dark or light background you can get either a blue or white logo.

Width

We recommend that the Kredivo logo displayed at your site is between 100-300 px. Note that you should not add px after the size parameter.

Example:

Download Kredivo logo here.

How to use the Kredivo logo

On your frontpage

When showing the different payment alternatives you offer in your store, display our one and only logo. When hovering over the logo shows details on the payment methods available in your store.

On product level

You will increase the conversion for high value products by showing your consumers that they have the ability to pay in installments. Always use our logotype on product level. The logotype is highly recognisable, even in small sizes. For optimal conversion use our payment method widget.

Marketing Resource

What is Merchant Success?

Kredivo team is here to work together with you to identify and solve problems, support and build a long-term mutual relationship, as well as create collaborative campaigns to increase your revenue.

Our product is your "Sales Enabler", meaning that Kredivo helps your customer to buy more and more often. In order to see significant results of our product, we strongly encourage you to implement merchant best practice

Why is this important to implement Merchant Best Practices?

1. Incremental sales takes time and effort. Acquiring customer that is loyal require time and effort. Kredivo is here to facilitate the process through Merchant Best Practice.

2. Education is crucial. Instant credit financing is not a familiar concept with many consumers. It is important for merchant to educate and create a good consumer flow within the platform.

3. Sales enabler engine. "Buy now pay later" and "Installment without credit card" is a very strong message for consumers, allowing them to buy more and more often. Sharing this messages within the platform clearly will help increase sales.

Important Information

1. Please send all Kredivo related collateral (newsletter, product promotion, social media posting, banner, FAQ) to successops@finaccel.co prior to posting for approval.
2. For any merchant related inquiries on customer service and payment information please send it to merchant.help@kredivo.com. (Note: this is for merchant related inquiries not consumers related inquiries, in any circumstances this email shall not be given to consumers).
3. For any consumer related inquiries on our product, technical and payment please let the consumer send these inquiries to support.vn@kredivo.com or call at +84-1900-2525-42 (Note: Merchant is able to relay this email and phone number to consumers)

Other Marketing Resources

• Merchant Best Practice
• Consumer FAQ

Environment Setup

Sandbox

Use credentials below to integrate with our sandbox server.

Production

Use credentials below to integrate with our production server. Only transaction comes to this server will be processed by our server.