Chilkat Online Tools

phpExt / Broker API / Transfer Entity

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('{{api_key}}');
$http->put_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"
// }

$json = new CkJsonObject();
$json->UpdateString('transfer_type','ach');
$json->UpdateString('relationship_id','32788c82-9f9d-407c-8e77-c981ac74a1c9');
$json->UpdateString('amount','500');
$json->UpdateString('direction','INCOMING');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/v1/accounts/:account_id/transfers','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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": [
  ]
}