Parameter | Required | Type | Description |
---|
clientID | yes | string | TransactAPI Client ID |
developerAPIKey | yes | string | TransactAPI Developer Key |
accountId | yes | string | Account ID generated from createAccount |
amount | yes | string | Amount of funds to be transferred |
type | yes | string | Type options: ACH, wire_domestic, wire_international |
bankId | no | string | Required for wire transfers only. See details below. |
bankAccountId | no | string | Required for wire transfers only. See details below. |
additionalDetails | no | string | Open text field to provide any additional instructions that are required to successfully send the wire transfer |
-
bankId
- Domestic: Routing number
Format: 9 numeric characters
- International: SWIFT ID
Format: 8-11 alphanumeric characters
-
bankAccountId
- Domestic: U.S. account number
Format: 6-17 numeric characters
- International: IBAN or account number
Format: 14-34 alphanumeric characters
Note: For ACH transfers, these parameters are ignored. The transfer will be sent to the account connected via linkExternalAccount .
curl -k -X POST https://api-sandboxdash.norcapsecurities.com//tapiv3/index.php/v3/createCustodyFundDisbursement
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accoundId=someaccountid
-d amount=22.23
-d type=wire_domestic
-d bankId=122100024
-d bankAccountId=123456789
Parameter | Type | Description |
---|
statusCode | string | API Status Code |
statusDesc | string | API Status Description |
custodyFundDisbursement | object | See below |
custodyFundDisbursement | Description |
---|
requestId | Unique identifier for disbursement request |
accountId | Account ID that request is being made against |
amount | Amount of disbursement request |
type | Type of fund disbursement: ACH, wire_domestic, wire_international |
bankId | Routing number for Domestic Wires. SWIFT ID for International Wires. |
bankAccountId | U.S. account number for Domestic Wires. IBAN or account number for International Wires. |
additionalDetails | Any additional details that were passed in the request |
status | Status of the fund disbursement: will be Pending |
createdDate | Date and timestamp request was created |
updatedDate | Date and timestamp request was updated |
{
"statusCode": "101",
"statusDesc": "Ok",
"custodyFundDisbursement": {
"requestId": "a49a68b7-f0ab-45b5-ac07-6ed555259d27",
"accountId": "A3110006",
"amount": "1.20",
"type": "wire_domestic",
"bankId": "122100024",
"bankAccountId": "123456789",
"additionalDetails": "",
"status": "pending",
"createdDate": "2024-12-10 23:29:13",
"updatedDate": "2024-12-10 23:29:13"
}
}