Getting Started

Introduction

Simplifying buying

Use the Kredivo Checkout API to let Kredivo users pay on your web or app platform.

The checkout API is one API with several variants. Each variant fits a specific use case and differs only in the parameters you pass:

Online checkout (web and app):

• 2-click checkout — the Kredivo user enters their Kredivo phone number and PIN, then an OTP, to complete the transaction.
• 0-click checkout — the Kredivo user tokenizes their Kredivo account on your platform. Later transactions don’t require Kredivo credentials (an OTP may still be required in some cases).

Offline checkout (in-store):

• QR checkout — for offline (in-store) transactions. Uses a dynamic QR code generated for each transaction.
• Barcode checkout — for offline (in-store) transactions. The Kredivo user shows a barcode in the Kredivo app, and you scan it to request the purchase.
• EDC checkout — for offline (in-store) transactions. The Kredivo user pays in your physical store through an EDC terminal.

Preparation

Prepare your site

Set up the following before you start integrating, so the integration goes quickly.

Checkout page and confirmation page

You host both the checkout page and the checkout confirmation page. Each page must include a div that you populate with the Kredivo Checkout button. See 2-Click Checkout to learn how the checkout works. Kredivo Checkout is responsive and always uses the full width of its container.

What customers see

Kredivo Checkout adapts to the customer’s device. The login step looks like this on mobile and desktop browsers:

• Phone number and PIN login – customers sign in with their +62 phone number and Kredivo PIN.
• Optional account linking – a toggle links the Kredivo account to your store for faster future payments.
• Continue in the Kredivo app – customers can scan a code to finish in the app instead.
• Sign-up link – new customers can register without leaving checkout.
• Desktop extras – the wider layout also shows an order summary (merchant and total) and promotions.

Push notification URI

Kredivo sends the order status to your push notification URI (see Confirm Transaction). Include a placeholder in the push URI; Kredivo replaces it with the order URI when it sends the push notification. Download an example push URI.

Developer Help

For help with the documentation or the sandbox environment, email merchops@finaccel.co.

To get a merchant account, sign up as a Kredivo merchant.

Developer FAQ

1. Does Kredivo work on desktop and mobile? Yes. Kredivo works on desktop, mobile, and tablet web.
2. I am not a retailer, but I want to offer Kredivo financial products on my site or app. Do you have an API for that? If you are interested in using Kredivo for your site/app, sign up at kredivo.id/jadi-partner.html.
3. Is Kredivo another payment processor? No. Kredivo is a point-of-sale credit solution for your customers.

Online Checkout

Online checkout is for web and app platforms, where the Kredivo user pays on your platform.

• 2-Click Checkout — the user logs in with phone number, PIN, and OTP for each transaction.
• Account Linking — the user links their Kredivo account to your platform once, before any transaction, and you receive a user_token.
• 0-Click Checkout — the user tokenizes their Kredivo account once; later transactions skip Kredivo credentials.

2-Click Checkout

2-click checkout is the standard Kredivo checkout for web and app platforms. Use it when the Kredivo user should log in with their phone number, PIN, and OTP for each transaction.

The flow:

1. Call the checkout API with all required parameters.
2. On success, the response contains a redirect_url.
3. Redirect the Kredivo user to redirect_url to open the Kredivo payment page.

You need at least these three values to get a payment page:

• server_key — authenticates you with the Kredivo server. To get a server_key, sign up as a Kredivo merchant.
• order_id
• Transaction amount (amount)

Initiate 2-Click Checkout

Call checkout_url to create a 2-click checkout and get the payment page URL.

HTTP request

POST /kredivo/v2/checkout_url

Example request:

{
    "server_key":"MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
    "payment_type":"30_days",
    "client_user_key": "yospe@finaccel.co",
    "transaction_details": {
        "amount":6505000,
        "order_id":"KD14721",
        "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,
                "parent_type":"SELLER",
                "parent_id":"SELLER456"
            },
            {
                "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",
            "address" : {
                "first_name":"Irfan",
                "last_name":"Sutandro",
                "address":"Jalan Tentara Pelajar no 49",
                "city":"Jakarta Utara",
                "postal_code":"12960",
                "phone":"08123456789",
                "country_code":"IDN"
            }
        },
        {
            "id":"SELLER456",
            "name":"Toko Bagus",
            "email": "tokobagus@gmail.com",
            "url":"https://onlineshop/seller/tokobagus",
            "address" : {
                "first_name":"Toto",
                "last_name":"Wahyuni",
                "address":"Jalan Krinci raya IX no 1",
                "city":"Jakarta Selatan",
                "postal_code":"12960",
                "phone":"08123456789",
                "country_code":"IDN"
            }
        }
    ],
    "customer_details": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "email":"alie@satuduatiga.com",
        "phone":"081513114262"
    },
    "billing_address": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "address":"Jalan Teknologi Indonesia No. 25",
        "city":"Jakarta",
        "postal_code":"12960",
        "phone":"081513114262",
        "country_code":"IDN"
    },
    "shipping_address": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "address":"Jalan Teknologi Indonesia No. 25",
        "city":"Jakarta",
        "postal_code":"12960",
        "phone":"081513114262",
        "country_code":"IDN"
    },
    "metadata": {
        "ip_address":"192.168.88.1",
        "user_agent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
    },
    "push_uri":"https://api.merchant.com/push",
    "back_to_store_uri":"https://merchant.com"
}

