List external transfers

OAuth scope: organization.read

---

Retrieve a list of external transfers.

---

Attributes details

Initiator ID

ID of the membership that initiated the external transfer. <br>When the external transfer is initiated through the API, the initiator is the authenticated membership.

Debit

• debit_iban: Can be any of the organization's bank accounts. IBAN formatted ISO 13616.
• debit_amount: The amount that will be debited from your Qonto account.
• debit_amount_cents: The amount that will be debited from you Qonto account in an integer format.
• debit_currency: Must be EUR. ISO 4217 formatted.

Credit

• credit_amount: The amount that the beneficiary will receive.
• credit_amount_cents: The amount that the beneficiary will receive in an integer format.
• credit_currency: Equals debit currency if issued in the SEPA network (only supported currencies). ISO 4217 format. Allowed value for international transfers: AUD, CAD, CHF, CNY, CZK, DKK, GBP, HKD, HRK, HUF, ILS, JPY, NOK, NZD, PLN, RON, SEK, USD

FX rate

• rate_applied: Foreign exchange rate applied to your transaction, formatted with 4 digits after comma. Ex: 1,1082

Timestamps

Each external transfer contains three timestamps:

• created_at, UTC, the time at which the external transfer was first recorded.
• processed_at, UTC, when the external transfer has been started to be processed by Qonto.
• completed_at, UTC, when the external transfer is in its final state, either settled or declined.
• scheduled_date, YYYY-MM-DD, indicates when the external transfer was scheduled to be sent by Qonto.

Status

status can contain the following values

• pending: External transfer is created and has not been processed yet. If transfer is not processed within next minute, it means either execution date may not been reached yet or we are running some compliance checks on this transfer.
• processing: External transfer processing means account balance is debited and a transaction has been created. Processing status can last up to multiple hours until transfer is sent in the network to the beneficiary.
• canceled: When the external transfer is canceled by a user in the interface. This is a permanent status.
• declined: When the external transfer is declined by the screening service, fraud service or, once sent on the network, for many various reasons which are listed in those guidelines. This is a permanent status.
• settled: When the external transfer is sent to the network, transfer is settled. This is a permanent status.

Filters

status

External transfers can be filtered by status. The status query parameter accepts an array of statuses as value. The possible values are: pending, processing, canceled, declined and settled.

For example, if you want to retrieve several External Transfers statuses, you can use the following filter: status[]=processing&status[]=declined&status[]=settled

beneficiary_ids

Allows filtering on a list of beneficiary IDs

updated_at / scheduled_date

External transfers can be filtered according to both updated_at and scheduled_date fields. This is particularly useful to retrieve only the latest external transfers in your application. Two filters are available :

• updated_at
  • updated_at_from: Minimum value (e.g: 2019-01-10T11:47:53.123Z)
  • updated_at_to: Maximum value
• scheduled_date
  • scheduled_date_from: Minimum value
  • scheduled_date_to: Maximum value

Do note:

• You can use one or the other updated_at filter (same for scheduled_date), or use them in combination if you want external transfers updated within a specific timeframe.
• updated_at / scheduled_date filters should have a valid date time format (ISO 8601 for instance)

Sorting

External transfers can be sorted by a specific field and order. The sort_by query parameter accepts a string defining these two items with the field:order format.

Field

• scheduled_date and updated_at values are available.

Order

• Two values are available : asc (Ascending) / desc (Descending)
• By default the order used to sort external transfers is desc

Do note: You can use a combination of field and order to define how to sort external transfers:

• Only field (e.g updated_at, order will have default value desc)
• Only order (e.g :asc, field will have default value updated_at)
• Both (e.g updated_at:asc)

[
  "pending"
]

{
  "external_transfers": [
    {
      "debit_amount": "12.55",
      "debit_amount_cents": "1255",
      "debit_currency": "EUR",
      "payment_purpose": "goods",
      "declined_reason": "beneficiary_bic_invalid",
      "status": "pending",
      "scheduled_date": "2021-07-12",
      "created_at": "2021-01-27T22:05:07.000Z",
      "completed_at": "2021-01-27T22:05:07.000Z",
      "processed_at": "2021-01-27T22:05:07.000Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 150,
    "per_page": 100
  }
}