Silvergate API Service 2.0

This is our latest API good from April 2018 going forward

payment

Retrieves detailed data for one or many payments.

Get Payment Response

Field Name	Description	Fed Tag	Data Type	Max Length	Sample data
status	status of the payment
payment_id	Unique identifier assigned by the wire system		string	15	J123456789123456
payment_date	Date on which the payment is processed		string - date	10	42984
amount	amount of the payment	2000	numeric	10	10000000
fedwire_type	Type of fed-wire payment	1510	string	10	10
fedwire_sub_type	Type of payment: (00 = standard, 02 = same day return, 08 = non same day return)	1510	string	10	08, 00, 02
direction	Direction of payment		string	10	Incoming, Outgoing
reference_for_beneficiary	Reference information sometimes passed with the payment		string	16	1709061625000030
senders_reference	Reference information sometimes passed with the payment		string	16	3230758800055350
sending_bank_type	Type indicates routing method of sending bank	3100	string	10
sending_bank_id	This is the routing or account number associated with sending the funds	3100	string	10	325181248
sending_bank_name	This is the bank name associated with sending the funds	3100	string	35	Example Fed Bank
sending_bank_address	The address associated with the sending of funds	3100	string	40	101 Main St.
receiving_bank_type	Type indicates routing method of payment of receiving bank	3400	string	10
receiving_bank_id	This is the routing or account number associated with receiving the funds	3400	string	11	323371076
receiving_bank_name	This is the bank name associated with receiving the funds	3400	string	35	Example Fed Bank
receiving_bank_address	The address associated with receiving the funds	3400	string	40	101 Main St.
originator_type	Type indicates account type of originator	5000/5010	string	10
originator_id	This is the account number of the originator	5000/5010	string	29	205000100013506
originator_name	This is the name of the originator	5000/5010	string	35	Satoshi Nakamoto
originator_address	This is the address of the originator	5000/5010	string	35	100 Main St.
originating_bank_type	Type indicates account type of originator bank	5100	string	10
originating_bank_type_id	This is the account number of the originator bank	5100	string	14	BANKXXXXX
originating_bank_type_name	This is the name of the originator bank	5100	string	35	Fake Bank
originating_bank_type_address	This is the address of the originator bank	5100	string	35	100 Main St.
instructing_bank_type	Type indicates account type of instructing bank	5200	string	10
instructing_bank_id	This is the account number of the instructing bank	5200	string	11	BANKXXXXX
instructing_bank_name	This is the name of the instructing bank	5200	string	35	Fake Bank
instructing_bank_address	This is the address of the instructing bank	5200	string	35	100 Main St.
beneficiary_type	Type indicates account type of beneficiary	4200	string	10	0
beneficiary_id	This is the account number of the beneficiary	4200	string	24	1234567890
beneficiary_name	This is the name of the beneficiary	4200	string	35	Beneficiary Name
beneficiary_address	This is the address of the beneficiary	4200	string	35	101 address
beneficiary_bank_type	Type indicates account type of beneficiary bank	4100	string	10
beneficiary_bank_id	This is the account number of the beneficiary bank	4100	string	15	110000100010240
beneficiary_bank_name	This is the name of the beneficiary bank	4100	string	35	FRB WIRE SETTLEMENT
beneficiary_bank_address	This is the address of the beneficiary bank	4100	string	35	101 address
intermediary_bank_type	Type indicates account type of intermediary bank	4000	string	40
intermediary_bank_id	This is the account number of the intermediary bank	4000	string	40	1234567890
intermediary_bank_name	This is the name of the intermediary bank	4000	string	40	Intermediary Name
intermediary_bank_address	This is the address of the intermediary bank	4000	string	40	101 address
originator_to_beneficiary_info_line	Reference notes passed along with the payment		string	35	322286803
imad	Imad data		string	10	20170906
omad	Omad data		string - date	10	20170906
entry_date	Payment create date		string - date	16	42985
completion_date	Payment settlement date		string - date	10	42984
cancel_date	Payment cancel date		string - date	10	42984
beneficiary_country_code	Country code for beneficiary, if available
beneficiary_bank_country_code	Country code for beneficiary bank, if available
debit_account_id	Account number of the sender		string	15	9999999999
credit_account_id	Account number of the receiver		string	15	9999999999
direction	Indicates the direction of the payment (ie withdrawal/outgoing or deposit/incoming).				" Incoming","Outgoing", or "Internal"
timestamp	Last status change timestamp, needed for PUT API operation

