Criar Transferência

POST

/api/user/cashout

Este endpoint permite criar um saque para uma chave pix indicada.

Para realizar cashout para a própria titularidade, preencha o campo toSeller: true, que será enviado na chave pix relacionada ao número do documento CPF/CNPJ.

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟢202Análise de proteção!

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/user/cashout' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 500,
  "pixKey": "000.000.000-00",
  "pixType": "CPF",
  "beneficiaryName": "João da Silva",
  "beneficiaryDocument": "000.000.000-00",
  "description": "Saque de R$ 5,00.",
  "postbackUrl": "http://localhost:3000"
}'

Response Example

200 - Success

{
  "data": {
    "id": "417b2f6e-f0ba-4869-bd29-83ea4d3dfadd",
    "createdAt": "2026-02-07T03:12:12.812Z",
    "endToEndId": "E5555555504339348453538468582704",
    "externalRefClient": "teste",
    "fee": 200,
    "pixKey": "erickyanSP@gmail.com",
    "pixType": "EMAIL",
    "beneficiaryAccountAgency": "0001",
    "beneficiaryAccountNumber": "123456",
    "beneficiaryDocument": "60418467000188",
    "beneficiaryName": "J. G. MARKETING DIGITAL LTDA",
    "beneficiaryPsp": "Banco de Teste",
    "status": "PAID"
  },
  "message": "Transferência realizado com sucesso!",
  "status": 200,
  "error": false
}

Modified at 2026-02-07 02:33:15

Listar Transferências

Buscar Saldo