Silvergate API Service 2.0

This is our latest API good from April 2018 going forward

payment

Runs an action on a payment to approve, cancel, or return.

Put 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

Try it

Request

Request URL

https://silvergate.azure-api.net/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}&timestamp={timestamp}

Request parameters

account_number

string

The account number related to the selected payment_id.
payment_id

string

The ID of the payment.
action

string

Approve, cancel or return.
timestamp

string

Format - date-time (as date-time in RFC3339). Timestamp for payment returned upon POST or via GET payment.

Request headers

Authorization

string

jwt access token
Ocp-Apim-Subscription-Key

string

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

Request body

Responses

200 OK

Payment action sent successfully

{
  "payment_id": "string",
  "payment_status": "string",
  "payment_timestamp": "string"
}

{
  "type": "object",
  "properties": {
    "payment_id": {
      "type": "string"
    },
    "payment_status": {
      "type": "string"
    },
    "payment_timestamp": {
      "type": "string"
    }
  }
}

Sample
Schema

{
  "payment_id": "string",
  "payment_status": "string",
  "payment_timestamp": "string"
}

{
  "type": "object",
  "properties": {
    "payment_id": {
      "type": "string"
    },
    "payment_status": {
      "type": "string"
    },
    "payment_timestamp": {
      "type": "string"
    }
  }
}

Sample
Schema

<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"
    }
  }
}

Sample
Schema

<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 PUT "https://silvergate.azure-api.net/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}"
-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}");

            var uri = "https://silvergate.azure-api.net/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}&" + 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.PutAsync(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?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(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
        };
      
        $.ajax({
            url: "https://silvergate.azure-api.net/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}";
    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:@"PUT"];
    // 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/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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({
})

try:
    conn = httplib.HTTPSConnection('silvergate.azure-api.net')
    conn.request("PUT", "/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}&%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({
})

try:
    conn = http.client.HTTPSConnection('silvergate.azure-api.net')
    conn.request("PUT", "/v2/payment?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}&%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?account_number={account_number}&payment_id={payment_id}&action={action}×tamp={timestamp}')


request = Net::HTTP::Put.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