API references
Search documentation... ⌘K
API references
Merchant API

Turn off auto payout

Disable automatic payouts to your bank account. When auto payout is turned off:

  • Funds from your transactions will accumulate in your merchant balance
  • You'll need to manually request payouts when you want to withdraw funds
  • You can still view your available balance and payout history
  • You can turn auto payout back on at any time

This is useful if you want more control over when you receive your funds, for example:

  • To accumulate a larger balance before withdrawing
  • To manually time your payouts with your business needs
  • To temporarily hold funds during account changes

The endpoint returns true if auto payout was successfully disabled.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/turn-off-auto-payout HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{}
Returns: boolean
New to Reservepay? Read our guide on how to call endpoints to get started.
Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/turn-off-auto-payout" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'

Learn how to run these code samples in your terminal by reading our guide.