Silvergate API Service 2.0

API change history

This is our latest API good from April 2018 going forward

account/wiresummary

Queries e-wire data and returns the resultant records.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Account number for the account you're running inquiry on

  • (optional)
    integer

    Format - int32. The sequence number helps match input requests and output responses, it does not get stored in any transactional record

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). Format – date (example YYYY-MM-DD). It is optional only if UniqueId is provided.

  • (optional)
    string

    Indicator to return either incoming or outgoing requests. I - Incoming, O - Outgoing - Optional if Unique ID is provided

  • (optional)
    string

    The transaction number from a wire transfer

  • (optional)
    string

    This Id is returned on a previous history call, or from a wire inquiry. This Id is returned on a previous history call, or from a wire inquiry. Contact us or see blog post for details.

Request headers

  • string

    jwt access token

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

New Account Created successfully

Representations

{
  "Errors": [
    {
      "MESSAGEID": "string",
      "MESSAGETYPE": "string",
      "SEGMENTID": "string",
      "SEGMENT_OCCUR": "string",
      "FIELDNAME": "string",
      "ERRORMSG": "string"
    }
  ],
  "SequenceNumber": 0,
  "RecordCount": 0,
  "EwireSummaries": [
    {
      "TransactionNumber_1": "string",
      "Amount_12": 0.0,
      "FedWireType_17": "string",
      "FedwireSubType_18": "string",
      "SourceIndicator_21": "string",
      "ReferenceForBeneficiary_22": "string",
      "SendingBankId_25": "string",
      "SendingBankName_26": "string",
      "OriginatorId_43": "string",
      "Name_44": "string",
      "BeneficiaryId_70": "string",
      "Name_71": "string",
      "OriginatorToBeneficiaryInfoLine1_96": "string",
      "OriginatorToBeneficiaryInfoLine2_97": "string",
      "OriginatorToBeneficiaryInfoLine3_98": "string",
      "OriginatorToBeneficiaryInfoLine4_99": "string",
      "ImadCycleDate_117": "string",
      "ImadCalendarDate_118": "string",
      "ImadApplicationId_119": "string",
      "Imsn_120": "string",
      "ImadLtermId_121": "string",
      "ImadTime_122": "string",
      "Status": "string",
      "UniqueId": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "Errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "MESSAGEID": {
            "type": "string"
          },
          "MESSAGETYPE": {
            "type": "string"
          },
          "SEGMENTID": {
            "type": "string"
          },
          "SEGMENT_OCCUR": {
            "type": "string"
          },
          "FIELDNAME": {
            "type": "string"
          },
          "ERRORMSG": {
            "type": "string"
          }
        }
      }
    },
    "SequenceNumber": {
      "format": "int32",
      "type": "integer"
    },
    "RecordCount": {
      "format": "int32",
      "type": "integer"
    },
    "EwireSummaries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "TransactionNumber_1": {
            "type": "string"
          },
          "Amount_12": {
            "format": "double",
            "type": "number"
          },
          "FedWireType_17": {
            "type": "string"
          },
          "FedwireSubType_18": {
            "type": "string"
          },
          "SourceIndicator_21": {
            "type": "string"
          },
          "ReferenceForBeneficiary_22": {
            "type": "string"
          },
          "SendingBankId_25": {
            "type": "string"
          },
          "SendingBankName_26": {
            "type": "string"
          },
          "OriginatorId_43": {
            "type": "string"
          },
          "Name_44": {
            "type": "string"
          },
          "BeneficiaryId_70": {
            "type": "string"
          },
          "Name_71": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine1_96": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine2_97": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine3_98": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine4_99": {
            "type": "string"
          },
          "ImadCycleDate_117": {
            "type": "string"
          },
          "ImadCalendarDate_118": {
            "type": "string"
          },
          "ImadApplicationId_119": {
            "type": "string"
          },
          "Imsn_120": {
            "type": "string"
          },
          "ImadLtermId_121": {
            "type": "string"
          },
          "ImadTime_122": {
            "type": "string"
          },
          "Status": {
            "type": "string"
          },
          "UniqueId": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "Errors": [
    {
      "MESSAGEID": "string",
      "MESSAGETYPE": "string",
      "SEGMENTID": "string",
      "SEGMENT_OCCUR": "string",
      "FIELDNAME": "string",
      "ERRORMSG": "string"
    }
  ],
  "SequenceNumber": 0,
  "RecordCount": 0,
  "EwireSummaries": [
    {
      "TransactionNumber_1": "string",
      "Amount_12": 0.0,
      "FedWireType_17": "string",
      "FedwireSubType_18": "string",
      "SourceIndicator_21": "string",
      "ReferenceForBeneficiary_22": "string",
      "SendingBankId_25": "string",
      "SendingBankName_26": "string",
      "OriginatorId_43": "string",
      "Name_44": "string",
      "BeneficiaryId_70": "string",
      "Name_71": "string",
      "OriginatorToBeneficiaryInfoLine1_96": "string",
      "OriginatorToBeneficiaryInfoLine2_97": "string",
      "OriginatorToBeneficiaryInfoLine3_98": "string",
      "OriginatorToBeneficiaryInfoLine4_99": "string",
      "ImadCycleDate_117": "string",
      "ImadCalendarDate_118": "string",
      "ImadApplicationId_119": "string",
      "Imsn_120": "string",
      "ImadLtermId_121": "string",
      "ImadTime_122": "string",
      "Status": "string",
      "UniqueId": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "Errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "MESSAGEID": {
            "type": "string"
          },
          "MESSAGETYPE": {
            "type": "string"
          },
          "SEGMENTID": {
            "type": "string"
          },
          "SEGMENT_OCCUR": {
            "type": "string"
          },
          "FIELDNAME": {
            "type": "string"
          },
          "ERRORMSG": {
            "type": "string"
          }
        }
      }
    },
    "SequenceNumber": {
      "format": "int32",
      "type": "integer"
    },
    "RecordCount": {
      "format": "int32",
      "type": "integer"
    },
    "EwireSummaries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "TransactionNumber_1": {
            "type": "string"
          },
          "Amount_12": {
            "format": "double",
            "type": "number"
          },
          "FedWireType_17": {
            "type": "string"
          },
          "FedwireSubType_18": {
            "type": "string"
          },
          "SourceIndicator_21": {
            "type": "string"
          },
          "ReferenceForBeneficiary_22": {
            "type": "string"
          },
          "SendingBankId_25": {
            "type": "string"
          },
          "SendingBankName_26": {
            "type": "string"
          },
          "OriginatorId_43": {
            "type": "string"
          },
          "Name_44": {
            "type": "string"
          },
          "BeneficiaryId_70": {
            "type": "string"
          },
          "Name_71": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine1_96": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine2_97": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine3_98": {
            "type": "string"
          },
          "OriginatorToBeneficiaryInfoLine4_99": {
            "type": "string"
          },
          "ImadCycleDate_117": {
            "type": "string"
          },
          "ImadCalendarDate_118": {
            "type": "string"
          },
          "ImadApplicationId_119": {
            "type": "string"
          },
          "Imsn_120": {
            "type": "string"
          },
          "ImadLtermId_121": {
            "type": "string"
          },
          "ImadTime_122": {
            "type": "string"
          },
          "Status": {
            "type": "string"
          },
          "UniqueId": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

