Skip to main content
POST
Flush Account To Account

Overview

This endpoint flushes the balance of an account to another account.

Request

Method: POST
URL: /v1/accounts/{account_number}/flush

Parameters

Request Body

Response

Status Code: 201 Created
Content-Type: application/json

Example Response

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Path Parameters

account_number
integer
required

Body

application/json

Provide the required values for the request body.

beneficiary
object
required
reference
string
required

Provide transaction reference

Response

201 - application/json

Created

The response is of type object.