Contents

GET /history/outgoing#

Return a list of transactions made by the exchange, typically to a merchant.

Request:

Query Parameters:

  • limit – Optional. At most return the given number of results. Negative for descending by row_id, positive for ascending by row_id. Defaults to -20. Since protocol v2.

  • offset – Optional. Starting row_id for pagination. Since protocol v2.

  • timeout_ms – Optional. Timeout in milliseconds, for long-polling, to wait for at least one element to be shown. Only useful if limit is positive. Since protocol v2.

  • delta – Optional. Deprecated in protocol v2. Use limit instead.

  • start – Optional. Deprecated in protocol v2. Use offset instead.

  • long_poll_ms – Optional. Deprecated in protocol v2. Use timeout_ms instead.

Response:

200 OK:

JSON object of type OutgoingHistory.

204 No content:

There are not transactions to report (under the given filter).

400 Bad request:

Request malformed. The bank replies with an ErrorDetail object.

401 Unauthorized:

Authentication failed, likely the credentials are wrong.

404 Not found:

The endpoint is wrong or the user name is unknown. The bank replies with an ErrorDetail object.

Details:

interface OutgoingHistory {
  // Array of outgoing transactions.
  outgoing_transactions: OutgoingBankTransaction[];

  // Full payto URI to identify the sender of funds.
  // This must be one of the exchange's bank accounts.
  // Credit account is shared by all incoming transactions
  // as per the nature of the request.
  debit_account: string;
}

interface OutgoingBankTransaction {
  // Opaque identifier of the returned record.
  row_id: SafeUint64;

  // Date of the transaction.
  date: Timestamp;

  // Amount transferred.
  amount: Amount;

  // Fee paid by the debtor.
  // If not null, debtor actually paid amount + debit_fee
  // @since **v3**
  debit_fee?: Amount;

  // Full payto URI to identify the receiver of funds.
  credit_account: string;

  // The wire transfer ID in the outgoing transaction.
  wtid: ShortHashCode;

  // Base URL of the exchange.
  exchange_base_url: string;

  // Optional additional metadata.
  // @since **v5**
  metadata?: string;
}
Contents