Example response:

  Positive Response :

  {
    "status":"OK",
    "message":"Message if any",
    "redirect_url":"https://staging.kredivo.com/kredivo/v2/signin?tk=XXX"
  }

  Negative Response:

  {
    "status": "ERROR",
    "error": {
        "message": "Field secret_key is INCORRECT.",
        "kind": "APIException"
    }
  }

  and

  {
    "error": {
        "kind": "deprecated",
        "message": "This order is already PROCESSED.",
        "code": null
    },
    "status": "ERROR"
}

Request body

Response

Transaction

Product item

Customer

Address

Seller

Metadata

HTTP(S) header

Confirm Transaction

After the Kredivo user completes a transaction, Kredivo sends you a push notification. Follow these steps to acknowledge it, verify it, and update the order in your system.

1. Receive notification from Kredivo

When the Kredivo user completes a purchase, Kredivo sends a POST request to the push_uri you provided when you created the checkout.

Example push notification:

{
    "status": "OK",
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "pending",
    "order_id": "KD125262",
    "message": "Transaction status is pending",
    "shipping_address": {
        "city": "Jakarta Selatan",
        "first_name": "Darana 2",
        "last_name": "Pratama",
        "countrycode": "IDN",
        "creation_date": "2017-08-04T18:28:14",
        "phone": "0217248724",
        "state": "",
        "transaction": 1505866,
        "postcode": "12120",
        "location_details": "Jl. Kerinci IX No. 5-A"
    },
    "transaction_time": 1501846094,
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpHx0uuHETBVpxfYLbaPyS8RJg34uVxTUX64cfUTzVVhCrSif%2FUg92J2WyLs%2FhQ%3D"
}

Push notification body

Response address info

2. Acknowledge the push notification

Respond with JSON structured like this:

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

3. Confirm the order status

Call update to get the order status and verify that the push notification came from Kredivo.

2-click confirm: HTTP request

GET /kredivo/v2/update?transaction_id=bb0380d7-2688-4e73-a668-997f3fc5cbec&signature_key=5f1fa4a524f5a8201a3a373d67b5796840bed1598b2bb816855d0e14d01cd09b988b4b861f39bed642b4db861108bbf0dd84ce8e17caf675d4bf2c81ab545397

2-click confirm: Request body

Response body

Example response from v2/update:

{
    "status": "OK",
    "legal_name": "TANDRA",
    "fraud_status": "accept",
    "order_id": "KD125262",
    "transaction_time": 1501846094,
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "settlement",
    "message": "Confirmed order status. Valid!",
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8"
}

4. Settle an order in your system

If transaction_status is settlement, settle the order in your system and store the order data you need.

Account Linking

Account linking lets a Kredivo user connect (bind) their Kredivo account to their account on your platform, usually before any transaction, without making a purchase.

When linking succeeds, Kredivo sends you a user_token for that user. Store it: it lets you access Kredivo services for the user with their consent, for example Get User Credit Details or 0-click checkout.

The flow:

1. The user chooses to connect their Kredivo account on your platform.
2. Call the account linking API. On success, the response contains a redirect_url to the Kredivo linking page.
3. Redirect the user to redirect_url. The user enters their Kredivo phone number and PIN, then verifies with an OTP if Kredivo’s risk check requires it.
4. Kredivo approves the linking and sends a push notification with the user_token to your callback_url.
5. Kredivo redirects the user back to the redirect_url you sent in the request.

Link Account

Call connect to start account linking and get the Kredivo linking page URL.

Link account: HTTP request

POST /kredivo/v2/connect

Example account linking request:

{
    "server_key": "MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
    "mobile_number": "+62-81381140446",
    "client_user_key": "test01@gmail.co",
    "callback_url": "https://merchant.example/kredivo/linking-callback",
    "redirect_url": "https://merchant.example"
}

Link account: Request body

Example account linking success response:

{
    "status": "OK",
    "message": "",
    "redirect_url": "https://staging.kredivo.com/kredivo/v2/connect?tk=XXX"
}

Example account linking error response:

{
    "error": {
        "message": "Invalid merchant",
        "kind": "deprecated",
        "code": 2403
    },
    "status": "ERROR"
}

Link account: Response

Receive Linking Notification

You must provide this endpoint. When the user completes linking, Kredivo sends a POST request to the callback_url you sent in the linking request.

Link account: Callback request

POST {callback_url}

Example account linking callback from Kredivo:

{
    "message": "Kredivo-Connect success",
    "user_token": "e157ae57-ea5f-4acc-b7e6-11cac8c865f3",
    "client_user_key": "test01@gmail.co",
    "status": "OK"
}

Example account linking callback error:

{
    "message": "Invalid merchant",
    "user_token": "",
    "client_user_key": "test01@gmail.co",
    "status": "2403"
}

Link account: Callback body

Unlink Account

To unlink (unbind) a user, call POST /kredivo/v2/deactive_user_token with your server_key and the user’s user_token. When status is OK, the detokenization succeeded and you must invalidate the user_token on your side.

Example account unlinking success response:

{
    "status": "OK",
    "message": "",
    "remarks": "081513114262|Deactivated by merchant",
    "user_token": "9cc7f862-d4ac-49d2-88d6-050858bee3fd",
    "is_active": false
}

Users can also disconnect from the Kredivo app. Kredivo then sends a push notification with the client_user_key to the callback_url you provided during account linking, and you must invalidate that user’s user_token. See Deactivate from Kredivo app.

0-Click Checkout

0-click checkout lets a Kredivo user tokenize their Kredivo account on your platform and then check out without entering anything. Use it for returning users. Regular (2-click) checkout asks for phone number, PIN, and OTP; 0-click asks for nothing, unless our security system flags the transaction, in which case the Kredivo user gets an OTP challenge.

The flow:

Initiate 0-Click Checkout

Tokenize the Kredivo user through the regular checkout page by calling checkout_url.

1. On the first call, set tokenize_user to true.
2. When that transaction succeeds, you receive a user_token.
3. Pass user_token in later calls. Those transactions are 0-click.

You can also get a user_token without a transaction through Account Linking. Before showing Kredivo on your payment page, you can call Get User Credit Details to show the user’s eligible limit.

0-click: HTTP request

POST /kredivo/v2/checkout_url

Example request:

{
    "server_key":"MEJ4FLRc74UU64cxCF8Z3HYSpPctD7",
    "payment_type":"30_days",
    "tokenize_user": false,
    "client_user_key": "yospe@finaccel.co",
    "user_token" : "XXXX-XXXX",
    "transaction_details": {
        "amount":6505000,
        "order_id":"KD14721",
        "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,
                "parent_type":"SELLER",
                "parent_id":"SELLER456"
            },
            {
                "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",
            "address" : {
                "first_name":"Irfan",
                "last_name":"Sutandro",
                "address":"Jalan Tentara Pelajar no 49",
                "city":"Jakarta Utara",
                "postal_code":"12960",
                "phone":"08123456789",
                "country_code":"IDN"
            }
        },
        {
            "id":"SELLER456",
            "name":"Toko Bagus",
            "email": "tokobagus@gmail.com",
            "url":"https://onlineshop/seller/tokobagus",
            "address" : {
                "first_name":"Toto",
                "last_name":"Wahyuni",
                "address":"Jalan Krici raya IX",
                "city":"Jakarta Selatan",
                "postal_code":"12960",
                "phone":"08123456789",
                "country_code":"IDN"
            }
        }
    ],
    "customer_details": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "email":"alie@satuduatiga.com",
        "phone":"081513114262"
    },
    "billing_address": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "address":"Jalan Teknologi Indonesia No. 25",
        "city":"Jakarta",
        "postal_code":"12960",
        "phone":"081513114262",
        "country_code":"IDN"
    },
    "shipping_address": {
        "first_name":"Oemang",
        "last_name":"Tandra",
        "address":"Jalan Teknologi Indonesia No. 25",
        "city":"Jakarta",
        "postal_code":"12960",
        "phone":"081513114262",
        "country_code":"IDN"
    },
    "metadata": {
        "ip_address":"192.168.88.1",
        "user_agent":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"
    },
    "push_uri":"https://api.merchant.com/push",
    "back_to_store_uri":"https://merchant.com"
}

Example response:

  Positive Response :

  {
    "status":"OK",
    "message":"Message if any",
    "redirect_url":"https://staging.kredivo.com/kredivo/v2/signin?tk=XXX"
  }

  Negative Response:

  {
    "status": "ERROR",
    "error": {
        "message": "Field secret_key is INCORRECT.",
        "kind": "APIException"
    }
  }

  and

  {
    "error": {
        "kind": "deprecated",
        "message": "This order is already PROCESSED.",
        "code": null
    },
    "status": "ERROR"
}

0-click: Request body

0-click: Response

0-click: Transaction

0-click: Product item

0-click: Customer

0-click: Address

0-click: Seller

0-click: Metadata

0-click: HTTP(S) header

Confirm Transaction (0-Click)

After the Kredivo user completes a transaction, Kredivo sends you a push notification. Follow these steps to acknowledge it, verify it, and update the order in your system.

1. Receive notification from Kredivo (0-click)

When the Kredivo user completes a purchase, Kredivo sends a POST request to the push_uri you provided when you created the checkout.

Example push notification:

{
    "status": "OK",
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "pending",
    "order_id": "KD125262",
    "message": "Transaction status is pending",
    "shipping_address": {
        "city": "Jakarta Selatan",
        "first_name": "Darana 2",
        "last_name": "Pratama",
        "countrycode": "IDN",
        "creation_date": "2017-08-04T18:28:14",
        "phone": "0217248724",
        "state": "",
        "transaction": 1505866,
        "postcode": "12120",
        "location_details": "Jl. Kerinci IX No. 5-A"
    },
    "transaction_time": 1501846094,
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpHx0uuHETBVpxfYLbaPyS8RJg34uVxTUX64cfUTzVVhCrSif%2FUg92J2WyLs%2FhQ%3D"
}

0-click confirm: Push notification body

0-click confirm: Response address info

2. Acknowledge the push notification (0-click)

Respond with JSON structured like this:

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

3. Confirm the order status (0-click)

Call update to get the order status and verify that the push notification came from Kredivo.

0-click confirm: HTTP request

GET /kredivo/v2/update?transaction_id=bb0380d7-2688-4e73-a668-997f3fc5cbec&signature_key=5f1fa4a524f5a8201a3a373d67b5796840bed1598b2bb816855d0e14d01cd09b988b4b861f39bed642b4db861108bbf0dd84ce8e17caf675d4bf2c81ab545397

0-click confirm: Request body

0-click confirm: Response body

Example response from v2/update:

{
    "status": "OK",
    "legal_name": "TANDRA",
    "fraud_status": "accept",
    "order_id": "KD125262",
    "transaction_time": 1501846094,
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "settlement",
    "message": "Confirmed order status. Valid!",
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "user_token" : "XXXX-XXXX"
}

4. Settle an order in your system (0-click)

If transaction_status is settlement, settle the order in your system and store the order data you need.

Deactivate User Token

Call this API to let a Kredivo user deactivate their tokenized account (invalidate their user_token).

Deactivate token: HTTP request

POST /kredivo/v2/deactive_user_token

Example request:

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

Deactivate token: Request body

Example success response:

{
    "status": "OK",
    "message": "",
    "remarks": "081513114262|Deactivated by merchant",
    "user_token": "9cc7f862-d4ac-49d2-88d6-050858bee3fd",
    "is_active": false
}

Example error response:

{
    "status": "ERROR",
    "error": {
        "code": 2403,
        "message": "Invalid merchant",
        "kind": "deprecated"
    }
}

Or

{
    "error": {
        "kind": "deprecated",
        "message": "Invalid user_token",
        "code": null
    },
    "status": "ERROR"
}

Success response

Error response

Error details

Deactivate from Kredivo app

Example request:

{
  "message": "message if any",
  "client_user_key": "yospe@finaccel.co"
}

Kredivo users can also deactivate their tokenized account in the Kredivo app. Kredivo then sends a push notification to the callback_url you provided during account linking, telling you to invalidate the user_token.

Example response:

{
  "status": "OK",
  "message": "message if any"
}

Get User Credit Details

Use this API to get a tokenized Kredivo user’s remaining limit, account status, and account type. You need the user’s user_token.

Credit details: HTTP request

POST /kredivo/v2/get_user_credit_details

Example request:

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

Credit details: Request body

Example success response:

{
    "Status": "OK",
    "user_details" : {
        "legal_name" : "Rangge Septyo",
        "mobile_number": "62812xxxx0581"
    },
    "user_credit_details": {
        "account_status":1,
        "account_type":2,
        "credit_limit_details":[
            {
                "payment_type":"30_days",
                "remaining_user_limit":"1500000"
            }
            {
                "payment_type":"3_months",
                "remaining_user_limit":"4500000"
            }
            {
                "payment_type":"6_months",
                "remaining_user_limit":"9000000"
            }
            {
                "payment_type":"9_months",
                "remaining_user_limit":"13500000"
            }
            {
                "payment_type":"12_months",
                "remaining_user_limit":"18000000"
            }
            {
                "payment_type":"18_months",
                "remaining_user_limit":"27000000"
            }
            {
                "payment_type":"24_months",
                "remaining_user_limit":"36000000"
            }

        ]
    }
}

Example error response:

{
    "status": "ERROR",
    "error": {
        "kind": "deprecated",
        "message": "Invalid user_token",
        "code": null
    }
}

Credit details: Success response

User details

User credit details

Credit limit details

Credit details: Error response

Credit details: Error details

Offline Checkout

Offline checkout is for in-store payments, where the Kredivo user pays at your physical store via QR, barcode scan, or EDC terminal.

• QR Checkout — the user scans a dynamic QR code generated for each transaction.
• Barcode Checkout — you scan the barcode shown in the user’s Kredivo app.
• EDC Checkout — the user pays through an EDC terminal.

QR Checkout

QR checkout lets Kredivo users pay in your physical store by scanning a dynamic QR code generated for each new transaction. You must integrate the Kredivo QR checkout API into your POS system, directly or through a POS provider. Contact us for integration details.

