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
Initiate Payment Model
| Field Name | Description | Data Type | Max Length | Sample | Opt/Req |
|---|---|---|---|---|---|
| originator_account_number | The account from which the sending dollar amount debit will occur | string | 20 | 999999999999 | Required |
| amount | The US dollar amount of the transfer | decimal | 13 | 250.50 | Required |
| receiving_bank_routing_id | The ABA number of the receiving bank facilitating the transfer | string | 9 | 123456789 | Optional |
| receiving_bank_name | The name of the receiving bank | string | 35 | Users Bank | Optional |
| receiving_bank_address1 | The address of the receiving bank | String | 35 | 2200 Break St. | Optional |
| receiving_bank_address2 | The address of the receiving bank | String | 35 | #3 | Optional |
| receiving_bank_address3 | The address of the receiving bank | String | 35 | CA, USA | Optional |
| intermediary_bank_type | Routing method for ultimate destination of funds | String | 5 | ABA, SWIFT | Optional |
| intermediary_bank_routing_id | The SWIFT or ABA or Account number of the intermediary bank facilitating the transfer | String | 11 | 123456789 | Optional |
| intermediary_bank_name | The name of the intermediary bank | String | 35 | End Bank | Optional |
| intermediary_bank_address1 | The address of the intermediary bank | String | 35 | 2200 Break St. | Optional |
| intermediary_bank_address2 | The address of the intermediary bank | String | 35 | #4 | Optional |
| intermediary_bank_address3 | The address of the intermediary bank | String | 35 | CA, USA | Optional |
| beneficiary_bank_type | Routing method for ultimate destination of funds | String | 5 | ABA, SWIFT | Optional |
| beneficiary_bank_routing_id | This is either the ABA routing number of the beneficiary bank or the SWIFT BIC (Bank Identifier Code) or Account Number | String | 11 | 123456789 | Optional |
| beneficiary_bank_name | The name of the beneficiary bank | String | 35 | Optional | |
| beneficiary_bank_address1 | The address of the beneficiary bank | String | 35 | 2200 Break St. | Optional |
| beneficiary_bank_address2 | The address of the beneficiary bank | String | 35 | #3 | Optional |
| beneficiary_bank_address3 | The address of the beneficiary bank | String | 35 | CA, USA | Optional |
| beneficiary_name | The name of the beneficiary | String | 35 | Receivers Bank | Required |
| beneficiary_account_number | The account number of the beneficiary | String | 35 | Required | |
| beneficiary_address1 | The address of the beneficiary | String | 35 | 19567 Some St. | Required |
| beneficiary_address2 | The address of the beneficiary | String | 35 | #789 | Optional |
| beneficiary_address3 | The address of the beneficiary | String | 35 | Phoenix, AZ USA | Optional |
| originator_to_beneficiary_info | Comments field can be used to send reference codes | String | 140 | Optional |
Initiate Payment Response
| Field Name | Description | Data Type | Max Length | Sample |
|---|---|---|---|---|
| payment_id | Unique identifier assigned by the bank's payment system. It can be used with GET payment to query for a specific transaction. It is required when using PUT payment to approve, cancel, or return an incoming payment. It is also added to the GET account/history request and response so that it can be used to reference the transaction in the wire system with the associated transaction when it hits the bank account. | string | 20 | J012345678ABCDEF |
| status | Value indicating status of the payment. Possible values include: "Pre-Approval","In-Progress","Canceled", or "Complete" | string | 20 | Pre-Approval |
| timestamp | Most recent timestamp when the status of the payment changed. This value is required along with the payment_id in order to use the PUT operation. | date time | 23 | YYYY-MM-DD 00:00:00.000 |
{
"originator_account_number": "string",
"amount": 0.0,
"receiving_bank_routing_id": "string",
"receiving_bank_name": "string",
"receiving_bank_address1": "string",
"receiving_bank_address2": "string",
"receiving_bank_address3": "string",
"intermediary_bank_type": "string",
"intermediary_bank_routing_id": "string",
"intermediary_bank_account_number": "string",
"intermediary_bank_name": "string",
"intermediary_bank_address1": "string",
"intermediary_bank_address2": "string",
"intermediary_bank_address3": "string",
"beneficiary_bank_type": "string",
"beneficiary_bank_routing_id": "string",
"beneficiary_bank_name": "string",
"beneficiary_bank_address1": "string",
"beneficiary_bank_address2": "string",
"beneficiary_bank_address3": "string",
"beneficiary_name": "string",
"beneficiary_account_number": "string",
"beneficiary_address1": "string",
"beneficiary_address2": "string",
"beneficiary_address3": "string",
"originator_to_beneficiary_info": "string"
}{
"type": "object",
"properties": {
"originator_account_number": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"receiving_bank_routing_id": {
"type": "string"
},
"receiving_bank_name": {
"type": "string"
},
"receiving_bank_address1": {
"type": "string"
},
"receiving_bank_address2": {
"type": "string"
},
"receiving_bank_address3": {
"type": "string"
},
"intermediary_bank_type": {
"type": "string"
},
"intermediary_bank_routing_id": {
"type": "string"
},
"intermediary_bank_account_number": {
"type": "string"
},
"intermediary_bank_name": {
"type": "string"
},
"intermediary_bank_address1": {
"type": "string"
},
"intermediary_bank_address2": {
"type": "string"
},
"intermediary_bank_address3": {
"type": "string"
},
"beneficiary_bank_type": {
"type": "string"
},
"beneficiary_bank_routing_id": {
"type": "string"
},
"beneficiary_bank_name": {
"type": "string"
},
"beneficiary_bank_address1": {
"type": "string"
},
"beneficiary_bank_address2": {
"type": "string"
},
"beneficiary_bank_address3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_account_number": {
"type": "string"
},
"beneficiary_address1": {
"type": "string"
},
"beneficiary_address2": {
"type": "string"
},
"beneficiary_address3": {
"type": "string"
},
"originator_to_beneficiary_info": {
"type": "string"
}
}
}{
"originator_account_number": "string",
"amount": 0.0,
"receiving_bank_routing_id": "string",
"receiving_bank_name": "string",
"receiving_bank_address1": "string",
"receiving_bank_address2": "string",
"receiving_bank_address3": "string",
"intermediary_bank_type": "string",
"intermediary_bank_routing_id": "string",
"intermediary_bank_account_number": "string",
"intermediary_bank_name": "string",
"intermediary_bank_address1": "string",
"intermediary_bank_address2": "string",
"intermediary_bank_address3": "string",
"beneficiary_bank_type": "string",
"beneficiary_bank_routing_id": "string",
"beneficiary_bank_name": "string",
"beneficiary_bank_address1": "string",
"beneficiary_bank_address2": "string",
"beneficiary_bank_address3": "string",
"beneficiary_name": "string",
"beneficiary_account_number": "string",
"beneficiary_address1": "string",
"beneficiary_address2": "string",
"beneficiary_address3": "string",
"originator_to_beneficiary_info": "string"
}{
"type": "object",
"properties": {
"originator_account_number": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"receiving_bank_routing_id": {
"type": "string"
},
"receiving_bank_name": {
"type": "string"
},
"receiving_bank_address1": {
"type": "string"
},
"receiving_bank_address2": {
"type": "string"
},
"receiving_bank_address3": {
"type": "string"
},
"intermediary_bank_type": {
"type": "string"
},
"intermediary_bank_routing_id": {
"type": "string"
},
"intermediary_bank_account_number": {
"type": "string"
},
"intermediary_bank_name": {
"type": "string"
},
"intermediary_bank_address1": {
"type": "string"
},
"intermediary_bank_address2": {
"type": "string"
},
"intermediary_bank_address3": {
"type": "string"
},
"beneficiary_bank_type": {
"type": "string"
},
"beneficiary_bank_routing_id": {
"type": "string"
},
"beneficiary_bank_name": {
"type": "string"
},
"beneficiary_bank_address1": {
"type": "string"
},
"beneficiary_bank_address2": {
"type": "string"
},
"beneficiary_bank_address3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_account_number": {
"type": "string"
},
"beneficiary_address1": {
"type": "string"
},
"beneficiary_address2": {
"type": "string"
},
"beneficiary_address3": {
"type": "string"
},
"originator_to_beneficiary_info": {
"type": "string"
}
}
}<Silvergate.ESB.API.Transactions.models.API.Payment.InitiatePaymentRequest>
<originator_account_number>string</originator_account_number>
<amount>0</amount>
<receiving_bank_routing_id>string</receiving_bank_routing_id>
<receiving_bank_name>string</receiving_bank_name>
<receiving_bank_address1>string</receiving_bank_address1>
<receiving_bank_address2>string</receiving_bank_address2>
<receiving_bank_address3>string</receiving_bank_address3>
<intermediary_bank_type>string</intermediary_bank_type>
<intermediary_bank_routing_id>string</intermediary_bank_routing_id>
<intermediary_bank_account_number>string</intermediary_bank_account_number>
<intermediary_bank_name>string</intermediary_bank_name>
<intermediary_bank_address1>string</intermediary_bank_address1>
<intermediary_bank_address2>string</intermediary_bank_address2>
<intermediary_bank_address3>string</intermediary_bank_address3>
<beneficiary_bank_type>string</beneficiary_bank_type>
<beneficiary_bank_routing_id>string</beneficiary_bank_routing_id>
<beneficiary_bank_name>string</beneficiary_bank_name>
<beneficiary_bank_address1>string</beneficiary_bank_address1>
<beneficiary_bank_address2>string</beneficiary_bank_address2>
<beneficiary_bank_address3>string</beneficiary_bank_address3>
<beneficiary_name>string</beneficiary_name>
<beneficiary_account_number>string</beneficiary_account_number>
<beneficiary_address1>string</beneficiary_address1>
<beneficiary_address2>string</beneficiary_address2>
<beneficiary_address3>string</beneficiary_address3>
<originator_to_beneficiary_info>string</originator_to_beneficiary_info>
</Silvergate.ESB.API.Transactions.models.API.Payment.InitiatePaymentRequest>{
"type": "object",
"properties": {
"originator_account_number": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"receiving_bank_routing_id": {
"type": "string"
},
"receiving_bank_name": {
"type": "string"
},
"receiving_bank_address1": {
"type": "string"
},
"receiving_bank_address2": {
"type": "string"
},
"receiving_bank_address3": {
"type": "string"
},
"intermediary_bank_type": {
"type": "string"
},
"intermediary_bank_routing_id": {
"type": "string"
},
"intermediary_bank_account_number": {
"type": "string"
},
"intermediary_bank_name": {
"type": "string"
},
"intermediary_bank_address1": {
"type": "string"
},
"intermediary_bank_address2": {
"type": "string"
},
"intermediary_bank_address3": {
"type": "string"
},
"beneficiary_bank_type": {
"type": "string"
},
"beneficiary_bank_routing_id": {
"type": "string"
},
"beneficiary_bank_name": {
"type": "string"
},
"beneficiary_bank_address1": {
"type": "string"
},
"beneficiary_bank_address2": {
"type": "string"
},
"beneficiary_bank_address3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_account_number": {
"type": "string"
},
"beneficiary_address1": {
"type": "string"
},
"beneficiary_address2": {
"type": "string"
},
"beneficiary_address3": {
"type": "string"
},
"originator_to_beneficiary_info": {
"type": "string"
}
}
}<Silvergate.ESB.API.Transactions.models.API.Payment.InitiatePaymentRequest>
<originator_account_number>string</originator_account_number>
<amount>0</amount>
<receiving_bank_routing_id>string</receiving_bank_routing_id>
<receiving_bank_name>string</receiving_bank_name>
<receiving_bank_address1>string</receiving_bank_address1>
<receiving_bank_address2>string</receiving_bank_address2>
<receiving_bank_address3>string</receiving_bank_address3>
<intermediary_bank_type>string</intermediary_bank_type>
<intermediary_bank_routing_id>string</intermediary_bank_routing_id>
<intermediary_bank_account_number>string</intermediary_bank_account_number>
<intermediary_bank_name>string</intermediary_bank_name>
<intermediary_bank_address1>string</intermediary_bank_address1>
<intermediary_bank_address2>string</intermediary_bank_address2>
<intermediary_bank_address3>string</intermediary_bank_address3>
<beneficiary_bank_type>string</beneficiary_bank_type>
<beneficiary_bank_routing_id>string</beneficiary_bank_routing_id>
<beneficiary_bank_name>string</beneficiary_bank_name>
<beneficiary_bank_address1>string</beneficiary_bank_address1>
<beneficiary_bank_address2>string</beneficiary_bank_address2>
<beneficiary_bank_address3>string</beneficiary_bank_address3>
<beneficiary_name>string</beneficiary_name>
<beneficiary_account_number>string</beneficiary_account_number>
<beneficiary_address1>string</beneficiary_address1>
<beneficiary_address2>string</beneficiary_address2>
<beneficiary_address3>string</beneficiary_address3>
<originator_to_beneficiary_info>string</originator_to_beneficiary_info>
</Silvergate.ESB.API.Transactions.models.API.Payment.InitiatePaymentRequest>{
"type": "object",
"properties": {
"originator_account_number": {
"type": "string"
},
"amount": {
"format": "double",
"type": "number"
},
"receiving_bank_routing_id": {
"type": "string"
},
"receiving_bank_name": {
"type": "string"
},
"receiving_bank_address1": {
"type": "string"
},
"receiving_bank_address2": {
"type": "string"
},
"receiving_bank_address3": {
"type": "string"
},
"intermediary_bank_type": {
"type": "string"
},
"intermediary_bank_routing_id": {
"type": "string"
},
"intermediary_bank_account_number": {
"type": "string"
},
"intermediary_bank_name": {
"type": "string"
},
"intermediary_bank_address1": {
"type": "string"
},
"intermediary_bank_address2": {
"type": "string"
},
"intermediary_bank_address3": {
"type": "string"
},
"beneficiary_bank_type": {
"type": "string"
},
"beneficiary_bank_routing_id": {
"type": "string"
},
"beneficiary_bank_name": {
"type": "string"
},
"beneficiary_bank_address1": {
"type": "string"
},
"beneficiary_bank_address2": {
"type": "string"
},
"beneficiary_bank_address3": {
"type": "string"
},
"beneficiary_name": {
"type": "string"
},
"beneficiary_account_number": {
"type": "string"
},
"beneficiary_address1": {
"type": "string"
},
"beneficiary_address2": {
"type": "string"
},
"beneficiary_address3": {
"type": "string"
},
"originator_to_beneficiary_info": {
"type": "string"
}
}
}Responses
200 OK
Payment sent successfully
Representations
{
"payment_id": "string",
"payment_status": "string",
"payment_timestamp": "string"
}{
"type": "object",
"properties": {
"payment_id": {
"type": "string"
},
"payment_status": {
"type": "string"
},
"payment_timestamp": {
"type": "string"
}
}
}{
"payment_id": "string",
"payment_status": "string",
"payment_timestamp": "string"
}{
"type": "object",
"properties": {
"payment_id": {
"type": "string"
},
"payment_status": {
"type": "string"
},
"payment_timestamp": {
"type": "string"
}
}
}<Silvergate.ESB.API.Transactions.models.API.Payment.PaymentResponse>
<payment_id>string</payment_id>
<payment_status>string</payment_status>
<payment_timestamp>string</payment_timestamp>
</Silvergate.ESB.API.Transactions.models.API.Payment.PaymentResponse>{
"type": "object",
"properties": {
"payment_id": {
"type": "string"
},
"payment_status": {
"type": "string"
},
"payment_timestamp": {
"type": "string"
}
}
}<Silvergate.ESB.API.Transactions.models.API.Payment.PaymentResponse>
<payment_id>string</payment_id>
<payment_status>string</payment_status>
<payment_timestamp>string</payment_timestamp>
</Silvergate.ESB.API.Transactions.models.API.Payment.PaymentResponse>{
"type": "object",
"properties": {
"payment_id": {
"type": "string"
},
"payment_status": {
"type": "string"
},
"payment_timestamp": {
"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/payment"
-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/payment?" + 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/payment");
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/payment?" + $.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/payment";
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/payment');
$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/payment?%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/payment?%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/payment')
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