GET [/instances/$INSTANCE]/private/transfers

Obtain a list of all wire transfers the backend was told had been made into the merchant bank account. Since protocol v20 this endpoint is only about actually confirmed wire transfers.

Required permission: transfers-read

Request:

Query Parameters:

• payto_uri – Optional. Full payto://-URI to filter for transfers to the given bank account (subject and amount MUST NOT be given in the payto:// URI). Note that the URI must be URL-encoded.

• before – Optional. Filter for transfers executed before the given timestamp.

• after – Optional. Filter for transfers executed after the given timestamp.

• limit – Optional. At most return the given number of results. Negative for descending in execution time, positive for ascending in execution time. Default is -20.

• offset – Optional. Starting transfer_serial_id for an iteration.

• expected – Optional. Filter transfers that we expected to receive (YES: only expected, NO: only unexpected, ALL: default). Since protocol v20.

Response:

200 OK:

The body of the response is a TransferList.

Details:

interface TransferList {
   // List of all the transfers that fit the filter that we know.
   transfers : TransferDetails[];
}

interface TransferDetails {
  // How much was wired to the merchant (minus fees).
  credit_amount: Amount;

  // Raw wire transfer identifier identifying the wire transfer (a base32-encoded value).
  wtid: WireTransferIdentifierRawP;

  // Full payto://-URI of the bank account that received the wire transfer.
  payto_uri: string;

  // Base URL of the exchange that made the wire transfer.
  exchange_url: string;

  // Serial number identifying the transfer in the merchant backend.
  // Used for filtering via offset.
  transfer_serial_id: Integer;

  // Time of the execution of the wire transfer.
  // Missing if unknown in protocol **v25**.
  execution_time?: Timestamp;

  // True if we checked the exchange's answer and are happy with it.
  // False if we have an answer and are unhappy, missing if we
  // do not have an answer from the exchange.
  // Removed in protocol **v20**.
  verified?: boolean;

  // True if the merchant uses the POST /transfers API to confirm
  // that this wire transfer took place (and it is thus not
  // something merely claimed by the exchange).
  // Removed in protocol **v20**.
  confirmed?: boolean;

  // True if this wire transfer was expected.
  // (a matching "/private/incoming" record exists).
  // Since protocol **v20**.
  expected?: boolean;
}