Bank API

The following APIs are served from banks, in order to allow exchanges to deposit funds to money recipients. A typical scenario for calling this APIs is after a merchant has deposited coins to the exchange, and the exchange needs to give real money to the merchant.

Administrative API

This is local API, meant to make the bank communicate with trusted entities, namely exchanges.

POST /admin/add/incoming

Request: The body of this request must have the format of a BankDepositRequest.

Response:

status 200 OK:The request has been correctly handled, so the funds have been transferred to the recipient’s account
status 400 Bad Request:
 The bank replies a BankIncomingError object

Details:

interface BankDepositRequest {

  // JSON 'amount' object. The amount the caller wants to transfer
  // to the recipient's count
  amount: Amount;

  // The id of this wire transfer
  wtid: base32;

  // The sender's account identificator
  debit_account: number;

  // The recipient's account identificator
  credit_account: number;

}
interface BankIncomingError {

  // Human readable explanation of the failure.
  reason: string

}

Util API

Whenever the user wants to know the bank account number of a public account, the following path returns a human readable HTML containing this information

/public-accounts/details?account=accountName