Creates new PIX withdrawal request by key

POST 
/api/withdraw

Creates a new withdrawal request using PIX as the payment method.

Request

application/json

Body

required

value doublerequired

Value to be paid

type_key_pix type_key_pix (string)required

Possible values: [cpf, cnpj, email, phone, evp]

PIX key type

key key (string)required

PIX key

description description (string)required

Description of the payment

client_name client_name (string)required

Client's name

client_email client_email (string)required

Client's email

client_document client_document (string)required

Client's document (CPF or CNPJ)

merchant_id merchant_id (string)required

Merchant's ID for conciliation

Responses

200

Successful operation

application/json

Schema

Schema

status status (string)

Possible values: [pending, failed]

Transaction's status

message message (string)

Payment's description

transaction_uuid transaction_uuid (string)

Transaction's UUID

Example (from schema)

{
  "status": "pending",
  "message": "Withdrawal payment done",
  "transaction_uuid": "7da0c9af-215e-4625-b484-b8cfc87aaa09"
}

400

Bad Request

401

Unauthenticated

application/json

Schema

Schema

message message (integer)

Response 401

Example (from schema)

{
  "message": "Invalid x-api-key"
}

403

Forbidden

Authorization: http

name: paas_tokentype: httpscheme: bearerbearerFormat: JWTdescription: Token utilizado para autenticação na Api PaaS

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://docs.zrobank.io/api/withdraw' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "value": "10.00",
  "type_key_pix": "phone",
  "key": "+5533123456789",
  "description": "Payment to client",
  "client_name": "John",
  "client_email": "client@email.com",
  "client_document": "13813438058",
  "merchant_id": "123456"
}'

Request Collapse all

Auth

Bearer Token

Body required

{
  "value": "10.00",
  "type_key_pix": "phone",
  "key": "+5533123456789",
  "description": "Payment to client",
  "client_name": "John",
  "client_email": "client@email.com",
  "client_document": "13813438058",
  "merchant_id": "123456"
}