Silvergate API Service 2.0
API change historyThis is our latest API good from April 2018 going forward
Request
Request URL
Request headers
-
string
jwt access token
-
(optional)string
Unique Key (GUID or UUID) used to ensure 'exactly once processing'
-
(optional)stringMedia type of the body sent to the API.
Request body
Account Transfer Request Model
Field Name | Description | Data Type | Length | Sample | Opt/Req | Comments |
---|---|---|---|---|---|---|
SequenceNumber | The sequence number helps match input requests and output responses, it does not get stored in any transactional record | Numeric | 8 | 1234 | Optional | Used to reassemble responses, this is for your use only, does not appear in any transactional record, not recallable |
AccountNumberFrom | The account number that money should transfer from | String | 20 | 9999999999 | Required | |
AccountNumberTo | The account number that money should transfer to | String | 20 | 9999999999 | Required | |
Amount | The amount of the transfer | Decimal | 13 | 2000 | Required | |
SerialNumber1 | Any number you wish to apply to the transfer record | String | 15 | Optional | ||
SerialNumber2 | Any number you wish to apply to the transfer record | String | 15 | Optional | ||
AccountFromDescription2-7 | Description lines for users requesting the transfer to add to the transaction history in the account the money is transfering from | String | 40 | Transfer on behalf of | Optional | |
AccountToDescription2-7 | Description lines for users requesting the transfer to add to the transaction history in the account the money is transfering to | String | 40 | Optional |
{
"SequenceNumber": 0,
"Amount": 0.0,
"AccountNumberFrom": "string",
"AccountNumberTo": "string",
"SerialNumber1": "string",
"SerialNumber2": "string",
"AccountFromDescription2": "string",
"AccountFromDescription3": "string",
"AccountFromDescription4": "string",
"AccountFromDescription5": "string",
"AccountFromDescription6": "string",
"AccountFromDescription7": "string",
"AccountToDescription2": "string",
"AccountToDescription3": "string",
"AccountToDescription4": "string",
"AccountToDescription5": "string",
"AccountToDescription6": "string",
"AccountToDescription7": "string"
}
{
"type": "object",
"properties": {
"SequenceNumber": {
"format": "int32",
"type": "integer"
},
"Amount": {
"format": "double",
"type": "number"
},
"AccountNumberFrom": {
"type": "string"
},
"AccountNumberTo": {
"type": "string"
},
"SerialNumber1": {
"type": "string"
},
"SerialNumber2": {
"type": "string"
},
"AccountFromDescription2": {
"type": "string"
},
"AccountFromDescription3": {
"type": "string"
},
"AccountFromDescription4": {
"type": "string"
},
"AccountFromDescription5": {
"type": "string"
},
"AccountFromDescription6": {
"type": "string"
},
"AccountFromDescription7": {
"type": "string"
},
"AccountToDescription2": {
"type": "string"
},
"AccountToDescription3": {
"type": "string"
},
"AccountToDescription4": {
"type": "string"
},
"AccountToDescription5": {
"type": "string"
},
"AccountToDescription6": {
"type": "string"
},
"AccountToDescription7": {
"type": "string"
}
}
}
{
"SequenceNumber": 0,
"Amount": 0.0,
"AccountNumberFrom": "string",
"AccountNumberTo": "string",
"SerialNumber1": "string",
"SerialNumber2": "string",
"AccountFromDescription2": "string",
"AccountFromDescription3": "string",
"AccountFromDescription4": "string",
"AccountFromDescription5": "string",
"AccountFromDescription6": "string",
"AccountFromDescription7": "string",
"AccountToDescription2": "string",
"AccountToDescription3": "string",
"AccountToDescription4": "string",
"AccountToDescription5": "string",
"AccountToDescription6": "string",
"AccountToDescription7": "string"
}
{
"type": "object",
"properties": {
"SequenceNumber": {
"format": "int32",
"type": "integer"
},
"Amount": {
"format": "double",
"type": "number"
},
"AccountNumberFrom": {
"type": "string"
},
"AccountNumberTo": {
"type": "string"
},
"SerialNumber1": {
"type": "string"
},
"SerialNumber2": {
"type": "string"
},
"AccountFromDescription2": {
"type": "string"
},
"AccountFromDescription3": {
"type": "string"
},
"AccountFromDescription4": {
"type": "string"
},
"AccountFromDescription5": {
"type": "string"
},
"AccountFromDescription6": {
"type": "string"
},
"AccountFromDescription7": {
"type": "string"
},
"AccountToDescription2": {
"type": "string"
},
"AccountToDescription3": {
"type": "string"
},
"AccountToDescription4": {
"type": "string"
},
"AccountToDescription5": {
"type": "string"
},
"AccountToDescription6": {
"type": "string"
},
"AccountToDescription7": {
"type": "string"
}
}
}
<Silvergate.ESB.API.Transactions.Models.API.Account.Request.Transfer3>
<SequenceNumber>0</SequenceNumber>
<Amount>0</Amount>
<AccountNumberFrom>string</AccountNumberFrom>
<AccountNumberTo>string</AccountNumberTo>
<SerialNumber1>string</SerialNumber1>
<SerialNumber2>string</SerialNumber2>
<AccountFromDescription2>string</AccountFromDescription2>
<AccountFromDescription3>string</AccountFromDescription3>
<AccountFromDescription4>string</AccountFromDescription4>
<AccountFromDescription5>string</AccountFromDescription5>
<AccountFromDescription6>string</AccountFromDescription6>
<AccountFromDescription7>string</AccountFromDescription7>
<AccountToDescription2>string</AccountToDescription2>
<AccountToDescription3>string</AccountToDescription3>
<AccountToDescription4>string</AccountToDescription4>
<AccountToDescription5>string</AccountToDescription5>
<AccountToDescription6>string</AccountToDescription6>
<AccountToDescription7>string</AccountToDescription7>
</Silvergate.ESB.API.Transactions.Models.API.Account.Request.Transfer3>
{
"type": "object",
"properties": {
"SequenceNumber": {
"format": "int32",
"type": "integer"
},
"Amount": {
"format": "double",
"type": "number"
},
"AccountNumberFrom": {
"type": "string"
},
"AccountNumberTo": {
"type": "string"
},
"SerialNumber1": {
"type": "string"
},
"SerialNumber2": {
"type": "string"
},
"AccountFromDescription2": {
"type": "string"
},
"AccountFromDescription3": {
"type": "string"
},
"AccountFromDescription4": {
"type": "string"
},
"AccountFromDescription5": {
"type": "string"
},
"AccountFromDescription6": {
"type": "string"
},
"AccountFromDescription7": {
"type": "string"
},
"AccountToDescription2": {
"type": "string"
},
"AccountToDescription3": {
"type": "string"
},
"AccountToDescription4": {
"type": "string"
},
"AccountToDescription5": {
"type": "string"
},
"AccountToDescription6": {
"type": "string"
},
"AccountToDescription7": {
"type": "string"
}
}
}
<Silvergate.ESB.API.Transactions.Models.API.Account.Request.Transfer3>
<SequenceNumber>0</SequenceNumber>
<Amount>0</Amount>
<AccountNumberFrom>string</AccountNumberFrom>
<AccountNumberTo>string</AccountNumberTo>
<SerialNumber1>string</SerialNumber1>
<SerialNumber2>string</SerialNumber2>
<AccountFromDescription2>string</AccountFromDescription2>
<AccountFromDescription3>string</AccountFromDescription3>
<AccountFromDescription4>string</AccountFromDescription4>
<AccountFromDescription5>string</AccountFromDescription5>
<AccountFromDescription6>string</AccountFromDescription6>
<AccountFromDescription7>string</AccountFromDescription7>
<AccountToDescription2>string</AccountToDescription2>
<AccountToDescription3>string</AccountToDescription3>
<AccountToDescription4>string</AccountToDescription4>
<AccountToDescription5>string</AccountToDescription5>
<AccountToDescription6>string</AccountToDescription6>
<AccountToDescription7>string</AccountToDescription7>
</Silvergate.ESB.API.Transactions.Models.API.Account.Request.Transfer3>
{
"type": "object",
"properties": {
"SequenceNumber": {
"format": "int32",
"type": "integer"
},
"Amount": {
"format": "double",
"type": "number"
},
"AccountNumberFrom": {
"type": "string"
},
"AccountNumberTo": {
"type": "string"
},
"SerialNumber1": {
"type": "string"
},
"SerialNumber2": {
"type": "string"
},
"AccountFromDescription2": {
"type": "string"
},
"AccountFromDescription3": {
"type": "string"
},
"AccountFromDescription4": {
"type": "string"
},
"AccountFromDescription5": {
"type": "string"
},
"AccountFromDescription6": {
"type": "string"
},
"AccountFromDescription7": {
"type": "string"
},
"AccountToDescription2": {
"type": "string"
},
"AccountToDescription3": {
"type": "string"
},
"AccountToDescription4": {
"type": "string"
},
"AccountToDescription5": {
"type": "string"
},
"AccountToDescription6": {
"type": "string"
},
"AccountToDescription7": {
"type": "string"
}
}
}
Responses
200 OK
Account transfer was completed
Representations
{
"SEQUENCE": 0,
"MESSAGE": [
{
"MESSAGEID": "string",
"MESSAGETYPE": "string",
"MESSAGETEXT": "string"
}
],
"ERROR": [
{
"MESSAGEID": "string",
"SEGMENTID": "string",
"FIELDNAME": "string",
"ERRORMSG": "string"
}
]
}
{
"type": "object",
"properties": {
"SEQUENCE": {
"format": "int32",
"type": "integer"
},
"MESSAGE": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"MESSAGETYPE": {
"type": "string"
},
"MESSAGETEXT": {
"type": "string"
}
}
}
},
"ERROR": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"SEGMENTID": {
"type": "string"
},
"FIELDNAME": {
"type": "string"
},
"ERRORMSG": {
"type": "string"
}
}
}
}
}
}
{
"SEQUENCE": 0,
"MESSAGE": [
{
"MESSAGEID": "string",
"MESSAGETYPE": "string",
"MESSAGETEXT": "string"
}
],
"ERROR": [
{
"MESSAGEID": "string",
"SEGMENTID": "string",
"FIELDNAME": "string",
"ERRORMSG": "string"
}
]
}
{
"type": "object",
"properties": {
"SEQUENCE": {
"format": "int32",
"type": "integer"
},
"MESSAGE": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"MESSAGETYPE": {
"type": "string"
},
"MESSAGETEXT": {
"type": "string"
}
}
}
},
"ERROR": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"SEGMENTID": {
"type": "string"
},
"FIELDNAME": {
"type": "string"
},
"ERRORMSG": {
"type": "string"
}
}
}
}
}
}
<Silvergate.ESB.API.Transactions.Models.HX.Account.TrnsAddRs2>
<SEQUENCE>0</SEQUENCE>
<MESSAGE>
<MESSAGEID>string</MESSAGEID>
<MESSAGETYPE>string</MESSAGETYPE>
<MESSAGETEXT>string</MESSAGETEXT>
</MESSAGE>
<ERROR>
<MESSAGEID>string</MESSAGEID>
<SEGMENTID>string</SEGMENTID>
<FIELDNAME>string</FIELDNAME>
<ERRORMSG>string</ERRORMSG>
</ERROR>
</Silvergate.ESB.API.Transactions.Models.HX.Account.TrnsAddRs2>
{
"type": "object",
"properties": {
"SEQUENCE": {
"format": "int32",
"type": "integer"
},
"MESSAGE": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"MESSAGETYPE": {
"type": "string"
},
"MESSAGETEXT": {
"type": "string"
}
}
}
},
"ERROR": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"SEGMENTID": {
"type": "string"
},
"FIELDNAME": {
"type": "string"
},
"ERRORMSG": {
"type": "string"
}
}
}
}
}
}
<Silvergate.ESB.API.Transactions.Models.HX.Account.TrnsAddRs2>
<SEQUENCE>0</SEQUENCE>
<MESSAGE>
<MESSAGEID>string</MESSAGEID>
<MESSAGETYPE>string</MESSAGETYPE>
<MESSAGETEXT>string</MESSAGETEXT>
</MESSAGE>
<ERROR>
<MESSAGEID>string</MESSAGEID>
<SEGMENTID>string</SEGMENTID>
<FIELDNAME>string</FIELDNAME>
<ERRORMSG>string</ERRORMSG>
</ERROR>
</Silvergate.ESB.API.Transactions.Models.HX.Account.TrnsAddRs2>
{
"type": "object",
"properties": {
"SEQUENCE": {
"format": "int32",
"type": "integer"
},
"MESSAGE": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"MESSAGETYPE": {
"type": "string"
},
"MESSAGETEXT": {
"type": "string"
}
}
}
},
"ERROR": {
"type": "array",
"items": {
"type": "object",
"properties": {
"MESSAGEID": {
"type": "string"
},
"SEGMENTID": {
"type": "string"
},
"FIELDNAME": {
"type": "string"
},
"ERRORMSG": {
"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/account/transfersen"
-H "Authorization: "
-H "Idempotency-Key: "
-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("Idempotency-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://silvergate.azure-api.net/v2/account/transfersen?" + 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/account/transfersen");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("Idempotency-Key", "");
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/account/transfersen?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Idempotency-Key","");
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/account/transfersen";
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:@"" forHTTPHeaderField:@"Idempotency-Key"];
[_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/account/transfersen');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Idempotency-Key' => '',
'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': '',
'Idempotency-Key': '',
'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/account/transfersen?%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': '',
'Idempotency-Key': '',
'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/account/transfersen?%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/account/transfersen')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Idempotency-Key'] = ''
# 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