API Reference
Log In
API Reference

Create a Settlement

This will create a settlement request on Instamojo. You need to use a token that is obtained using the Application Based Authentication. This allows marketplaces to transfer money to merchants on whose behalf they have accepted payments. Money can also be transferred from merchants to marketplace accounts in case of refunds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Notes

  1. Marketplace can credit to their sub-merchants only upto a total of transaction amount (i.e; the amount paid by the buyer).
  2. Crediting to sub-merchants work only till the payment gets marked as fulfilled. Once payment is marked as fulfilled, the distribution is deemed final.
  3. Only sub-merchants that were earlier credited for the given payment can be debited by marketplace.
  4. Marketplace can debit sub-merchants only in case of refunds and only upto refund amount.
  5. Instamojo allows a sub-merchant to be debited only if they have sufficient balance with Instamojo.
Path Params
string
required

Payment ID

Form Data
string

Unique settlement id for each payment

string

Can be 'CREDIT' or 'DEBIT'. Credit transfers the amount from one's own account to user's and debit transfers amount from user's account to one's own.

string

The Instamojo account id of the user from/to money is to be transferred. It was obtained on registering a merchant using Signup API.

double

Must be a positive number.

Headers
string
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json