Ordem de saque

Gerar uma ordem de saque para o usuário do parceiro, poderá ser via cripto ou via PIX.

Gerando uma ordem de saque

POST /api/partners/withdraw-order

Utilize este endpoint para gerar uma ordem de saque, tanto para o recebimento via PIX, quanto para o recebimento via cripto.

Headers

Key
Value
Description

Content-Type

application/json

x-client-id

string

clientId recebido.

x-timestamp

string

UNIX timestamp em segundos.

x-signature

string

HMAC signature.

Body

Name
Type
Description

partnerTransactionId

string

Identificador único das suas transações.

userId

string

Deve ser o mesmo userId do seu sistema ou que tenha uma correlação única, para maior compatibilidade nas transações web3.

userCpf

string

Obrigatório se a ordem de saque for do tipo: PIX_WITHDRAW

userPixKey

string

Obrigatório se a ordem de saque for do tipo: PIX_WITHDRAW

pixKeyType

string

Obrigatório se a ordem de saque for do tipo: PIX_WITHDRAW Os tipos de chave deverão ser: EMAIL ou DOCUMENT ou PHONE ou RANDOM

userWalletAddress

string

Obrigatório se a ordem de saque for do tipo: CRYPTO_WITHDRAW

productName

string

Nome do produto ou serviço.

quantity

number

Quantidade do produto ou serviço.

unitPrice

number

Preço do produto ou serviço.

usdtAmount

number

Quantidade em Dolar a ser sacado.

withdrawalType

string

Tipo de saque:

PIX_WITHDRAW ou CRYPTO_WITHDRAW

Response

{
    "status": true,
    "message": "Data fetched successfully",
    "data": {
        "ids": {
            "businessId": "BUSINESS",
            "partnerTransactionId": "abc12345678915",
            "internalTransactionId": "463545735988310410792181904123034233320984",
             "brCode": "00020101021226910014br.gov.bcb.pix2569qrcode.pix.celcoin.com.br/pixqrcode/v2/07f5813e5018f4660d7456eb956de95204000053039865802BR5923CNOP INTERMEDIACAO LTDA6014RIO DE JANEIRO62070503***63046DC4",
            "gatewayId": "kk6g232xel65a0daee4dd13kk2729226845"
        },
        "transactionPayload": {
            "userId": "user_001",
            "userCpf": "096.123.939-44",
            "productName": "Produto Teste 1",
            "quantity": 2,
            "unitPrice": 0.000003,
            "usdtAmount": 2.03,
            "reaisAmount": 13.23,
        },
        "transactionStatus": "WAITING_PAYMENT",
        "typeError": "NONE",
        "errorMessage": "NONE",
        "transactionType": "PIX_PURCHASE",
        "createdAt": "12/05/2025 18:57:28"
    }
}

O parceiro deverá salvar na sua base de dados o getewaiIdgerado na resposta da requisição para futuras consultas e conciliações de valores e transações.

o parâmetro brCode é o que chamamos de "copia e cola" e ele deverá ser usado para gerar o QRCODE para seu usuário pagador.

Last updated

Was this helpful?