Skip to main content
GET
/
v1
/
payment-accounts
/
by-customer
List customer payment accounts
curl --request GET \
  --url https://api.useaira.com/v1/payment-accounts/by-customer \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archivedAt": "2023-11-07T05:31:56Z",
      "legalEntity": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessName": "<string>",
        "taxId": "<string>",
        "taxIdType": "cnpj",
        "customFields": {
          "customField1": "value1",
          "customField2": [
            "value2",
            "value3"
          ]
        },
        "tradeName": "<string>",
        "emails": [],
        "zipCode": "<string>",
        "street": "<string>",
        "number": "<string>",
        "neighborhood": "<string>",
        "city": "<string>",
        "state": "AC",
        "country": "Brasil",
        "complement": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.useaira.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API Key Authentication.

Query Parameters

​
customerId
string<uuid>
required

The unique identifier of the customer.

​
includeSubsidiaries
boolean
default:false

Whether payment accounts of subsidiaries should be returned as well.

​
includeArchived
boolean
default:false

Whether archived payment accounts should be returned.

Response

Default Response

​
items
object[]
required

A list of items.