v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB

customer

List the customers

get/customer

Query parameters

countrystring

ISO-3166-1 Alfa-2 country code

Example:MX

The country of the customer

tax_idstring

The tax ID of the customer

tax_id_type'rfc' | 'cnpj' | 'cpf' | 'ruc' | 'curp' | 'le' | 'dni' | 'lm' | 'pas' | 'ce' | 'nit' | 'cc' | 'pa' | 'ti' | 'nuip' | 'ppt' | 'pep' | 'cuil' | 'cuit' | 'other'

The tax ID type of the customer

external_idstring

The external ID of the customer

Response

Customer listed

countinteger

The number of customers listed

nextstring uri

The next page of listed customers

previousstring uri

The previous page of listed customers

Example response

{
  "count": 123,
  "next": "http://api.example.org/payout/customer/?page=4",
  "previous": "http://api.example.org/payout/customer/?page=2",
  "results": [
    {
      "id": "9c1dd10e-7c19-470d-9dd1-0e7c19670d64"
    }
  ]
}