PIX - Cash-Out

Endpoint para transferência de valores através de PIX.

Atenção: Deve-se autorizar o endereço de IP para processar transações de saída. Caso deseje que sua carteira tenha livre acesso de IP, deve-se entrar em contato com o suporte para solicitar liberação.


HEADERS

ci: cliente ID

cs: cliente secret

Request

Variável
Type
Descrição

key

String

Chave PIX

typeKey

String

Tipo da Chave PIX, aceitamos os seguintes tipos: document(CPF/CNPJ), phoneNumber(6299995432), email

value

Number

Valor total da transferêcia

callbackUrl

String

URL de webhook para receber as informações de pagamento.

documentValidation

String

CPF do recebedor (deve ser do proprietário da chave PIX)

const myHeaders = new Headers();
myHeaders.append("ci", "client ID");
myHeaders.append("cs", "client Secret");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "value": 10,
  "key": "62999819652",
  "typeKey": "phoneNumber",
  "callbackUrl": "https://webhook.com/",
  "documentValidation": "999.999.000-11"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.xmazzu.com/api/v1/gateway/pix-payment", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Response

Variável
Type
Descrição

idTransaction

String

ID único da transação

response

String

Mensagem de retorno da solicitação

{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "response": "OK"
}

Campo response

OK - Transação realizada com sucesso

PIX_KEY_NOT_FOUND - Chave PIX não encontrada ou CPF não pertence a chave informada

NO_FUNDS - Saldo insuficiente

Atualizado

Isto foi útil?