Chilkat Online Tools

SQL Server / Broker API / Bank Relationship

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{api_key}}'
    EXEC sp_OASetProperty @http, '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.

    -- {
    --   "name": "Test Bank XYZ",
    --   "bank_code_type": "ABA",
    --   "bank_code": "123456789",
    --   "account_number": "123456789abc"
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'Test Bank XYZ'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bank_code_type', 'ABA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bank_code', '123456789'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_number', '123456789abc'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/v1/accounts/:account_id/recipient_banks', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

Curl Command

curl -X POST
	-u '{{api_key}}:{{api_secret}}'
	-d '{
  "name": "Test Bank XYZ",
  "bank_code_type": "ABA",
  "bank_code": "123456789",
  "account_number": "123456789abc"
}'
https://domain.com/v1/accounts/:account_id/recipient_banks

Postman Collection Item JSON

{
  "name": "Bank Relationship",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"Test Bank XYZ\",\n  \"bank_code_type\": \"ABA\",\n  \"bank_code\": \"123456789\",\n  \"account_number\": \"123456789abc\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HOST}}/v1/accounts/:account_id/recipient_banks",
      "host": [
        "{{HOST}}"
      ],
      "path": [
        "v1",
        "accounts",
        ":account_id",
        "recipient_banks"
      ],
      "variable": [
        {
          "key": "account_id",
          "value": null
        }
      ]
    },
    "description": "| Parameter        | Type                | Requirement | Notes             |\n| -----------------|---------------------|-------------|:-----------------:|\n| `name`           | string              | Required    | Name of recipient bank |\n| `bank_code_type` | enum.IdentifierType | Required    | `ABA`(Domestic) or `BIC`(International) |\n| `bank_code`      | string              | Required    | 9-Digit ABA RTN (Routing Number or BIC |\n| `country`        | string              | Required    | Only for international banks |\n| `state_province` | string              | Required    | Only for international banks |\n| `postal_code`    | string              | Required    | Only for international banks |\n| `city`           | string              | Required    | Only for international banks |\n| street_address | string              | Required    | Only for international banks |\n| account_number | string              | Required    |                   |"
  },
  "response": [
  ]
}