GET
/
v1
/
payouts
/
status
/
{reference}
Fetch Payout Status
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts/status/{reference} \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "message": "payout fetched successfully",
  "data": {
    "status": "SUCCESS",
    "message": "STAGING Env Success | Transfer in progress - null",
    "amount": 150,
    "total": 175,
    "fee": 25,
    "reference": "121324-43554-65656-67676-00-00010010",
    "uniqueRef": "204041344312337",
    "beneficiary": {
      "bankCode": "057",
      "accountNumber": "00000000",
      "accountName": "ALex Oyo",
      "bankName": "Zenith Bank"
    }
  }
}

​
Overview

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

​
Request

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

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
referencePathstringYesThe unique reference of the payout.

​
Response

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

​
Example Response

{
  "status": "success",
  "message": "payout fetched successfully",
  "data": {
    "status": "SUCCESS",
    "message": "STAGING Env Success | Transfer in progress - null",
    "amount": 150,
    "total": 175,
    "fee": 25,
    "reference": "121324-43554-65656-67676-00-00010010",
    "uniqueRef": "204041344312337",
    "beneficiary": {
      "bankCode": "057",
      "accountNumber": "00000000",
      "accountName": "ALex Oyo",
      "bankName": "Zenith Bank"
    }
  }
}

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.