v1

latestOpenAPI 3.1.02026-07-26202027.9 KB

Recipients

Get a recipient

Retrieves a single recipient by its ID, including lifetime earnings totals (paid, pending, held, in cents) and a summary of their current payment method.

get/recipients/{recipient_id}

Path parameters

recipient_idstring uuid required

The ID of the recipient.

Response

The recipient.

Example response

{
  "data": {
    "earnings": {
      "paid": 125000,
      "pending": 15000,
      "held": 5000
    },
    "paymentMethod": {
      "method": "ACH",
      "currency": "USD"
    }
  }
}