API Reference

Link Payee in Escrow

post
https://api-uat.ncome.in/api/v1/escrow/link-payee

This API allows you to link multiple payees to a Digital Escrow ID (Virtual Account) and assign Payout shares

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

The shareUnit field defines whether the amount to be transferred to the payee from the Digital Escrow is specified in percentage or inr. It allows you to choose the format for distributing funds to the payee.

payees
array of objects
required

Provide the list of payees with their payout shares. This parameter includes each payee's details and their corresponding payout share percentages or amounts.

payees*
string
required

Specify the Digital Escrow ID to which the payees need to be linked. This parameter identifies the digital escrow ID where the payees will be linked.

Headers
string
Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

string
Defaults to {{x-api-key}}

xAPI key shared separately by Castler

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?