Try it

Request

Request URL

https://silvergate.azure-api.net/v2/payment?account_number={account_number}[&payment_id][&begin_date][&end_date][&sort_order][&page_size][&page_number]

Request parameters

account_number

string

Account number for either incoming payment. This translates in the response to "beneficiary_id" for an incoming payment or "originator_id" for an outgoing payment.
payment_id (optional)

string

A unique identifier for a wire payment which is also available in the account/history request and response.
begin_date (optional)

string

Format - date-time (as date-time in RFC3339). The begin date of the search request. Responses will be greater than or equal to this date. Date is required if not sending a "payment_id", else it is optional.
end_date (optional)

string

Format - date-time (as date-time in RFC3339). The end date of the search request. Responses will be less than or equal to this date. If "begin_date" passed but no "end_date" we will default "end_date value" to current date. "End_date" must be within 32 days of "begin_date".
sort_order (optional)

string

Sets the order of transactions returned in the response.
page_size (optional)

integer

Format - int32. Number of transactions to be displayed in the response. Defaults to 1,000 records.
page_number (optional)

integer

Format - int32. Specifies the page number of the request. Defaults to page 1.

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

Payments returned successfully

[
  {
    "payment_status": "string",
    "payment_id": "string",
    "payment_date": "string",
    "amount": 0.0,
    "fedwire_type": "string",
    "fedwire_sub_type": "string",
    "source_indicator": "string",
    "reference_for_beneficiary": "string",
    "senders_reference": "string",
    "sending_bank_type": "string",
    "sending_bank_id": "string",
    "sending_bank_name": "string",
    "sending_bank_address": "string",
    "receiving_bank_type": "string",
    "receiving_bank_id": "string",
    "receiving_bank_name": "string",
    "receiving_bank_address": "string",
    "originator_type": "string",
    "originator_id": "string",
    "originator_name": "string",
    "originator_address": "string",
    "originating_bank_type": "string",
    "originating_bank_id": "string",
    "originating_bank_swift_bic": "string",
    "originating_bank_name": "string",
    "originating_bank_address": "string",
    "instructing_bank_type": "string",
    "instructing_bank_id": "string",
    "instructing_bank_swift_bic": "string",
    "instructing_bank_name": "string",
    "instructing_bank_address": "string",
    "beneficiary_type": "string",
    "beneficiary_id": "string",
    "beneficiary_name": "string",
    "beneficiary_address": "string",
    "beneficiary_bank_type": "string",
    "beneficiary_bank_id": "string",
    "beneficiary_bank_swift_bic": "string",
    "beneficiary_bank_name": "string",
    "beneficiary_bank_address": "string",
    "intermediary_bank_type": "string",
    "intermediary_bank_id": "string",
    "intermediary_bank_swift_bic": "string",
    "intermediary_bank_name": "string",
    "intermediary_bank_address": "string",
    "originator_to_beneficiary_info_line": "string",
    "bank_to_bank_info_line1": "string",
    "imad": "string",
    "omad": "string",
    "entry_date": "string",
    "completion_date": "string",
    "cancel_date": "string",
    "beneficiary_country_code": "string",
    "beneficiary_bank_country_code": "string",
    "debit_account_type": "string",
    "debit_account_id": "string",
    "credit_account_id": "string",
    "direction": "string",
    "time_stamp": "string",
    "swift_uetr": "string",
    "reference_id": "string",
    "rejection_reason": "string"
  }
]

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "payment_status": {
        "type": "string"
      },
      "payment_id": {
        "type": "string"
      },
      "payment_date": {
        "format": "date-time",
        "type": "string"
      },
      "amount": {
        "format": "double",
        "type": "number"
      },
      "fedwire_type": {
        "type": "string"
      },
      "fedwire_sub_type": {
        "type": "string"
      },
      "source_indicator": {
        "type": "string"
      },
      "reference_for_beneficiary": {
        "type": "string"
      },
      "senders_reference": {
        "type": "string"
      },
      "sending_bank_type": {
        "type": "string"
      },
      "sending_bank_id": {
        "type": "string"
      },
      "sending_bank_name": {
        "type": "string"
      },
      "sending_bank_address": {
        "type": "string"
      },
      "receiving_bank_type": {
        "type": "string"
      },
      "receiving_bank_id": {
        "type": "string"
      },
      "receiving_bank_name": {
        "type": "string"
      },
      "receiving_bank_address": {
        "type": "string"
      },
      "originator_type": {
        "type": "string"
      },
      "originator_id": {
        "type": "string"
      },
      "originator_name": {
        "type": "string"
      },
      "originator_address": {
        "type": "string"
      },
      "originating_bank_type": {
        "type": "string"
      },
      "originating_bank_id": {
        "type": "string"
      },
      "originating_bank_swift_bic": {
        "type": "string"
      },
      "originating_bank_name": {
        "type": "string"
      },
      "originating_bank_address": {
        "type": "string"
      },
      "instructing_bank_type": {
        "type": "string"
      },
      "instructing_bank_id": {
        "type": "string"
      },
      "instructing_bank_swift_bic": {
        "type": "string"
      },
      "instructing_bank_name": {
        "type": "string"
      },
      "instructing_bank_address": {
        "type": "string"
      },
      "beneficiary_type": {
        "type": "string"
      },
      "beneficiary_id": {
        "type": "string"
      },
      "beneficiary_name": {
        "type": "string"
      },
      "beneficiary_address": {
        "type": "string"
      },
      "beneficiary_bank_type": {
        "type": "string"
      },
      "beneficiary_bank_id": {
        "type": "string"
      },
      "beneficiary_bank_swift_bic": {
        "type": "string"
      },
      "beneficiary_bank_name": {
        "type": "string"
      },
      "beneficiary_bank_address": {
        "type": "string"
      },
      "intermediary_bank_type": {
        "type": "string"
      },
      "intermediary_bank_id": {
        "type": "string"
      },
      "intermediary_bank_swift_bic": {
        "type": "string"
      },
      "intermediary_bank_name": {
        "type": "string"
      },
      "intermediary_bank_address": {
        "type": "string"
      },
      "originator_to_beneficiary_info_line": {
        "type": "string"
      },
      "bank_to_bank_info_line1": {
        "type": "string"
      },
      "imad": {
        "type": "string"
      },
      "omad": {
        "type": "string"
      },
      "entry_date": {
        "format": "date-time",
        "type": "string"
      },
      "completion_date": {
        "format": "date-time",
        "type": "string"
      },
      "cancel_date": {
        "format": "date-time",
        "type": "string"
      },
      "beneficiary_country_code": {
        "type": "string"
      },
      "beneficiary_bank_country_code": {
        "type": "string"
      },
      "debit_account_type": {
        "type": "string"
      },
      "debit_account_id": {
        "type": "string"
      },
      "credit_account_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "time_stamp": {
        "format": "date-time",
        "type": "string"
      },
      "swift_uetr": {
        "type": "string"
      },
      "reference_id": {
        "type": "string"
      },
      "rejection_reason": {
        "type": "string"
      }
    }
  }
}

