Recipients

Add recipients

Creates one or more recipients. Each recipient receives an onboarding URL they can use to complete their profile and (optionally) tax information.

post/recipients

Request

  • Base URL
    https://payouts.api.trykarat.com
  • Auth
    HTTP bearer

Request body

Response

The recipients were created.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.