v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Listar assinantes

get/customers

Query parameters

offsetinteger

Número da página que deseja consultar. Deve ser um valor igual ou maior que zero, representando o deslocamento da página desejada.

limitinteger

Tamanho da página desejada. Este valor determina a quantidade de resultados a serem retornados em uma única consulta.

reference_idstring

Identificador único do assinante na sua aplicação importada para o sistema PagBank (Max 65 caracteres).

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

qstring

Informação complementar de identificação. Forneça apenas uma das seguintes informações: <br/>- Número do documento do assinante (CPF ou CNPJ). <br/>- Nome do assinante. <br/>- E-mail do assinante.

Response

200

Example response

{
  "result_set": {
    "total": 2
  },
  "customers": [
    {
      "id": "CUST_07684F0F-8998-417E-90C0-6BC364CE30F0",
      "reference_id": "Seu_ID_de_referencia_do_cliente",
      "email": "email.do.novo.cliente@empresa.com.br",
      "name": "Nome do seu novo cliente",
      "tax_id": "20764276000",
      "phones": [
        {
          "id": 1,
          "area": "11",
          "country": "55",
          "number": "11112222"
        }
      ],
      "birth_date": "1980-10-11",
      "address": {
        "street": "Rua Minas Gerais",
        "number": "1234",
        "complement": "casa",
        "locality": "Centro",
        "city": "Belo Horizonte",
        "region_code": "MG",
        "country": "BRA",
        "postal_code": "31275000"
      },
      "billing_info": [
        {
          "type": "CREDIT_CARD",
          "card": {
            "token": "TOKE_D148AF0B-3D56-429C-AAF2-929018CD2BC4",
            "brand": "mastercard",
            "first_digits": "532649",
            "last_digits": "3382",
            "exp_month": "12",
            "exp_year": "2026",
            "holder": {
              "name": "Cartão gerando na internet"
            }
          }
        }
      ],
      "created_at": "2022-06-09T10:44:45.37074-03:00",
      "updated_at": "2022-06-09T10:44:45.370749-03:00",
      "links": [
        {
          "rel": "SELF",
          "href": "http://sandbox.api.assinaturas.pagseguro.com/customers/CUST_07684F0F-8998-417E-90C0-6BC364CE30F0",
          "media": "application/json",
          "type": "GET"
        }
      ]
    }
  ]
}