Sample
Schema

[
  {
    "payment_status": "string",
    "payment_id": "string",
    "payment_date": "string",
    "amount": 0.0,
    "fedwire_type": "string",
    "fedwire_sub_type": "string",
    "source_indicator": "string",
    "reference_for_beneficiary": "string",
    "senders_reference": "string",
    "sending_bank_type": "string",
    "sending_bank_id": "string",
    "sending_bank_name": "string",
    "sending_bank_address": "string",
    "receiving_bank_type": "string",
    "receiving_bank_id": "string",
    "receiving_bank_name": "string",
    "receiving_bank_address": "string",
    "originator_type": "string",
    "originator_id": "string",
    "originator_name": "string",
    "originator_address": "string",
    "originating_bank_type": "string",
    "originating_bank_id": "string",
    "originating_bank_swift_bic": "string",
    "originating_bank_name": "string",
    "originating_bank_address": "string",
    "instructing_bank_type": "string",
    "instructing_bank_id": "string",
    "instructing_bank_swift_bic": "string",
    "instructing_bank_name": "string",
    "instructing_bank_address": "string",
    "beneficiary_type": "string",
    "beneficiary_id": "string",
    "beneficiary_name": "string",
    "beneficiary_address": "string",
    "beneficiary_bank_type": "string",
    "beneficiary_bank_id": "string",
    "beneficiary_bank_swift_bic": "string",
    "beneficiary_bank_name": "string",
    "beneficiary_bank_address": "string",
    "intermediary_bank_type": "string",
    "intermediary_bank_id": "string",
    "intermediary_bank_swift_bic": "string",
    "intermediary_bank_name": "string",
    "intermediary_bank_address": "string",
    "originator_to_beneficiary_info_line": "string",
    "bank_to_bank_info_line1": "string",
    "imad": "string",
    "omad": "string",
    "entry_date": "string",
    "completion_date": "string",
    "cancel_date": "string",
    "beneficiary_country_code": "string",
    "beneficiary_bank_country_code": "string",
    "debit_account_type": "string",
    "debit_account_id": "string",
    "credit_account_id": "string",
    "direction": "string",
    "time_stamp": "string",
    "swift_uetr": "string",
    "reference_id": "string",
    "rejection_reason": "string"
  }
]

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "payment_status": {
        "type": "string"
      },
      "payment_id": {
        "type": "string"
      },
      "payment_date": {
        "format": "date-time",
        "type": "string"
      },
      "amount": {
        "format": "double",
        "type": "number"
      },
      "fedwire_type": {
        "type": "string"
      },
      "fedwire_sub_type": {
        "type": "string"
      },
      "source_indicator": {
        "type": "string"
      },
      "reference_for_beneficiary": {
        "type": "string"
      },
      "senders_reference": {
        "type": "string"
      },
      "sending_bank_type": {
        "type": "string"
      },
      "sending_bank_id": {
        "type": "string"
      },
      "sending_bank_name": {
        "type": "string"
      },
      "sending_bank_address": {
        "type": "string"
      },
      "receiving_bank_type": {
        "type": "string"
      },
      "receiving_bank_id": {
        "type": "string"
      },
      "receiving_bank_name": {
        "type": "string"
      },
      "receiving_bank_address": {
        "type": "string"
      },
      "originator_type": {
        "type": "string"
      },
      "originator_id": {
        "type": "string"
      },
      "originator_name": {
        "type": "string"
      },
      "originator_address": {
        "type": "string"
      },
      "originating_bank_type": {
        "type": "string"
      },
      "originating_bank_id": {
        "type": "string"
      },
      "originating_bank_swift_bic": {
        "type": "string"
      },
      "originating_bank_name": {
        "type": "string"
      },
      "originating_bank_address": {
        "type": "string"
      },
      "instructing_bank_type": {
        "type": "string"
      },
      "instructing_bank_id": {
        "type": "string"
      },
      "instructing_bank_swift_bic": {
        "type": "string"
      },
      "instructing_bank_name": {
        "type": "string"
      },
      "instructing_bank_address": {
        "type": "string"
      },
      "beneficiary_type": {
        "type": "string"
      },
      "beneficiary_id": {
        "type": "string"
      },
      "beneficiary_name": {
        "type": "string"
      },
      "beneficiary_address": {
        "type": "string"
      },
      "beneficiary_bank_type": {
        "type": "string"
      },
      "beneficiary_bank_id": {
        "type": "string"
      },
      "beneficiary_bank_swift_bic": {
        "type": "string"
      },
      "beneficiary_bank_name": {
        "type": "string"
      },
      "beneficiary_bank_address": {
        "type": "string"
      },
      "intermediary_bank_type": {
        "type": "string"
      },
      "intermediary_bank_id": {
        "type": "string"
      },
      "intermediary_bank_swift_bic": {
        "type": "string"
      },
      "intermediary_bank_name": {
        "type": "string"
      },
      "intermediary_bank_address": {
        "type": "string"
      },
      "originator_to_beneficiary_info_line": {
        "type": "string"
      },
      "bank_to_bank_info_line1": {
        "type": "string"
      },
      "imad": {
        "type": "string"
      },
      "omad": {
        "type": "string"
      },
      "entry_date": {
        "format": "date-time",
        "type": "string"
      },
      "completion_date": {
        "format": "date-time",
        "type": "string"
      },
      "cancel_date": {
        "format": "date-time",
        "type": "string"
      },
      "beneficiary_country_code": {
        "type": "string"
      },
      "beneficiary_bank_country_code": {
        "type": "string"
      },
      "debit_account_type": {
        "type": "string"
      },
      "debit_account_id": {
        "type": "string"
      },
      "credit_account_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "time_stamp": {
        "format": "date-time",
        "type": "string"
      },
      "swift_uetr": {
        "type": "string"
      },
      "reference_id": {
        "type": "string"
      },
      "rejection_reason": {
        "type": "string"
      }
    }
  }
}

Sample
Schema

<Silvergate-ESB-API-Transactions-models-API-Payment-PaymentInfoResponseArray-2>
  <payment_status>string</payment_status>
  <payment_id>string</payment_id>
  <payment_date>string</payment_date>
  <amount>0</amount>
  <fedwire_type>string</fedwire_type>
  <fedwire_sub_type>string</fedwire_sub_type>
  <source_indicator>string</source_indicator>
  <reference_for_beneficiary>string</reference_for_beneficiary>
  <senders_reference>string</senders_reference>
  <sending_bank_type>string</sending_bank_type>
  <sending_bank_id>string</sending_bank_id>
  <sending_bank_name>string</sending_bank_name>
  <sending_bank_address>string</sending_bank_address>
  <receiving_bank_type>string</receiving_bank_type>
  <receiving_bank_id>string</receiving_bank_id>
  <receiving_bank_name>string</receiving_bank_name>
  <receiving_bank_address>string</receiving_bank_address>
  <originator_type>string</originator_type>
  <originator_id>string</originator_id>
  <originator_name>string</originator_name>
  <originator_address>string</originator_address>
  <originating_bank_type>string</originating_bank_type>
  <originating_bank_id>string</originating_bank_id>
  <originating_bank_swift_bic>string</originating_bank_swift_bic>
  <originating_bank_name>string</originating_bank_name>
  <originating_bank_address>string</originating_bank_address>
  <instructing_bank_type>string</instructing_bank_type>
  <instructing_bank_id>string</instructing_bank_id>
  <instructing_bank_swift_bic>string</instructing_bank_swift_bic>
  <instructing_bank_name>string</instructing_bank_name>
  <instructing_bank_address>string</instructing_bank_address>
  <beneficiary_type>string</beneficiary_type>
  <beneficiary_id>string</beneficiary_id>
  <beneficiary_name>string</beneficiary_name>
  <beneficiary_address>string</beneficiary_address>
  <beneficiary_bank_type>string</beneficiary_bank_type>
  <beneficiary_bank_id>string</beneficiary_bank_id>
  <beneficiary_bank_swift_bic>string</beneficiary_bank_swift_bic>
  <beneficiary_bank_name>string</beneficiary_bank_name>
  <beneficiary_bank_address>string</beneficiary_bank_address>
  <intermediary_bank_type>string</intermediary_bank_type>
  <intermediary_bank_id>string</intermediary_bank_id>
  <intermediary_bank_swift_bic>string</intermediary_bank_swift_bic>
  <intermediary_bank_name>string</intermediary_bank_name>
  <intermediary_bank_address>string</intermediary_bank_address>
  <originator_to_beneficiary_info_line>string</originator_to_beneficiary_info_line>
  <bank_to_bank_info_line1>string</bank_to_bank_info_line1>
  <imad>string</imad>
  <omad>string</omad>
  <entry_date>string</entry_date>
  <completion_date>string</completion_date>
  <cancel_date>string</cancel_date>
  <beneficiary_country_code>string</beneficiary_country_code>
  <beneficiary_bank_country_code>string</beneficiary_bank_country_code>
  <debit_account_type>string</debit_account_type>
  <debit_account_id>string</debit_account_id>
  <credit_account_id>string</credit_account_id>
  <direction>string</direction>
  <time_stamp>string</time_stamp>
  <swift_uetr>string</swift_uetr>
  <reference_id>string</reference_id>
  <rejection_reason>string</rejection_reason>
</Silvergate-ESB-API-Transactions-models-API-Payment-PaymentInfoResponseArray-2>

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "payment_status": {
        "type": "string"
      },
      "payment_id": {
        "type": "string"
      },
      "payment_date": {
        "format": "date-time",
        "type": "string"
      },
      "amount": {
        "format": "double",
        "type": "number"
      },
      "fedwire_type": {
        "type": "string"
      },
      "fedwire_sub_type": {
        "type": "string"
      },
      "source_indicator": {
        "type": "string"
      },
      "reference_for_beneficiary": {
        "type": "string"
      },
      "senders_reference": {
        "type": "string"
      },
      "sending_bank_type": {
        "type": "string"
      },
      "sending_bank_id": {
        "type": "string"
      },
      "sending_bank_name": {
        "type": "string"
      },
      "sending_bank_address": {
        "type": "string"
      },
      "receiving_bank_type": {
        "type": "string"
      },
      "receiving_bank_id": {
        "type": "string"
      },
      "receiving_bank_name": {
        "type": "string"
      },
      "receiving_bank_address": {
        "type": "string"
      },
      "originator_type": {
        "type": "string"
      },
      "originator_id": {
        "type": "string"
      },
      "originator_name": {
        "type": "string"
      },
      "originator_address": {
        "type": "string"
      },
      "originating_bank_type": {
        "type": "string"
      },
      "originating_bank_id": {
        "type": "string"
      },
      "originating_bank_swift_bic": {
        "type": "string"
      },
      "originating_bank_name": {
        "type": "string"
      },
      "originating_bank_address": {
        "type": "string"
      },
      "instructing_bank_type": {
        "type": "string"
      },
      "instructing_bank_id": {
        "type": "string"
      },
      "instructing_bank_swift_bic": {
        "type": "string"
      },
      "instructing_bank_name": {
        "type": "string"
      },
      "instructing_bank_address": {
        "type": "string"
      },
      "beneficiary_type": {
        "type": "string"
      },
      "beneficiary_id": {
        "type": "string"
      },
      "beneficiary_name": {
        "type": "string"
      },
      "beneficiary_address": {
        "type": "string"
      },
      "beneficiary_bank_type": {
        "type": "string"
      },
      "beneficiary_bank_id": {
        "type": "string"
      },
      "beneficiary_bank_swift_bic": {
        "type": "string"
      },
      "beneficiary_bank_name": {
        "type": "string"
      },
      "beneficiary_bank_address": {
        "type": "string"
      },
      "intermediary_bank_type": {
        "type": "string"
      },
      "intermediary_bank_id": {
        "type": "string"
      },
      "intermediary_bank_swift_bic": {
        "type": "string"
      },
      "intermediary_bank_name": {
        "type": "string"
      },
      "intermediary_bank_address": {
        "type": "string"
      },
      "originator_to_beneficiary_info_line": {
        "type": "string"
      },
      "bank_to_bank_info_line1": {
        "type": "string"
      },
      "imad": {
        "type": "string"
      },
      "omad": {
        "type": "string"
      },
      "entry_date": {
        "format": "date-time",
        "type": "string"
      },
      "completion_date": {
        "format": "date-time",
        "type": "string"
      },
      "cancel_date": {
        "format": "date-time",
        "type": "string"
      },
      "beneficiary_country_code": {
        "type": "string"
      },
      "beneficiary_bank_country_code": {
        "type": "string"
      },
      "debit_account_type": {
        "type": "string"
      },
      "debit_account_id": {
        "type": "string"
      },
      "credit_account_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "time_stamp": {
        "format": "date-time",
        "type": "string"
      },
      "swift_uetr": {
        "type": "string"
      },
      "reference_id": {
        "type": "string"
      },
      "rejection_reason": {
        "type": "string"
      }
    }
  }
}

Sample
Schema

<Silvergate-ESB-API-Transactions-models-API-Payment-PaymentInfoResponseArray-3>
  <payment_status>string</payment_status>
  <payment_id>string</payment_id>
  <payment_date>string</payment_date>
  <amount>0</amount>
  <fedwire_type>string</fedwire_type>
  <fedwire_sub_type>string</fedwire_sub_type>
  <source_indicator>string</source_indicator>
  <reference_for_beneficiary>string</reference_for_beneficiary>
  <senders_reference>string</senders_reference>
  <sending_bank_type>string</sending_bank_type>
  <sending_bank_id>string</sending_bank_id>
  <sending_bank_name>string</sending_bank_name>
  <sending_bank_address>string</sending_bank_address>
  <receiving_bank_type>string</receiving_bank_type>
  <receiving_bank_id>string</receiving_bank_id>
  <receiving_bank_name>string</receiving_bank_name>
  <receiving_bank_address>string</receiving_bank_address>
  <originator_type>string</originator_type>
  <originator_id>string</originator_id>
  <originator_name>string</originator_name>
  <originator_address>string</originator_address>
  <originating_bank_type>string</originating_bank_type>
  <originating_bank_id>string</originating_bank_id>
  <originating_bank_swift_bic>string</originating_bank_swift_bic>
  <originating_bank_name>string</originating_bank_name>
  <originating_bank_address>string</originating_bank_address>
  <instructing_bank_type>string</instructing_bank_type>
  <instructing_bank_id>string</instructing_bank_id>
  <instructing_bank_swift_bic>string</instructing_bank_swift_bic>
  <instructing_bank_name>string</instructing_bank_name>
  <instructing_bank_address>string</instructing_bank_address>
  <beneficiary_type>string</beneficiary_type>
  <beneficiary_id>string</beneficiary_id>
  <beneficiary_name>string</beneficiary_name>
  <beneficiary_address>string</beneficiary_address>
  <beneficiary_bank_type>string</beneficiary_bank_type>
  <beneficiary_bank_id>string</beneficiary_bank_id>
  <beneficiary_bank_swift_bic>string</beneficiary_bank_swift_bic>
  <beneficiary_bank_name>string</beneficiary_bank_name>
  <beneficiary_bank_address>string</beneficiary_bank_address>
  <intermediary_bank_type>string</intermediary_bank_type>
  <intermediary_bank_id>string</intermediary_bank_id>
  <intermediary_bank_swift_bic>string</intermediary_bank_swift_bic>
  <intermediary_bank_name>string</intermediary_bank_name>
  <intermediary_bank_address>string</intermediary_bank_address>
  <originator_to_beneficiary_info_line>string</originator_to_beneficiary_info_line>
  <bank_to_bank_info_line1>string</bank_to_bank_info_line1>
  <imad>string</imad>
  <omad>string</omad>
  <entry_date>string</entry_date>
  <completion_date>string</completion_date>
  <cancel_date>string</cancel_date>
  <beneficiary_country_code>string</beneficiary_country_code>
  <beneficiary_bank_country_code>string</beneficiary_bank_country_code>
  <debit_account_type>string</debit_account_type>
  <debit_account_id>string</debit_account_id>
  <credit_account_id>string</credit_account_id>
  <direction>string</direction>
  <time_stamp>string</time_stamp>
  <swift_uetr>string</swift_uetr>
  <reference_id>string</reference_id>
  <rejection_reason>string</rejection_reason>
</Silvergate-ESB-API-Transactions-models-API-Payment-PaymentInfoResponseArray-3>

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "payment_status": {
        "type": "string"
      },
      "payment_id": {
        "type": "string"
      },
      "payment_date": {
        "format": "date-time",
        "type": "string"
      },
      "amount": {
        "format": "double",
        "type": "number"
      },
      "fedwire_type": {
        "type": "string"
      },
      "fedwire_sub_type": {
        "type": "string"
      },
      "source_indicator": {
        "type": "string"
      },
      "reference_for_beneficiary": {
        "type": "string"
      },
      "senders_reference": {
        "type": "string"
      },
      "sending_bank_type": {
        "type": "string"
      },
      "sending_bank_id": {
        "type": "string"
      },
      "sending_bank_name": {
        "type": "string"
      },
      "sending_bank_address": {
        "type": "string"
      },
      "receiving_bank_type": {
        "type": "string"
      },
      "receiving_bank_id": {
        "type": "string"
      },
      "receiving_bank_name": {
        "type": "string"
      },
      "receiving_bank_address": {
        "type": "string"
      },
      "originator_type": {
        "type": "string"
      },
      "originator_id": {
        "type": "string"
      },
      "originator_name": {
        "type": "string"
      },
      "originator_address": {
        "type": "string"
      },
      "originating_bank_type": {
        "type": "string"
      },
      "originating_bank_id": {
        "type": "string"
      },
      "originating_bank_swift_bic": {
        "type": "string"
      },
      "originating_bank_name": {
        "type": "string"
      },
      "originating_bank_address": {
        "type": "string"
      },
      "instructing_bank_type": {
        "type": "string"
      },
      "instructing_bank_id": {
        "type": "string"
      },
      "instructing_bank_swift_bic": {
        "type": "string"
      },
      "instructing_bank_name": {
        "type": "string"
      },
      "instructing_bank_address": {
        "type": "string"
      },
      "beneficiary_type": {
        "type": "string"
      },
      "beneficiary_id": {
        "type": "string"
      },
      "beneficiary_name": {
        "type": "string"
      },
      "beneficiary_address": {
        "type": "string"
      },
      "beneficiary_bank_type": {
        "type": "string"
      },
      "beneficiary_bank_id": {
        "type": "string"
      },
      "beneficiary_bank_swift_bic": {
        "type": "string"
      },
      "beneficiary_bank_name": {
        "type": "string"
      },
      "beneficiary_bank_address": {
        "type": "string"
      },
      "intermediary_bank_type": {
        "type": "string"
      },
      "intermediary_bank_id": {
        "type": "string"
      },
      "intermediary_bank_swift_bic": {
        "type": "string"
      },
      "intermediary_bank_name": {
        "type": "string"
      },
      "intermediary_bank_address": {
        "type": "string"
      },
      "originator_to_beneficiary_info_line": {
        "type": "string"
      },
      "bank_to_bank_info_line1": {
        "type": "string"
      },
      "imad": {
        "type": "string"
      },
      "omad": {
        "type": "string"
      },
      "entry_date": {
        "format": "date-time",
        "type": "string"
      },
      "completion_date": {
        "format": "date-time",
        "type": "string"
      },
      "cancel_date": {
        "format": "date-time",
        "type": "string"
      },
      "beneficiary_country_code": {
        "type": "string"
      },
      "beneficiary_bank_country_code": {
        "type": "string"
      },
      "debit_account_type": {
        "type": "string"
      },
      "debit_account_id": {
        "type": "string"
      },
      "credit_account_id": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      },
      "time_stamp": {
        "format": "date-time",
        "type": "string"
      },
      "swift_uetr": {
        "type": "string"
      },
      "reference_id": {
        "type": "string"
      },
      "rejection_reason": {
        "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 GET "https://silvergate.azure-api.net/v2/payment?account_number={account_number}?payment_id={string}&begin_date={string}&end_date={string}&sort_order=desc&page_size={integer}&page_number={integer}"
-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["payment_id"] = "{string}";
            queryString["begin_date"] = "{string}";
            queryString["end_date"] = "{string}";
            queryString["sort_order"] = "desc";
            queryString["page_size"] = "{integer}";
            queryString["page_number"] = "{integer}";
            var uri = "https://silvergate.azure-api.net/v2/payment?account_number={account_number}&" + 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/payment?account_number={account_number}");

            builder.setParameter("payment_id", "{string}");
            builder.setParameter("begin_date", "{string}");
            builder.setParameter("end_date", "{string}");
            builder.setParameter("sort_order", "desc");
            builder.setParameter("page_size", "{integer}");
            builder.setParameter("page_number", "{integer}");

            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
            "payment_id": "{string}",
            "begin_date": "{string}",
            "end_date": "{string}",
            "sort_order": "desc",
            "page_size": "{integer}",
            "page_number": "{integer}",
        };
      
        $.ajax({
            url: "https://silvergate.azure-api.net/v2/payment?account_number={account_number}&" + $.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/payment?account_number={account_number}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"payment_id={string}",
                         @"begin_date={string}",
                         @"end_date={string}",
                         @"sort_order=desc",
                         @"page_size={integer}",
                         @"page_number={integer}",
                      ];
    
    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/payment?account_number={account_number}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'payment_id' => '{string}',
    'begin_date' => '{string}',
    'end_date' => '{string}',
    'sort_order' => 'desc',
    'page_size' => '{integer}',
    'page_number' => '{integer}',
);

$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
    'payment_id': '{string}',
    'begin_date': '{string}',
    'end_date': '{string}',
    'sort_order': 'desc',
    'page_size': '{integer}',
    'page_number': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('silvergate.azure-api.net')
    conn.request("GET", "/v2/payment?account_number={account_number}&%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
    'payment_id': '{string}',
    'begin_date': '{string}',
    'end_date': '{string}',
    'sort_order': 'desc',
    'page_size': '{integer}',
    'page_number': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'payment_id' => '{string}',
    'begin_date' => '{string}',
    'end_date' => '{string}',
    'sort_order' => 'desc',
    'page_size' => '{integer}',
    'page_number' => '{integer}'
})
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