Create Escrow Account

This method is used to create a virtual instance of an Escrow account for an offering. This method is used to assign a custodian to an offering in order to pull the correct custodian details (getCustodialDetailsforOffering). This does not open a real escrow account. In order to open your escrow account, please contact your escrow custodian.

Request Method : PUT

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
offeringId yes integer Offering ID that is generated by the API when an Offering is created(createOffering).
overFundingAmount yes decimal Maximum amount the escrow can be over-funded by
bankName yes string The Custodian Name
offeringAccountNumber no string The Offering Account Number
accountFullName no string The Offering Account FullName

Sample Request

curl -k -X PUT 
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d offeringId=48587
-d overFundingAmount=10050.50
-d createdIpAddress=

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
Financial Escrow details string Returns an array with escrow account information ( issuerId, escrow account status)

Sample Response

    "statusCode": "101",
    "statusDesc": "Ok",
    "Financial Escrow Details": [
                "issuerId": "882512",
                "escrowAccountStatus": "pending"
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Custodial Account