Skip to main content
GET
Fetch Payout Status

Overview

This endpoint retrieves the status of a specific payout using the provided reference.

Request

Method: GET
URL: /v1/payouts/status/{reference}

Parameters

Response

Status Code: 200 OK
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

reference
integer
required

Response

200 - application/json

OK

The response is of type object.