We also provide a seller app for monitoring transactions and cancelling them.

QR checkout flow:

Contact us to learn more about QR checkout.

Initiate QR Checkout

Call init_checkout to create a dynamic QR transaction and get a QR code to show on your POS.

QR: HTTP request

POST /offline/v1/init_checkout

Example request:

  {
    "server_key":"8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7x",
    "amount":70000,
    "source": "QR",
    "qr_type": "IMAGE",
    "order_id": "548tIt83saeN",
    "sub_merchant_id": "KFCSenayanCity",
    "push_uri" : "https://www.merchantcallback.com/notify",
    "sellers":
    {
            "id":"SELLER123",
            "name":"Sunrise",
            "email": "sunrise@gmail.com",
            "url":"https://onlineshop/seller/sunrise",
            "address" : {
                "first_name":"Irfan",
                "last_name":"Sutandro",
                "address":"Jalan Tentara Pelajar no 49",
                "city":"Jakarta Utara",
                "postal_code":"12960",
                "phone":"08123456789",
                "country_code":"IDN"
            }
    },
    "items": [
         {
        "id": "001",
        "name":"Product Name",
        "price":50000,
        "type":"Category Product",
        "quantity":1
        },
        {
        "id": "002",
        "name":"Product Name",
        "price":25000,
        "type":"Category Product",
        "quantity":1,
        "additional_info":{
                "imei":"1234281484285",
                "color":"black"
            }
        },
        {
            "id":"discount",
            "name":"Discount",
            "price":5000,
            "quantity":1
         }
    ]
}

Example response (qr_type: IMAGE):

  {
    "status": "OK",
    "message": "",
    "qr_image": "{HOST}/{endpoint}/v1/qrcode/{merchant_id}/{external_merchant_id}/6a643481-33fa-4fa7-9135-8a1503fc863a",
    "qr_numeric_code": 114376,
    "transaction_id": "6a643481-33fa-4fa7-9135-8a1503fc863a"
  }

Example response (qr_type: STRING):

  {
    "status": "OK",
    "message": "",
    "qr_image": {
        "type": "TRANSACTION",
        "qr_id": "b1849e0d-22dd-4a7e-b848-2bb55c49fb64"
    },
    "qr_numeric_code": 114376,
    "transaction_id": "6a643481-33fa-4fa7-9135-8a1503fc863a"
  }

QR: Request body

QR: Seller

QR: Address

QR item

QR: Response

Confirm Transaction (QR)

After the Kredivo user completes a transaction, Kredivo sends you a push notification. Follow these steps to acknowledge it, verify it, and update the order in your system.

1. Receive notification from Kredivo (QR)

When the Kredivo user completes a purchase, Kredivo sends a POST request to the push_uri you provided when you created the checkout.

Example push notification:

{
    "status": "OK",
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "pending",
    "order_id": "KD125262",
    "message": "Transaction status is pending",
    "shipping_address": {
        "city": "Jakarta Selatan",
        "first_name": "Darana 2",
        "last_name": "Pratama",
        "countrycode": "IDN",
        "creation_date": "2017-08-04T18:28:14",
        "phone": "0217248724",
        "state": "",
        "transaction": 1505866,
        "postcode": "12120",
        "location_details": "Jl. Kerinci IX No. 5-A"
    },
    "transaction_time": 1501846094,
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpHx0uuHETBVpxfYLbaPyS8RJg34uVxTUX64cfUTzVVhCrSif%2FUg92J2WyLs%2FhQ%3D",
    "sub_merchant_id": "KFCSenayanCity"
}

QR confirm: Push notification body

QR confirm: Response address info

2. Acknowledge the push notification (QR)

Respond with JSON structured like this:

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

3. Confirm the order status (QR)

Call update to get the order status and verify that the push notification came from Kredivo.

QR confirm: HTTP request

GET /kredivo/v2/update?transaction_id=bb0380d7-2688-4e73-a668-997f3fc5cbec&signature_key=5f1fa4a524f5a8201a3a373d67b5796840bed1598b2bb816855d0e14d01cd09b988b4b861f39bed642b4db861108bbf0dd84ce8e17caf675d4bf2c81ab545397

QR confirm: Request body

QR confirm: Response body

Example response from v2/update:

{
    "status": "OK",
    "legal_name": "TANDRA",
    "fraud_status": "accept",
    "order_id": "KD125262",
    "transaction_time": 1501846094,
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "settlement",
    "message": "Confirmed order status. Valid!",
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "sub_merchant_id": "KFCSenayanCity",
}

4. Settle an order in your system (QR)

If transaction_status is settlement, settle the order in your system and store the order data you need.

Barcode Checkout

Barcode checkout lets Kredivo users pay in your physical store by showing a barcode in the Kredivo app, which you scan (customer-presented mode).

1. The Kredivo user opens the Kredivo app and shows the barcode.
2. You scan the barcode.
3. You send a purchase transaction request to Kredivo.
4. Kredivo validates the transaction request.
5. Kredivo sends a response back to you.
6. If you don’t receive a response from Kredivo within 45 seconds, send a purchase reversal.

Barcode Purchase Transaction

Send a purchase request after you scan the user’s barcode.

Barcode: HTTP request

POST /barcode/init_checkout

Example request:

{
    "login": "username",
    "password": "abc123",
    "terminal": "QRUSERNAME001",
    "barcode": "77158554444100004000",
    "transaction_date": "20200202090000",
    "amount": "10000",
    "order_id": "GPTALF278-00000001101",
    "name": "Kredipal",
    "rek_type": "01",
    "signature": "b46eec4ada3bbf1a4e09e84180bc1c0f",
    "items": [
        {
            "id": "001",
            "name": "Shampoo",
            "price": 20000,
            "type": "Additional",
            "quantity": 1
        },
        {
            "id": "discount",
            "name": "discount",
            "price": 10000,
            "type": "discount",
            "quantity": 1
        }
    ]
}

Example response:

0000:Success:NAJWA008:20200202090000:Kredipal:01:0.0:77158624690202532001:Nominal=10000#Sisa Limit=3467000.00:ed035df9-93ee-43c6-ae97-6690220fc028:SIMPAN TANDA TERIMA SEBAGAI#BUKTI PEMBAYARAN SAH#LAYANAN KONSUMEN#customerservice#LAYANAN MITRA#driversupport:#

Barcode: Request body

Barcode item

Barcode: Response

The response is a colon-delimited (:) string, not JSON. Fields appear in this order:

Barcode Purchase Reversal

Send a reversal to cancel a purchase when you don’t receive a purchase response from Kredivo within 45 seconds.

Barcode reversal: HTTP request

POST /barcode/reversal

Example request:

{
    "login": "username",
    "password": "abc123",
    "terminal": "QRUSERNAME001",
    "barcode": "77158554444100004000",
    "transaction_date": "20200202090000",
    "amount": "10000",
    "order_id": "GPTALF278-00000001101",
    "name": "Kredipal",
    "rek_type": "01",
    "signature": "b46eec4ada3bbf1a4e09e84180bc1c0f",
    "items": [
        {
            "id": "001",
            "name": "Shampoo",
            "price": 20000,
            "type": "",
            "quantity": 1
        },
        {
            "id": "002",
            "name": "Sabun",
            "price": 15000,
            "type": "",
            "quantity": 1
        },
        {
            "id": "discount",
            "name": "discount",
            "price": 25000,
            "type": "discount",
            "quantity": 1
        }
    ]
}

Barcode reversal: Request body

The reversal request uses the same parameters as the purchase request body. The order_id identifies the transaction to reverse.

Barcode reversal: Response

The reversal response has the same format and fields as the purchase response.

Barcode Signature

Every request includes a signature field: the MD5 hash of all request field values concatenated in order, followed by a secret key agreed with Kredivo.

signature = MD5(login + password + terminal + barcode + transaction_date + amount + order_id + name + rek_type + secret_key)

Example signature:

MD5("usernameabc123KZ01;KT01;F7712391823813011202003101815041000020160310181504kredipal1kredivo2020")
= b224b4a701cf2003bc02689b1960fdd3

Barcode Response Codes

EDC Checkout

EDC checkout lets Kredivo users pay in your physical store through an EDC terminal.

We also provide a dashboard for monitoring transactions and cancelling them.

Contact us to learn more about EDC checkout.

Initiate EDC Checkout

Call init_checkout with source set to EDC Mobile to create an EDC transaction. The cashier enters the customer’s Kredivo phone number on the EDC terminal. Kredivo then sends a notification to the customer’s Kredivo app, and the customer completes the transaction there by entering their PIN.

EDC: HTTP request

POST /offline/v1/init_checkout

Example request:

{
    "server_key": "8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7",
    "sub_merchant_id": "KFCSenayanCity",
    "source": "EDC Mobile",
    "push_uri": "https://merchant.com/pushnotif",
    "order_id": "12345678912",
    "amount": 15000,
    "mobile_number": "+62-85210549044",
    "terminal_id": "WDCMERCHANT0001"
}

Example response:

{
    "status": "OK",
    "message": "",
    "transaction_id": "bcda87e2-e87b-4b7f-add4-206bb4c1d72c",
    "order_id": "12345678912"
}

EDC: Request body

EDC: Response

Confirm Transaction (EDC)

After the Kredivo user completes a transaction, Kredivo sends you a push notification. Follow these steps to acknowledge it, verify it, and update the order in your system.

1. Receive notification from Kredivo (EDC)

When the Kredivo user completes a purchase, Kredivo sends a POST request to the push_uri you provided when you created the checkout.

Example push notification:

