Documentação completa

Fazer um Pix

Para utilizar esse método, o access_token deve conter o scope balance.write

Permite realizar um Pix para uma chave Pix de mesma titularidade.

Dados da requisição

Nome
Tipo
Obrigatório
Explicação
key
string 60 caracteres
Sim
Chave Pix
type
string 255 caracteres
Sim
Tipo da chave Pix
Valor Explicação
cpf Documento: CPF
cnpj Documento: CNPJ
email E-mail
mobilePhone Celular
random Chave Aleatória (EVP)
value
int 11 dígitos
Sim
Valor da transferência Pix.
desc
string 140 caracteres
Não
Descrição interna do pagamento.

URL da Requisição

https://api.sandbox.cel.cash/v2/pix/payment

Body da requisição

Carregando...

Código da resposta

---

Tempo de resposta

---

Body da Resposta


{
    "type": true,
    "Payment": {
        "galaxPayId": 1,
        "key": "04059032271",
        "value": 12999,
        "desc": "Lorem ipsum dolor sit amet.",
        "endToEnd": "E202405200325307CDCB53978F4747FAA1E85DAB7B37013",
        "status": "efectivated",
        "createdAt": "2020-06-02 10:10:00"
    }
}
Nome
Tipo
Explicação
type
bool
Sucesso ou não da ação.
Payment
Dados da transferência Pix
Clique para ver os campos.
galaxPayId
int 11 dígitos
Id no cel_cash
key
string 60 caracteres
Chave Pix
value
int 11 dígitos
Valor da transferência Pix.
desc
string 140 caracteres
Descrição interna do pagamento.
endToEnd
string 255 caracteres
Identificação única do pagamento no Banco Central.
status
string 25 caracteres
Status da transferência.
Valor
Explicação
efectivated
Efetivado
error
Devolvido por Erro
confirm
Confirmado, aguardando efetivação
createdAt
datetime
Data de criação.
Código
Explicação
200
Pix enviado com sucesso.
400
Erros de validação.
401
Falha ao autenticar.
403
Validação de segurança.