Skip to main content
POST
Approve or Decline Payout

Overview

This endpoint allows you to approve or decline a pending payout request. You must provide the authCode from the pending approval record along with the desired action. A reason is required when declining.

Request

Method: POST URL: /v1/payouts/approvals/approve

Parameters

Request Body

When action is decline, the reason field is required. For approve, it can be left as an empty string or omitted.

Response

Status Code: 200 OK Content-Type: application/json

Example Response (Approved)

Example Response (Declined)

Error Responses

Status Code: 400 Bad Request
Status Code: 422 Unprocessable Entity Returned when action is decline but reason is missing.

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Body

application/json

Provide the required values for the request body.

authCode
string
required

Authorization code of the pending payout.

Example:

"TRF-1771341301552SNKED"

action
enum<string>
required

Action to take: approve or decline.

Available options:
approve,
decline
Example:

"approve"

reason
string

Reason for declining. Required when action is decline.

Example:

""

Response

OK

The response is of type object.