{
    "status": "OK",
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "pending",
    "order_id": "KD125262",
    "message": "Transaction status is pending",
    "shipping_address": {},
    "transaction_time": 1501846094,
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "signature_key": "o5KZPDcxgEA9QutAVcIQwE3suQRkTEIA1VXcoHp7KaWJnpHx0uuHETBVpxfYLbaPyS8RJg34uVxTUX64cfUTzVVhCrSif%2FUg92J2WyLs%2FhQ%3D",
    "sub_merchant_id": "KFCSenayanCity"
}

EDC confirm: Push notification body

2. Acknowledge the push notification (EDC)

Respond with JSON structured like this:

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

3. Confirm the order status (EDC)

Call update to get the order status and verify that the push notification came from Kredivo.

EDC confirm: HTTP request

GET /kredivo/v2/update?transaction_id=bb0380d7-2688-4e73-a668-997f3fc5cbec&signature_key=5f1fa4a524f5a8201a3a373d67b5796840bed1598b2bb816855d0e14d01cd09b988b4b861f39bed642b4db861108bbf0dd84ce8e17caf675d4bf2c81ab545397

EDC confirm: Request body

EDC confirm: Response body

Example response from v2/update:

{
    "status": "OK",
    "legal_name": "TANDRA",
    "fraud_status": "accept",
    "order_id": "KD125262",
    "transaction_time": 1501846094,
    "amount": "1500100.00",
    "payment_type": "30_days",
    "transaction_status": "settlement",
    "message": "Confirmed order status. Valid!",
    "transaction_id": "fadee4e5-99a2-48d6-952d-007f3fa508e8",
    "sub_merchant_id": "KFCSenayanCity",
}

4. Settle an order in your system (EDC)

If transaction_status is settlement, settle the order in your system and store the order data you need.

Reversal Transaction

Call reversal_transaction to terminate an EDC transaction after an intermittent connection or network issue. Reversal is only allowed within 60 seconds of the transaction.

Reversal: HTTP request

POST /offline/v1/reversal_transaction

Example request:

{
    "order_id": "12345678912",
    "server_key": "8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7"
}

Example success response:

{
    "message": "",
    "status": "OK"
}

Example error response:

{
    "message": "",
    "status": "ERROR"
}

Reversal: Request body

Reversal: Response

Additional APIs

Use these APIs to check a transaction status (for example, if a push notification fails), cancel a transaction, and calculate interest and payments.

Check Transaction Status

Call this API to get a transaction’s current status after the Kredivo user finishes the transaction, or when you did not receive a push notification.

Status: HTTP request

POST /kredivo/transaction/status

Example request:

  {
    "server_key":"8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7",
    "order_id": "KB-0c40f395"
  }

Example response:

{
    "fraud_status": "accept",
    "transaction_time": 1637743030,
    "order_id": "KB-0c40f395",
    "external_userid": "S9JRJ2bGiS4d",
    "status": "OK",
    "legal_name": "Rangge",
    "message": "Transaction is settlement",
    "amount": "75000.00",
    "discount_amount": 0,
    "transaction_id": "7401e873-ea77-455e-9f31-4ca2268304dc",
    "payment_type": "30_days",
    "transaction_status": "settlement"
}

Status: Request body

Status: Response

Cancel Transaction

Call this API to fully or partially cancel a completed transaction.

Cancel: HTTP request

POST /kredivo/v2/cancel_transaction

Example request:

  {
    "server_key":"8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7",
    "transaction_id": "2be7d9ea-ccba-4743-8b92-0f1fc3ec358d",
    "cancellation_amount": 5000,
    "cancellation_reason":"Out of stock",
    "cancelled_by":"Althea",
    "cancellation_date":"1512032053",
    "order_id":"KB-0123456",
    "cancellation_id": "1234567"
  }

Cancel: Request body

Example response (full cancellation):

  {
    "status": "OK",
    "fraud_status": "accept",
    "order_id": "EDCA0020F1E-FE69-43EA-B9CA-FCDE1B52B2A6",
    "transaction_time": 1513146999,
    "amount": "5000000.00",
    "payment_type": "30_days",
    "transaction_status": "cancel",
    "message": {short, long}"Cancelled the transaction!",
    "transaction_id": "2be7d9ea-ccba-4743-8b92-0f1fc3ec358d",
    "sub_merchant_id": "KFCSenayanCity",
    "outlet_id": "KFCSCT01"
  }

Example response (full/partial cancellation):

  {
    "status": "OK",
    "fraud_status": "accept",
    "order_id": "EDCA0020F1E-FE69-43EA-B9CA-FCDE1B52B2A6",
    "transaction_time": 1513146999,
    "amount": "1000.00",
    "payment_type": "30_days",
    "transaction_status": "settlement",
    "message": "Succes cancelling transaction by amount",
    "transaction_id": "2be7d9ea-ccba-4743-8b92-0f1fc3ec358d",
    "sub_merchant_id": "KFCSenayanCity",
    "outlet_id": "KFCSCT01"
  }

