Rewards

Authorize a reward payout

Securitybearer
Request
path Parameters
customerRef
required
string
Default: ""
header Parameters
x-account-id
required
string

The Account Id

x-tenant-id
required
string

The Tenant Id

x-correlation-id
string

Correlation Id for the request

Request Body schema:
orderRef
string

The order reference.

instructionRef
string

The instruction reference.

amount
string

The amount.

currency
string

The currency code.

Responses
200

Success

401

Unauthorized

post/v2/customer-vault/{customerRef}/reward/authorize
Request samples
{
  • "orderRef": "string",
  • "instructionRef": "string",
  • "amount": "string",
  • "currency": "string"
}

Claim a reward

Securitybearer
Request
path Parameters
customerRef
required
string
Default: ""
header Parameters
x-account-id
required
string

The Account Id

x-tenant-id
required
string

The Tenant Id

x-correlation-id
string

Correlation Id for the request

Request Body schema:
financialInstrumentId
string <uuid>

The financial instrument Id.

rewardId
string

The reward Id.

Responses
200

Success

401

Unauthorized

post/v2/customer-vault/{customerRef}/reward/claim
Request samples
{
  • "financialInstrumentId": "35596f91-fea9-4297-b70b-01fdad24e25a",
  • "rewardId": "string"
}
Copyright © Imburse AG 2018-2022. All right reserved.