Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial


On this page:


You can make unlimited withdrawals to your bank account. Use this endpoint call to receive the amounts available for your sales. Withdrawals in test environment do not work.

<aside> ⚠️ Primefy only makes withdrawals to the same CPF/CNPJ registered in your registration.

</aside>

POST Create withdrawal

https://api.premepay.com/v1/stores/:id/bank_accounts/:id/balance/withdrawal

Parameters List

Parameter Description
amount Amount to be withdrawn
description Brief description

Request example

This is an example of what your request to authenticate might look like.

Responses

If your request is successful, you will receive the return of the consumer object.

If your request has invalid creation parameters - for example, specifying an invalid field or value - you may receive an error response. Below is the complete list of possible error responses:


Related Content

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - List withdrawals

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Create internal transfer

</aside>