Ripple Gateway API Reference Register Login

Core API Calls
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.

Resource Description
POST /api/v1/deposits Record the deposit of an asset at this gateway.
GET /api/v1/deposits List pending deposits in the queue to be processed.
GET /api/v1/withdrawals/pending Listing pending withdrawals waiting to be processed.
POST /api/v1/withdrawals/:id/clear Clear a pending withdrawal upon processing it.
GET /api/v1/payments/outgoing Listing pending outgoing payments to the ripple network.
GET /api/v1/payments/incoming Listing received ripple payments in the queue to be processed.

Users
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.

Resource Description
POST /api/v1/users Create a new user at this gateway.
GET /api/v1/users List user records.
GET /api/v1/users/:id Get a user record.
PUT /api/v1/users/:id Update a user record.
DELETE /api/v1/users/:id Delete a user record.

ExternalAccounts
Bank Accounts and integrations are stored as External Accounts

Resource Description
POST /api/v1/external_accounts Create a new external account given a user id
GET /api/v1/external_accounts List external accounts
GET /api/v1/external_accounts/:id Show a single external account record
PUT /api/v1/external_accounts/:id Update an external account record
DELETE /api/v1/external_accounts/:id Delete an external account record

External Transactions
List external transactions made to an external account.

Resource Description
POST /api/v1/external_transactions Create an external transaction
GET /api/v1/external_transactions Show external transactions
GET /api/v1/external_transactions/:id Show a single external transaction
PUT /api/v1/external_transactions/:id Update a single external transaction
DELETE /api/v1/external_transactions/:id Delete a single external transaction

Ripple Addresses
List Ripple Addresses related to User accounts.

Resource Description
POST /api/v1/ripple_addresses Create a Ripple Address Record
GET /api/v1/ripple_addresses List Ripple Addresses
GET /api/v1/ripple_addresses/:id Show a Ripple Addresses record.
PUT /api/v1/ripple_addresses/:id Update a Ripple Addresses record.
DELETE /api/v1/ripple_addresses/:id Delete a Ripple Addresses record.

Ripple Transactions
List transactions made on ripple network to the gateway's address.

Resource Description
POST /api/v1/ripple_transactions Create a ripple transaction record.
GET /api/v1/ripple_transactions/:id List rippple transactions
GET /api/v1/ripple_transactions/:id Get a ripple transaction record.
PUT /api/v1/ripple_transactions/:id Update a ripple transaction record.
DELETE /api/v1/ripple_transactions/:id Delete a ripple transaction record.