Skip to content
Gave

Programs

Your cashback programs. Versions never change: publish a new one, at least 5 minutes before it comes into force.

List your programs

GET/v1/programs

Your programs, each with every version published.

Responses

Read a program

GET/v1/programs/{programId}

The program, with every version published.

Path Parameters

programIdRequired
string·min 1·max 128

The program's ID, which you chose.

Responses

Publish a program version

PUT/v1/programs/{programId}/versions/{version}

Publishes a version of a program: its rates, tiers, campaigns, caps, budget and holding period. A published version never changes; it applies to purchases from its effectiveFrom, which must be at least 5 minutes after you publish it. The same version again answers duplicate: true; other content under its number is a 409.

Rates are in basis points (100 is 1%), amounts in the asset's smallest unit. A program pays from your vault, in one asset, for spend in the matching currency: USDC for USD, EURe for EUR. To stop a program, publish a version that pays nothing.

Path Parameters

programIdRequired
string·min 1·max 128

The program's ID, which you chose.

versionRequired
integer·min 1·max 1000000

The version's number, which you choose: 1 to 1,000,000.

Request Body

application/json
assetRequired
string
Values
USDCEURe
effectiveFromRequired
string <date-time>
categoriesRequired
object[]·max 100

baseRateRequired
integer·min 0·max 10000
categoryRatesRequired
object[]·max 200

merchantRatesRequired
object[]·max 1000

tiersRequired
object[]·max 20

campaignsRequired
object[]·max 50

firstPurchase
object

capsRequired
object

exclusionsRequired
object

monthlyBudget
string·max 78
holdingPeriodDays
integer·min 0·max 365
eligibility
object

referral
object

Responses