API

Pix Cash Out

post
https://api.sandbox.paybrokers.com/v1/partners-int/v4/withdraw/pix/cpf
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Attention:

It is possible to make a Cashout transaction using only the account details, in which case it is mandatory to fill in the account field and the pix-key and pix-key-type fields must be removed.

Body Params
float
required
Defaults to 1

Payment Amount in decimal format (e.g., "200.00")

string
enum
required

Type of the PIX key.

Allowed:
string
required

Recipient Pix key.

string
required

Receiver CPF number

string

A custom reference_id the integrator need to provide for idempotency and counter-check when the response arrives.

string
Defaults to *

Receiver Person Name. Default value is "*"

string
required

An absolute Webhook URL that will receive the notification event.

string

A custom description associated to the reference_id, to check on the transaction response.

payment
object

Object containing payment information, such as bank details.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?