Create Withdraw

POST https://api.ipsfenix.com/withdrawintegration/create

Endpoint utilizado para iniciar uma solicitação de saque. Caso o valor solicitado seja maior que o saldo estipulado para saque, a solicitação irá cair para análise manual, devendo ser aceita no sistema do gateway.

Campos que devem ser informados:

Body

{
  "value": 1.99,
  "pixKey": "00000000000",
  "typeKeyPix": 1,
  "customer": {
    "firstName": "Nome devedor",
    "lastName": "Sobrenome devedor",
    "cpfCnpj": "00000000000",
    "email": "[email protected]",
    "phone": "64999999999"
  },
  "tags": ["#TAG1", "#TAG2"],
  "identifier":"R1L5xfWfRc"
}

Descrição:

Parâmetro	Obrigatório	Tipo	Descrição
value	SIM	Number	Valor da transação PIX gerada
pixKey	SIM	String	Chave pix para onde vai ser realizado o pagamento. Exemplos: CPF/CNPJ - 00000000000, Telefone: 5511999999999, Chave aleatória: 4e85b465-ec2a-4feb-8628-2efb6390150c, E-mail: [email protected].
typeKeyPix	NÃO	Number	Tipos de chave: 1 - CPF/CNPJ, 2 - EMAIL, 3 - TELEFONE, 4 - CHAVE ALEATÓRIA. Por padrão é definido CPF/CNPJ.
firstName	SIM	String	-
lastName	SIM	String	-
cpfCnpj	SIM	String	No momento só é aceito CPF (sem caracteres especiais) e deve ser válido
email	SIM	String	-
phone	NÃO	String	Deve conter 11 dígitos, sendo o DDD antes do número de telefone.
tags	NÃO	Array	Array de Strings para identificação de saque
identifier	NÃO	String	Deve ser único a cada solicitação de saque, para evitar pagamentos duplicados.

Respostas esperadas

Status Code	Descrição
200 - OK	Requisição bem sucedida.
202 - Accepted	Requisição de operação assíncrona bem sucedida.
400 - Bad Request	Requisição inválida. Geralmente acontece por envio de parâmetros inválidos ou falta de dados para a operação.
503 - Server Error	Servidor em manutenção.