Skip to content

Send gifts straight to the provider​

PUT
/fundraisers/{id}/resources/{linkId}/payout

The fundraiser's owner turns direct payout on or off. It is not a flag: turning it on changes the fundraiser's own beneficiary (beneficiary_type nonprofit, org_id the provider's non-profit, type charity), the existing non-profit beneficiary path checkout reads on every gift, in one transaction with the link, and remembers the previous beneficiary; turning it off restores exactly that. On needs a confirmed link (link_not_confirmed) to an active (provider_not_active) non-profit or church (a business or community: 422 payout_not_offered), a fundraiser not already raising for a non-profit (already_nonprofit), no waiting beneficiary invitation (beneficiary_invitation_pending), a linked person when raising for someone else (beneficiary_person_required), and the non-profit path's own checks: verified (nonprofit_not_verified), USD, no account deletion hold (account_deletion_hold) and a payout account that can receive money now (nonprofit_account_not_ready, payments_disabled). After the first gift or payment, both directions answer 409 payout_locked. A transfer, merge or decline later leaves the beneficiary as it is; off still works from that link while nothing is locked. Idempotent.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The fundraiser.

Type
string
Required
Format
"uuid"
linkId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"on": true
}

Responses​

The organizer's view after the change.

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress