forked from nerdylocks/ripple-gateway-webapp-example
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
255 lines (250 loc) · 8.98 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<!DOCTYPE html>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><script type="text/javascript">var NREUMQ=NREUMQ||[];NREUMQ.push(["mark","firstbyte",new Date().getTime()]);</script>
<title>API documentation</title>
<link type="text/css" rel="stylesheet" href="/apidocs/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="/apidocs/prettify.css">
<!-- Theme style
<link type="text/css" rel="stylesheet" href="/apidocs/bootstrap-responsive.min.css">
-->
<link href="theme/css/theme-style.min.css" rel="stylesheet">
<!--Your custom colour override-->
<link href="theme/css/colour-blue.css" id="colour-scheme" rel="stylesheet">
<!-- Your custom override -->
<link href="theme/css/custom-style.css" rel="stylesheet">
<link type="text/css" rel="stylesheet" href="/apidocs/application.css">
<!-- IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script type="text/javascript" async="" src="/apidocs/embed.js"></script></head>
<body>
<div class="container">
<div class="row" style='padding:0em 1em 1em 1em'>
<div>
<h1 style='text-align:left'class="page-header">
Ripple Gateway API Reference
<a href='/app#/register' style='float:right; padding-left: 20px;'>Register</a>
<a href='/app#/login' style='float:right; padding-left:20px;'>Login</a>
</h1>
<section style='padding:2em;'>
<h2>
<a>
Core API Calls
</a><br>
<small>An integrator with ripple-gateway needs to focus on their particular banking integration, which means primarily making api calls for deposits and withdrawals. Also they will want to be able to track the state of deposits and withdrawals as they are processed and ultimately sent to the ripple network.</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href='/doc/deposits/record.html'>POST /api/v1/deposits</a></td>
<td width="60%">Record the deposit of an asset at this gateway.</td>
</tr>
<tr>
<td><a href='/doc/deposits/list.html'>GET /api/v1/deposits</a></td>
<td width="60%">List pending deposits in the queue to be processed.</td>
</tr>
<tr>
<td><a href='/doc/withdrawals/pending.html'>GET /api/v1/withdrawals/pending</a></td>
<td width="60%">Listing pending withdrawals waiting to be processed.</td>
</tr>
<tr>
<td><a href='/doc/withdrawals/clear.html'>POST /api/v1/withdrawals/:id/clear</a></td>
<td width="60%">Clear a pending withdrawal upon processing it.</td>
</tr>
<tr>
<td><a href='/doc/payments/outgoing.html'>GET /api/v1/payments/outgoing</a></td>
<td width="60%">Listing pending outgoing payments to the ripple network.</td>
</tr>
<tr>
<td><a href='/doc/payments/incoming.html'>GET /api/v1/payments/incoming</a></td>
<td width="60%">Listing received ripple payments in the queue to be processed.</td>
</tr>
</tbody>
</table>
<h2>
<a>
Users
</a><br>
<small>A user can register or an admin can list/create users. Users can also be maintained in a separate system and referenced with its unique id.</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href='/doc/users/create.html'>POST /api/v1/users</a></td>
<td width="60%">Create a new user at this gateway.</td>
</tr>
<tr>
<td><a href='/doc/users/list.html'>GET /api/v1/users</td>
<td width="60%">List user records.</td>
</tr>
<tr>
<td><a href='/doc/users/show.html'>GET /api/v1/users/:id</a></td>
<td width="60%">Get a user record.</td>
</tr>
<tr>
<td><a href='/doc/users/show.html'>PUT /api/v1/users/:id</a></td>
<td width="60%">Update a user record.</td>
</tr>
<tr>
<td><a href='/doc/users/show.html'>DELETE /api/v1/users/:id</a></td>
<td width="60%">Delete a user record.</td>
</tr>
</tbody>
</table>
<h2>
<a>
ExternalAccounts
</a><br>
<small>Bank Accounts and integrations are stored as External Accounts</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href='/doc/external_accounts/create.html'>POST /api/v1/external_accounts</a></td>
<td width="60%">Create a new external account given a user id</td>
</tr>
<tr>
<td><a href='/doc/external_accounts/list.html'>GET /api/v1/external_accounts</a></td>
<td width="60%">List external accounts</td>
</tr>
<tr>
<td><a href='/doc/external_accounts/show.html'>GET /api/v1/external_accounts/:id</a></td>
<td width="60%">Show a single external account record</td>
</tr>
<tr>
<td><a href='/doc/external_accounts/update.html'>PUT /api/v1/external_accounts/:id</a></td>
<td width="60%">Update an external account record</td>
</tr>
<tr>
<td><a href='/doc/external_accounts/delete.html'>DELETE /api/v1/external_accounts/:id</a></td>
<td width="60%">Delete an external account record</td>
</tr>
</tbody>
</table>
<h2>
<a>
External Transactions
</a><br>
<small>List external transactions made to an external account.</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="/doc/external_transactions/create.html">POST /api/v1/external_transactions</a></td>
<td width="60%">Create an external transaction</td>
</tr>
<tr>
<td><a href="/doc/external_transactions/list.html">GET /api/v1/external_transactions</a></td>
<td width="60%">Show external transactions</td>
</tr>
<tr>
<td><a href="/doc/external_transactions/show.html">GET /api/v1/external_transactions/:id</a></td>
<td width="60%">Show a single external transaction</td>
</tr>
<tr>
<td><a href="/doc/external_transactions/update.html">PUT /api/v1/external_transactions/:id</a></td>
<td width="60%">Update a single external transaction</td>
</tr>
<tr>
<td><a href="/doc/external_transactions/delete.html">DELETE /api/v1/external_transactions/:id</a></td>
<td width="60%">Delete a single external transaction</td>
</tr>
</tbody>
</table>
<h2>
<a href="">
Ripple Addresses
</a><br>
<small>List Ripple Addresses related to User accounts.</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href='/doc/ripple_addresses/create.html'>POST /api/v1/ripple_addresses</a></td>
<td width="60%">Create a Ripple Address Record</td>
</tr>
<tr>
<td><a href='/doc/ripple_addresses/list.html'>GET /api/v1/ripple_addresses</a></td>
<td width="60%">List Ripple Addresses</td>
</tr>
<tr>
<td><a href='/doc/ripple_addresses/show.html'>GET /api/v1/ripple_addresses/:id</a></td>
<td width="60%">Show a Ripple Addresses record.</td>
</tr>
<tr>
<td><a href='/doc/ripple_addresses/update.html'>PUT /api/v1/ripple_addresses/:id</a></td>
<td width="60%">Update a Ripple Addresses record.</td>
</tr>
<tr>
<td><a href='/doc/ripple_addresses/delete.html'>DELETE /api/v1/ripple_addresses/:id</a></td>
<td width="60%">Delete a Ripple Addresses record.</td>
</tr>
</tbody>
</table>
<h2>
<a>
Ripple Transactions
</a><br>
<small>List transactions made on ripple network to the gateway's address.</small>
</h2>
<table class="table">
<thead>
<tr>
<th>Resource</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href='/doc/ripple_transactions/create.html'>POST /api/v1/ripple_transactions</a></td>
<td width='60%'>Create a ripple transaction record.</td>
</tr>
<tr>
<td><a href='/doc/ripple_transactions/index.html'>GET /api/v1/ripple_transactions/:id</a></td>
<td width="60%">List rippple transactions<td>
</tr>
<tr>
<td><a href='/doc/ripple_transactions/show.html'>GET /api/v1/ripple_transactions/:id</a></td>
<td width='60%'>Get a ripple transaction record.</td>
</tr>
<tr>
<td><a href='/doc/ripple_transactions/update.html'>PUT /api/v1/ripple_transactions/:id</a></td>
<td width='60%'>Update a ripple transaction record.</td>
</tr>
<tr>
<td><a href='/doc/ripple_transactions/delete.html'>DELETE /api/v1/ripple_transactions/:id</a></td>
<td width='60%'>Delete a ripple transaction record.</td>
</tr>
</tbody>
</table>
</section>