website logo
⌘K
🚀Getting Started
Welcome Developers
Web integration Architecture
Integration Prerequisite
🔐Authentication
📌Sandbox and Live Environment
🛠️Integration Options
POS Integration Guide
Direct API integration Guide
⚙️Plugins
🇲🇾Malaysia
🇸🇬Singapore
🛍️Marketing brand guide
🔍Logo introduction
🖥️Sitewide
👗Product & service pages
👜Checkout and cart page
🌐Website Assets
API REFERENCE
Docs powered by archbee 
6min

Charges

Learn about managing charges

Overview

Charges represent the OctiFi loans that are issued to the end-user. You can interact with charges via the charges api in order to change the state of that charge, update metadata, or retrieve details.

Charge authorization

Charge Authorisation occurs after a user has successfully completed the OctiFi checkout flow and returns back to the merchant site. Authorizing the charge generates the charge_id that will be used to reference this loan moving forward.

Charge actions

You can integrate various charge actions into your back-end order management system, where you normally fulfill orders and process payments, refunds, and cancelations.

You can use the Charges Api to manage charges with the following actions:

  • Read charge (charge/detail api)
  • Capture charges (charge/capture)
  • Cancel/Void charges (charge/cancel)
  • Partially Refund charges (charge/refund)

These action allow you to manage charges through various states such as authorized, captured, voided, etc.

Charge Apis

  • Check the swagger documentation for the /charge/ endpoint here: https://docs.octifi.com/apis

Authentication

Charge api should carry the following header:

Authorization: Api-Key private_api_key

Charge api is a backend server side api

Hence it should carry private_api_key in the header







Updated 03 Mar 2023
Did this page help you?
Yes
No
UP NEXT
Separate auth and capture
Docs powered by archbee 
TABLE OF CONTENTS
Overview
Charge authorization
Charge actions
Charge Apis
Authentication
Charge api is a backend server side api