Criar Cliente

A criação de um cliente é essencial para operar com cobranças recorrentes.

Há 2 formas de trabalhar com a criação de um cliente:

  1. Criando o cliente antes da cobrança associada a ele (fluxo descrito nessse tópico)
  2. Criando o cliente junto da cobrança (nesse caso, o próprio fluxo de criação de cobrança recorrente, quando passados todos os dados do cliente, cria o cliente automaticamente, fluxo descrito aqui)

Após um cliente ter sido criado, é possível editar ou excluir.

Para utilizar o endpoint de criação de um cliente, é necessário obter um token.


Criando um cliente

Para criar um cliente, tendo um token válido, utilize o endpoint Criar Cliente.

Após a criação ser feita com sucesso, será retornado um Identificador dessa criação de cliente, denominada galaxPayId.

👍

É possível utilizar um identificador externo, denominado myId na criação do cliente. Esse identificador pode tabém ser utilizado nas cobranças futuras que serão criadas para esse cliente.


Exemplo de Request

curl --request POST \
     --url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/customers?account=1' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer {TOKEN}' \
     --header 'content-type: application/json' \
     --data '
{
    "name": "Cliente Luscas",
    "document": "76850063081",
    "emails": [
        "[email protected]"
    ],
    "phones": [
        31971855612
    ],
    "Address": {
        "zipCode": "30411325",
        "street": "Rua platina",
        "number": "1375",
        "complement": "2º andar",
        "neighborhood": "Prado",
        "city": "Belo Horizonte",
        "state": "MG"
    },
     "ExtraFields": [
        {
            "tagName": "ruanito",
            "tagValue": 52
        }
    ]
}'

👍

Sucesso 200

Exemplo de Response

{
    "type": true,
    "Customer": {
        "myId": "pay-69986bd3119289.40008705",
        "galaxPayId": 41759,
        "name": "Lorem ipsum dolor sit amet",
        "document": "55300123374",
        "createdAt": "2026-02-20 11:20:15",
        "updatedAt": "2026-02-20 11:20:15",
        "emails": [
            "[email protected]",
            "[email protected]"
        ],
        "phones": [
            3140201512,
            31983890110
        ],
        "Address": {
            "zipCode": "30411330",
            "street": "Rua platina",
            "number": "1330",
            "complement": "2º andar",
            "neighborhood": "Prado",
            "city": "Belo Horizonte",
            "state": "MG"
        },
        "ExtraFields": []
    }
}

Os detalhes dos campos estão decritos no API Reference.


Possíveis cenários de atenção

  1. Avalie no API Refence as informações que são obrigatórias.
  2. Um mesmo cliente pode ser cadastrado mais de uma vez com o mesmo documento. Seu cadastro não é sobrescrito. A cada requisição é criado um novo ID para o cliente.