Skip to main content
GET
/
v1
/
platform
/
disbursements
/
{disbursementId}
Get Disbursement
curl --request GET \
  --url https://api.cadanapay.com/v1/platform/disbursements/{disbursementId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "87eec1a4-d757-45be-a75e-f3638d044750",
  "tenantKey": "tbl28153208",
  "status": "SUCCESS",
  "referenceId": "9c4829a8-0177-4dad-a0d8-e4f8fc42276a",
  "description": "January 2026 Payment",
  "type": "PAYROLL_TOTAL",
  "fxRate": 5.7896,
  "paymentMethod": "bank",
  "paymentDetails": {
    "preferredMethod": "bank",
    "momo": {
      "accountName": "John Doe",
      "provider": "MTN",
      "providerCode": "MTN",
      "phoneNumber": {
        "countryCode": "1",
        "number": "2345678901"
      },
      "currency": "GHS"
    },
    "bank": {
      "accountName": "John Doe",
      "accountNumber": "1234567890",
      "accountType": "Checking",
      "ownerType": "individual",
      "bankCode": "EXMPJPJT",
      "bankName": "Gotham City Bank",
      "branchName": "Downtown Branch",
      "sortCode": "401234",
      "iban": "GB00000000000000000000",
      "provider": "wise",
      "currency": "USD",
      "beneficiaryId": {
        "type": "NIT",
        "value": "123456789"
      },
      "address": {
        "countryCode": "US",
        "line1": "Street 1",
        "line2": "Apt 1",
        "city": "Gotham",
        "postalCode": "10001",
        "state": "NY"
      },
      "phoneNumber": {
        "countryCode": "1",
        "number": "2345678901"
      },
      "email": "john.doe@example.com"
    },
    "swift": {
      "currency": "EUR",
      "iban": "DE00000000000000000000",
      "accountName": "John Doe",
      "accountNumber": "1234567890",
      "bankName": "Example Bank",
      "swiftCode": "EXMPDEFF",
      "address": {
        "countryCode": "US",
        "line1": "Street 1",
        "line2": "Apt 1",
        "city": "Gotham",
        "postalCode": "10001",
        "state": "NY"
      }
    },
    "ach": {
      "bankName": "Example Bank",
      "accountName": "John Doe",
      "routingNumber": "000000000",
      "accountNumber": "1234567890",
      "accountType": "Checking",
      "provider": "wise",
      "address": {
        "countryCode": "US",
        "line1": "Street 1",
        "line2": "Apt 1",
        "city": "Gotham",
        "postalCode": "10001",
        "state": "NY"
      }
    },
    "wallet": {
      "type": "user",
      "identifier": "69a2a928-ed49-4e53-92ec-a72b4ee7eacc",
      "currency": "USD"
    },
    "wire": {
      "bankName": "Example Bank",
      "accountName": "John Doe",
      "routingNumber": "000000000",
      "accountNumber": "123456789",
      "address": {
        "countryCode": "US",
        "line1": "Street 1",
        "line2": "Apt 1",
        "city": "Gotham",
        "postalCode": "10001",
        "state": "NY"
      }
    }
  },
  "userId": "8cb1d569-5dfd-4b33-b25e-4fab0ee14251",
  "personId": "7fc25070-8037-44f8-8c42-9d05ffc01f0b",
  "userName": "Paula Torres",
  "amount": {
    "value": "10.00",
    "currency": "USD"
  },
  "sourceAmount": {
    "value": "10.00",
    "currency": "USD"
  },
  "feeAmount": {
    "value": "10.00",
    "currency": "USD"
  },
  "totalAmount": {
    "value": "10.00",
    "currency": "USD"
  },
  "fxRevenueShare": {
    "amount": {
      "value": "10.00",
      "currency": "USD"
    },
    "rate": 1
  },
  "feeRevenueShare": {
    "amount": {
      "value": "10.00",
      "currency": "USD"
    },
    "rate": 1
  },
  "totalRevenueShare": {
    "value": "10.00",
    "currency": "USD"
  },
  "estimatedDelivery": "<string>",
  "externalReference": "<string>",
  "createdTimestamp": "2026-01-28 14:29:09 +0000 UTC",
  "lastUpdatedTimestamp": "2026-01-28 14:29:18 +0000 UTC"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
