TOtopi
ops
ops-end-customers

List end customers

Changed on

Fetch all the end customers

get/ops/end-customers

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/end-customers
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-end-customer:read

Response

OK response.

available_credit_limitinteger

end-customer available credit limit

commentsstring

comments about this credit limit set by ops

country_codestring required

ISO 3166-1 alpha-2

credit_limitinteger

end-customer credit limit

currencystring

end customer currency

email_domainstring required

end-customer email domain

idstring regexp required

end-customer ID

idv_requirement_statusstring

end-customer IDV requirement status

languagestring required

end-customer language

namestring required

end-customer name

psp'stripe' | 'gocardless' | 'stripe_asset_gmbh' | 'none' required

payment service provider

risk_statusstring

end-customer risk status

Example response

[
  {
    "available_credit_limit": 1,
    "comments": "abc123",
    "country_code": "DE",
    "credit_limit": 1,
    "currency": "abc123",
    "email_domain": "abc123",
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "idv_requirement_status": "abc123",
    "language": "abc123",
    "name": "abc123",
    "psp": "stripe",
    "risk_status": "abc123"
  }
]

Changes

  • ac6979514123Revision changes
    • info

      api operation id end_customer.getEndCustomersOps removed and replaced with end_customer#getEndCustomersOps

  • 7ff7ee94b30eRevision changes
    • info

      api operation id end_customer#getEndCustomersOps removed and replaced with end_customer.getEndCustomersOps

    • info

      api tag ops-end-customers added