Silvergate API Service 2.0

API change history

This is our latest API good from April 2018 going forward

webhooks/register

Creates a new webhook which sends notifications via http post and/or email when a balance on a given account changes.

Try it

Request

Request URL

Request headers

  • string

    jwt access token

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Register WebHook Model

Field Name Description Data Type Length Sample Opt/Req Comments
AccountNumber The account in which you wish to receive balance updates Numeric 20 9999999999 Required
Description A description of the web hook you can use for internal purposes String Optional
WebHookUrl This is your post back addresss where you would like to receive notification when the account balance changes string - URI http://www.silvergate.com/webhooks Required if Emails are not provided This must be a well formed and valid url. Body of post back will similar to the following:
{
"AccountNumber" : "1000109015",
"AvailableBalance" : "000010000",
"PreviousBalance" : "000010100"
}
Emails This is a comma seperated list of emails that will be notified when a balance changes String jondoe@silvergate.com,someuser@silvergate.com Required if WebHookUrl is not provided
Sms NOTE: Currently not implemented - Future. This is a comma seperated list of well formed phone numbers including country code string +17706665555,+16125551111 Optional CURRENTLY NOT IMPLEMENTED - FOR FUTURE USE 

{
  "AccountNumber": "string",
  "Description": "string",
  "WebHookUrl": "string",
  "Emails": "string",
  "Sms": "string"
}
{
  "type": "object",
  "properties": {
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
{
  "AccountNumber": "string",
  "Description": "string",
  "WebHookUrl": "string",
  "Emails": "string",
  "Sms": "string"
}
{
  "type": "object",
  "properties": {
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
<Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHookRequest>
  <AccountNumber>string</AccountNumber>
  <Description>string</Description>
  <WebHookUrl>string</WebHookUrl>
  <Emails>string</Emails>
  <Sms>string</Sms>
</Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHookRequest>
{
  "type": "object",
  "properties": {
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
<Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHookRequest>
  <AccountNumber>string</AccountNumber>
  <Description>string</Description>
  <WebHookUrl>string</WebHookUrl>
  <Emails>string</Emails>
  <Sms>string</Sms>
</Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHookRequest>
{
  "type": "object",
  "properties": {
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}

Responses

200 OK

WebHook Created successfully

Representations

{
  "WebHookId": "string",
  "AccountNumber": "string",
  "Description": "string",
  "WebHookUrl": "string",
  "Emails": "string",
  "Sms": "string"
}
{
  "type": "object",
  "properties": {
    "WebHookId": {
      "type": "string"
    },
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
{
  "WebHookId": "string",
  "AccountNumber": "string",
  "Description": "string",
  "WebHookUrl": "string",
  "Emails": "string",
  "Sms": "string"
}
{
  "type": "object",
  "properties": {
    "WebHookId": {
      "type": "string"
    },
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
<Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHook>
  <WebHookId>string</WebHookId>
  <AccountNumber>string</AccountNumber>
  <Description>string</Description>
  <WebHookUrl>string</WebHookUrl>
  <Emails>string</Emails>
  <Sms>string</Sms>
</Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHook>
{
  "type": "object",
  "properties": {
    "WebHookId": {
      "type": "string"
    },
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}
<Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHook>
  <WebHookId>string</WebHookId>
  <AccountNumber>string</AccountNumber>
  <Description>string</Description>
  <WebHookUrl>string</WebHookUrl>
  <Emails>string</Emails>
  <Sms>string</Sms>
</Silvergate.ESB.API.Transactions.models.API.WebHooks.SGWebHook>
{
  "type": "object",
  "properties": {
    "WebHookId": {
      "type": "string"
    },
    "AccountNumber": {
      "type": "string"
    },
    "Description": {
      "type": "string"
    },
    "WebHookUrl": {
      "type": "string"
    },
    "Emails": {
      "type": "string"
    },
    "Sms": {
      "type": "string"
    }
  }
}

400 Bad Request

Invalid request information

Representations

401 Unauthorized

Access Information cannot be Authenticated

Representations

503 Service Unavailable

Host connection cannot be established

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://silvergate.azure-api.net/v2/webhooks/register"
-H "Authorization: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://silvergate.azure-api.net/v2/webhooks/register?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://silvergate.azure-api.net/v2/webhooks/register");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://silvergate.azure-api.net/v2/webhooks/register?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://silvergate.azure-api.net/v2/webhooks/register";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://silvergate.azure-api.net/v2/webhooks/register');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('silvergate.azure-api.net')
    conn.request("POST", "/v2/webhooks/register?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('silvergate.azure-api.net')
    conn.request("POST", "/v2/webhooks/register?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://silvergate.azure-api.net/v2/webhooks/register')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body