disbursementId
string<uuid>
required

The unique identifier for the disbursement

Response

Disbursement details

​
id
string<uuid>

Unique transaction identifier

Example:

"87eec1a4-d757-45be-a75e-f3638d044750"

​
tenantKey
string

Identifies which business this transaction belongs to

Example:

"tbl28153208"

​
status
enum<string>

Transaction status

Available options:
SUCCESS,
FAILED,
INITIATED,
PROCESSING,
ROUTED
Example:

"SUCCESS"

​
referenceId
string<uuid>

External reference ID. Payroll transactions from the same run share the same referenceId.

Example:

"9c4829a8-0177-4dad-a0d8-e4f8fc42276a"

​
description
string

Human-readable description of the transaction

Example:

"January 2026 Payment"

​
type
enum<string>

Transaction type. The possible values depend on the endpoint — see the operation description for the set each endpoint returns. A business disbursement is one of: PAYROLL_TOTAL, PAYROLL, PAYROLL_FEE, PAYROLL_REVERSAL, DEPOSIT, DEPOSIT_REVERSAL, VENDOR, REVENUE_SHARE_PAYOUT, REIMBURSEMENT, SUBSCRIPTION_PAYMENT, STATUTORY_DEPOSIT.

Available options:
PAYOUT,
PAYROLL,
PAYROLL_TOTAL,
PAYROLL_FEE,
PAYROLL_REVERSAL,
VENDOR,
DEPOSIT,
DEPOSIT_REVERSAL,
REVENUE_SHARE_PAYOUT,
REIMBURSEMENT,
SUBSCRIPTION_PAYMENT,
STATUTORY_DEPOSIT,
CARD_MAINTENANCE_FEE,
CARD_CREATION_FEE,
STOCK_BUY,
STOCK_SELL,
INTEREST
Example:

"PAYROLL_TOTAL"

​
fxRate
number | null

Foreign exchange rate applied. Only present for cross-currency transactions.

Example:

5.7896

​
paymentMethod
enum<string>

How funds were delivered

Available options:
bank,
momo,
wallet,
ach,
card,
proxy
Example:

"bank"

​
paymentDetails
object
​
userId
string<uuid>

The wallet/user account ID. Present on wallet-based transactions. For payroll, only present when payment is delivered to a wallet.

Example:

"8cb1d569-5dfd-4b33-b25e-4fab0ee14251"

​
personId
string<uuid> | null

The employee or contractor ID. Present only on payroll transactions.

Example:

"7fc25070-8037-44f8-8c42-9d05ffc01f0b"

​
userName
string

Recipient name

Example:

"Paula Torres"

​
amount
object

Amount the recipient receives in the destination currency

​
sourceAmount
object

Cost in the source currency before fees

​
feeAmount
object

Fees charged in the source currency

​
totalAmount
object

Total debited from the sender (sourceAmount + feeAmount)

​
fxRevenueShare
object | null

Revenue earned from the FX spread. Only present when applicable.

​
feeRevenueShare
object | null

Revenue earned from transaction fees. Only present when applicable.

​
totalRevenueShare
object | null

Combined total revenue share

​
estimatedDelivery
string | null

Estimated time the funds will be delivered to the recipient

​
externalReference
string | null

External reference associated with the transaction, when available

​
createdTimestamp
string

Timestamp when the transaction was created

Example:

"2026-01-28 14:29:09 +0000 UTC"

​
lastUpdatedTimestamp
string

Timestamp when the transaction was last updated

Example:

"2026-01-28 14:29:18 +0000 UTC"