POST/api/v2/referrals/accounting/openings

POST /api/v2/referrals/accounting/openings

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
ProgramIdstring (uuid)No
CurrencystringNo
OpeningAtstring (date-time)No
EarnedBalanceunknownNoSigned earned obligation: accrued entitlement less confirmed cash. May include recovery debt.
ReservedExposureunknownNo
EvidencestringNo
BeneficiaryBalancesobjectNoOptional evidenced signed balance by beneficiary; sum must equal EarnedBalance. Needed to distinguish owed rewards from recovery receivables.

Responses

200 — OK

Example request

curl -X POST "https://{base_url}/api/v2/referrals/accounting/openings" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.