Invalid request information

401 Unauthorized

Access Information cannot be Authenticated

503 Service Unavailable

Host connection cannot be established

Code samples

@ECHO OFF

curl -v -X GET "https://silvergate.azure-api.net/v2/account/wiresummary?accountNumber={string}&sequenceNumber={integer}&date={string}&sourceIndicator=I&transactionNumber={string}&uniqueId={string}"
-H "Authorization: "
-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}");

            // Request parameters
            queryString["accountNumber"] = "{string}";
            queryString["sequenceNumber"] = "{integer}";
            queryString["date"] = "{string}";
            queryString["sourceIndicator"] = "I";
            queryString["transactionNumber"] = "{string}";
            queryString["uniqueId"] = "{string}";
            var uri = "https://silvergate.azure-api.net/v2/account/wiresummary?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/wiresummary");

            builder.setParameter("accountNumber", "{string}");
            builder.setParameter("sequenceNumber", "{integer}");
            builder.setParameter("date", "{string}");
            builder.setParameter("sourceIndicator", "I");
            builder.setParameter("transactionNumber", "{string}");
            builder.setParameter("uniqueId", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "");
            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
            "accountNumber": "{string}",
            "sequenceNumber": "{integer}",
            "date": "{string}",
            "sourceIndicator": "I",
            "transactionNumber": "{string}",
            "uniqueId": "{string}",
        };
      
        $.ajax({
            url: "https://silvergate.azure-api.net/v2/account/wiresummary?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/wiresummary";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"accountNumber={string}",
                         @"sequenceNumber={integer}",
                         @"date={string}",
                         @"sourceIndicator=I",
                         @"transactionNumber={string}",
                         @"uniqueId={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_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/wiresummary');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'accountNumber' => '{string}',
    'sequenceNumber' => '{integer}',
    'date' => '{string}',
    'sourceIndicator' => 'I',
    'transactionNumber' => '{string}',
    'uniqueId' => '{string}',
);

$url->setQueryVariables($parameters);

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

// 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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'accountNumber': '{string}',
    'sequenceNumber': '{integer}',
    'date': '{string}',
    'sourceIndicator': 'I',
    'transactionNumber': '{string}',
    'uniqueId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('silvergate.azure-api.net')
    conn.request("GET", "/v2/account/wiresummary?%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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'accountNumber': '{string}',
    'sequenceNumber': '{integer}',
    'date': '{string}',
    'sourceIndicator': 'I',
    'transactionNumber': '{string}',
    'uniqueId': '{string}',
})

try:
    conn = http.client.HTTPSConnection('silvergate.azure-api.net')
    conn.request("GET", "/v2/account/wiresummary?%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/wiresummary')

query = URI.encode_www_form({
    # Request parameters
    'accountNumber' => '{string}',
    'sequenceNumber' => '{integer}',
    'date' => '{string}',
    'sourceIndicator' => 'I',
    'transactionNumber' => '{string}',
    'uniqueId' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# 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