List the external accounts of a user

GET

/payment-gateways/external-accounts/{user_id}

const url = 'https://acme.mykreezalid.com/api/v1/payment-gateways/external-accounts/1';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.mykreezalid.com/api/v1/payment-gateways/external-accounts/1 \
  --header 'Authorization: Basic <credentials>'

Returns the user’s accounts at your payment gateways; an empty list when the user has none.

Authorizations

basic

Parameters

Path Parameters

user_id

required

integer

ID of the user

Responses

200

The user’s external accounts

application/json

Array<object>

The account of one of your users at a payment gateway.

object

totalResultsCount

Number of results across all pages.

integer

currentPage

Number of the page returned, starting at 1.

integer

nextPage

Whether a next page exists.

boolean

prevPage

Whether a previous page exists.

boolean

resultOnPageCount

Number of results on this page.

integer

pageCount

Number of pages.

integer

Identifier of the external account

integer

object

Returned when you create or update an account, not in the list

string

type

Role of the account: supplier for a vendor, customer for a customer

string

nullable

gateway_id

Identifier of the payment gateway

integer

nullable

external_account_id

Identifier of the account at the payment provider

string

nullable

properties

Your own data about the account

object

tos_acceptance

When and from where the user accepted the payment provider’s terms

object

date

string format: date-time

nullable

user_agent

string

nullable

string

nullable

created

string format: date-time

Example

[
  {
    "totalResultsCount": 137,
    "currentPage": 1,
    "resultOnPageCount": 25,
    "pageCount": 6,
    "id": 4242,
    "object": "ExternalAccount",
    "type": "supplier",
    "gateway_id": 432349,
    "external_account_id": "acc_123456",
    "properties": {
      "preference": "static"
    },
    "tos_acceptance": {
      "ip": "203.0.113.7"
    }
  }
]