Affiliate Programs

Record affiliate transaction

Records a sale made by a referred customer and generates affiliate commissions for their referrer when applicable.

post/campaign/{id}/participant/{participantIdOrEmail}/transaction

Request

Base URL
https://api.growsurf.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/growsurf/apis/growsurf-rest-api/docs/campaign/:id/participant/:participantIdOrEmail/transaction/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

GrowSurf program ID.

participantIdOrEmailstring required

GrowSurf participant ID or URL-encoded participant email address.

currencystring required

grossAmountinteger required

netAmountinteger

taxAmountinteger

amountCashNetinteger

amountPaidinteger

paidAtinteger

externalIdstring

transactionIdstring

customerIdstring

orderIdstring

paymentIdstring

invoiceIdstring

subscriptionIdstring

paymentIntentIdstring

chargeIdstring

descriptionstring

invoiceTotalinteger

invoiceTotalExcludingTaxinteger

invoiceSubtotalExcludingTaxinteger

totalTaxAmountinteger

totalTaxAmountsobject[]

totalTaxesobject[]

Transaction result returned.

No recorded changes to this operation across all 7 revisions of this API.