Criar Transferência

POST

/api/user/cashout

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

Necessário solicitar acesso

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": "123e4567-e89b-189-654e-426614174000",
    "amount": 500,
    "fee": 50,
    "pixKey": "000.000.000-00",
    "pixType": "CPF",
    "beneficiaryName": "João da Silva",
    "beneficiaryDocument": "000.000.000-00",
    "creditorName": null,
    "creditorDocument": null,
    "endToEndId": null,
    "receiptUrl": null,
    "description": "Saque de R$ 5,00.",
    "postbackUrl": "http://localhost:3000/postback",
    "externalRef": null,
    "error": null,
    "status": "PENDING",
    "sellerId": "sa65d4dd6e-5b19-11ee-be56-0242ac120002",
    "gatewayProviderId": "3c9a9ad1-5b19-3424-be56-0242ac120002",
    "gatewayId": "3434331-5b19-11ee-be56-0242ac120002",
    "createdAt": "2024-11-22T15:20:10.394Z",
    "updatedAt": "2024-11-22T15:20:10.394Z"
  },
  "status": 200,
  "message": "Cashout criado com sucesso.",
  "error": null
}

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2025-08-15 20:38:54

Listar Transferências

Criar Transferência