lianja / Broker API / Transfer Entity
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.BasicAuth = .T.
loHttp.Login = "{{api_key}}"
loHttp.Password = "{{api_secret}}"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "transfer_type": "ach",
// "relationship_id": "32788c82-9f9d-407c-8e77-c981ac74a1c9",
// "amount": "500",
// "direction": "INCOMING"
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("transfer_type","ach")
loJson.UpdateString("relationship_id","32788c82-9f9d-407c-8e77-c981ac74a1c9")
loJson.UpdateString("amount","500")
loJson.UpdateString("direction","INCOMING")
loResp = loHttp.PostJson3("https://domain.com/v1/accounts/:account_id/transfers","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
? str(loResp.StatusCode)
? loResp.BodyStr
release loResp
release loHttp
release loJson
Curl Command
curl -X POST
-u '{{api_key}}:{{api_secret}}'
-d '{
"transfer_type": "ach",
"relationship_id": "32788c82-9f9d-407c-8e77-c981ac74a1c9",
"amount": "500",
"direction": "INCOMING"
}'
https://domain.com/v1/accounts/:account_id/transfers
Postman Collection Item JSON
{
"name": "Transfer Entity",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_type\": \"ach\",\n \"relationship_id\": \"32788c82-9f9d-407c-8e77-c981ac74a1c9\",\n \"amount\": \"500\",\n \"direction\": \"INCOMING\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HOST}}/v1/accounts/:account_id/transfers",
"host": [
"{{HOST}}"
],
"path": [
"v1",
"accounts",
":account_id",
"transfers"
],
"variable": [
{
"key": "account_id",
"value": null
}
]
},
"description": "| Parameter | Type | Required | Notes |\n|------------------------|------------------------|-------------------------|:-----:|\n| `transfer_type` | ENUM.TransferType | Required | Sandbox currently only supports `ach` |\n| `relationship_id` | string/UUID | Required if `type = ach` | The `ach_relationship` created for the `account_id` here |\n| `bank_id` | string/UUID | Required if `type = wire` | The `bank_relationship` created for the `account_id` here |\n| `amount` | string/decimal | Required | Must be > 0.00 |\n| `direction` | ENUM.TransferDirection | Required | |\n| `timing` | ENUM.TransferTiming | Required | Only `immediate` |\n| `additional_information` | string | Optional - Applies only to wires | Additional wire details |"
},
"response": [
]
}