Skip to main content
GET
/
v1
/
external_accounts
List all external accounts
curl --request GET \
  --url https://api.yorlet.com/v1/external_accounts \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "external_account",
      "available_payout_methods": [
        "<string>"
      ],
      "confirmation_of_payee": {
        "status": "awaiting_acknowledgement"
      },
      "status": "new",
      "type": "bank_account",
      "account": "<string>",
      "deleted": false,
      "bank_account": {
        "account_holder_name": "<string>",
        "account_holder_type": "individual",
        "bank_name": "<string>",
        "country": "<string>",
        "currency": "aud",
        "last4": "<string>",
        "routing_number": "<string>",
        "swift_bic": "<string>"
      },
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of external accounts.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required