Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial


On this page:


POST Receiving Policy

https://api.premepay.com/v1/stores/:store-id/receiving-policy

You can define whether you want the withdrawal of the available balance to occur automatically, choosing a specific day and the recurrence. If you activate this option, we will automatically make the transfer to your bank account, according to your configuration.

If you prefer not to use this option, just make a transfer manually.

Parameters List

Parameter Type Description Required
isAutomaticTransfer boolean Automatic withdrawal Yes
minimumTransferValue int Minimum amount (in cents) for withdrawal. If you want the minimum value to be R$ 1.00, set the value to 100. Yes
transferInterval Daily, Weekly, Monthly Recurrence in which the withdrawal must occur Yes (if option isAutomaticTransfer is true)
transferDay int The day on which the withdrawal should take place (between 1 and 31) Yes (if option isAutomaticTransfer is true)

Example request to activate automatic withdrawal

This is an example of what your request should look like for automatic withdrawal to be enabled.

Responses

Example request to activate manual withdrawal

This is an example of what your request must look like for manual withdrawal to be enabled.

Responses

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/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>