POST: https://staging.pay2free.com/v2/withdraw/create
Dictionary Withdraw
| Type | |
|---|---|
| merchant (required) | Provided by us, it's an internal ID that identifies the merchant |
| externalId (required) | Client id in your system |
| cpf (required) | Payer document |
| email (required) | Payer's email address |
| name (required) | Payer's name |
| phone (required) | Payer's phone number |
| birthday (required) | Payer's birthday |
| pixKey (required) | Key that identifies client's account in brazilian payment system. It is currently possible to send Pix (cash-out) to multiple keys, be it CPF, email, telephone or random key. |
| value (required) | Transaction value. |
| transactionId (required) | Your identifier for this transaction. Must be unique and will be used in our webhook to notify events about this transaction |
Use the cURL below to start testing:
curl --location 'https://{baseurl}/v2/withdraw/create' \
--header 'x-pixer-api-key: Api-Key TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchant": "64abf106aa289a9578099537",
"client": {
"externalId": "38af8438-6016-4fd5-8049-e66dc427b5d8",
"cpf": "103.339.816-00",
"email": "[email protected]",
"name": "Alexandre Gustavo Galvão",
"phone": "+5582998950275",
"birthday": "1960-06-09"
},
"pixKey": "10333981600",
"value": 0.01,
"transactionId": "00000005"
}'
Success (withdrawal sent to processing queue)
When your withdrawal was successful:
{
"transactionId": "181819200601",
"responseStatus": "200"
}