Example error response (full/partial cancellation):

  {
    "status": "ERROR",
    "error": {
        "code": 2415,
        "message": "Cancellation amount bigger than remaining transaction amount that can be cancelled",
        "kind": "deprecated"
    }
}

{
    "status": "ERROR",
    "error": {
        "code": 1009,
        "message": "Transaksi sudah dibatalkan.",
        "kind": "deprecated"
    }
}

  {
    "status": "ERROR",
    "error": {
        "code": 2415,
        "message": "This cancellation_id is already PROCESSED.",
        "kind": "deprecated"
    }
}

Cancel: Response

Kredivo Loan Calculator

Call this API to get the monthly payment breakdown of a Kredivo installment for each available payment type.

Calculator: HTTP request

POST /kredivo/v2/payments

Example request:

  {
    "server_key":"8tLHIx8V0N6KtnSpS9Nbd6zROFFJH7",
    "user_token":"XXX-XXX",
    "amount":2400000,
    "items": [
        {
            "id":"BB12345678",
            "name":"iPhone 5S",
            "price":2400000,
            "url":"http://merchant.com/cellphones/iphone5s_64g",
            "type":"Smartphone",
            "quantity":1
        }
    ]
  }

Example response:

  {
    "payments": [
        {
            "raw_amount": 2424000.0,
            "amount": 2424000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 2423999.801457357,
            "id": "30_days",
            "tenure": 1,
            "service_fee": 24000,
            "mdr": null,
            "name": "Bayar dalam 30 hari",
            "interest_rate": "0",
            "rate": 0.0,
            "service_fee_percentage": 1.0,
            "monthly_installment": 2424000,
            "installment_amount": 2424000
        },
        {
            "raw_amount": 2472000.0,
            "potential_cashback": {
                "monthly_cashback": 9888,
                "total_cashback": 29664
            },
            "amount": 2472000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 823999.93388194,
            "id": "3_months",
            "tenure": 3,
            "service_fee": 72000,
            "mdr": null,
            "name": "Cicilan 3 bulan",
            "interest_rate": "0",
            "rate": 0.0,
            "service_fee_percentage": 3.0,
            "monthly_installment": 824000,
            "installment_amount": 2472000
        },
        {
            "raw_amount": 2400000.0,
            "potential_cashback": {
                "monthly_cashback": 4800,
                "total_cashback": 28800
            },
            "amount": 2400000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 462397.09959627397,
            "id": "6_months",
            "tenure": 6,
            "service_fee": null,
            "mdr": null,
            "name": "Cicilan 6 bulan",
            "interest_rate": "2,6",
            "rate": 2.6,
            "service_fee_percentage": 0,
            "monthly_installment": 462400,
            "installment_amount": 2774400
        },
        {
            "raw_amount": 2400000.0,
            "potential_cashback": {
                "monthly_cashback": 2400,
                "total_cashback": 28800
            },
            "amount": 2400000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 329064.15,
            "id": "9_months",
            "tenure": 9,
            "service_fee": null,
            "mdr": null,
            "name": "Cicilan 9 bulan",
            "interest_rate": "2,6",
            "rate": 2.6,
            "service_fee_percentage": 0,
            "monthly_installment": 329070,
            "installment_amount": 2961630
        },
        {
            "raw_amount": 2400000.0,
            "potential_cashback": {
                "monthly_cashback": 2400,
                "total_cashback": 28800
            },
            "amount": 2400000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 262396.4704067336,
            "id": "12_months",
            "tenure": 12,
            "service_fee": null,
            "mdr": null,
            "name": "Cicilan 12 bulan",
            "interest_rate": "2,6",
            "rate": 2.6,
            "service_fee_percentage": 0,
            "monthly_installment": 262400,
            "installment_amount": 3148800
        },
        {
            "raw_amount": 2400000.0,
            "potential_cashback": {
                "monthly_cashback": 2400,
                "total_cashback": 28800
            },
            "amount": 2400000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 195733.65,
            "id": "18_months",
            "tenure": 18,
            "service_fee": null,
            "mdr": null,
            "name": "Cicilan 18 bulan",
            "interest_rate": "2,6",
            "rate": 2.6,
            "service_fee_percentage": 0,
            "monthly_installment": 195740,
            "installment_amount": 3523320
        },
        {
            "raw_amount": 2400000.0,
            "potential_cashback": {
                "monthly_cashback": 2400,
                "total_cashback": 28800
            },
            "amount": 2400000,
            "discount_interest_rate": null,
            "raw_monthly_installment": 162402.98,
            "id": "24_months",
            "tenure": 24,
            "service_fee": null,
            "mdr": null,
            "name": "Cicilan 24 bulan",
            "interest_rate": "2,6",
            "rate": 2.6,
            "service_fee_percentage": 0,
            "monthly_installment": 162410,
            "installment_amount": 3897840
        }
    ],
    "message": "Available payment types are listed.",
    "status": "OK"
}