Rewards

Authorize Reward Payout

Role Requirements

tenant-transaction-write or tenant-admin

Description

Authorize a reward payout.

Securitybearer

Request

path Parameters

customerRef

required

string [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$

The Customer reference.

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id. Example: 00000000-0000-0000-0000-000000000000
x-tenant-id required	string <uuid> = 36 characters The Tenant Id. Example: 00000000-0000-0000-0000-000000000000
x-correlation-id	string Correlation Id for the request.

Request Body schema: application/json

orderRef required	string (OrderRef) <= 50 characters ^[a-zA-Z0-9-_\.]+$ The order reference. [Required].
instructionRef required	string (InstructionRef) <= 50 characters ^[a-zA-Z0-9-_\.]+$ The instruction reference. [Required].
amount required	number <decimal> (Amount) Currency amount. The number of decimal digits is validated against the currency code of the payment.
currency required	string (Currency) ^[A-Z]{3}$ ISO 4217 code (3 uppercase letters) for the chosen currency.

Responses

200

Success

400

Bad Request - Validation error response, containing errors such as:

OrderRef is required.
InstructionRef is required.
Amount is required.
Currency is required.

default

All other managed 4xx and 5xx errors

post/v2/customer-vault/{customerRef}/reward/authorize

Request samples

application/json

{"orderRef": "order1",
"instructionRef": "instruction1",
"amount": 20,
"currency": "GBP"
}

Response samples

400
default

application/json

OrderRef is required.

{"timestamp": 1692016778499,
"correlationId": "0HMB2TA322CA7:00000001",
"errors": [{"errorCode": "ORDER_REF_IS_REQUIRED",
"message": "OrderRef is required.",
"messageTemplate": "OrderRef is required."
}
]
}

Claim Reward

Role Requirements

tenant-transaction-write or tenant-admin

Description

Claim a reward.

Securitybearer

Request

path Parameters

customerRef

required

string [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$

The Customer reference.

header Parameters

x-account-id required	string <uuid> = 36 characters The Account Id. Example: 00000000-0000-0000-0000-000000000000
x-tenant-id required	string <uuid> = 36 characters The Tenant Id. Example: 00000000-0000-0000-0000-000000000000
x-correlation-id	string Correlation Id for the request.

Request Body schema: application/json

financialInstrumentId required	string <uuid> The financial instrument Id.
rewardId required	string <uuid> The reward Id.

Responses

200

Success

400

Bad Request - Validation error response, containing errors such as:

RewardId is not recognised.

default

All other managed 4xx and 5xx errors

post/v2/customer-vault/{customerRef}/reward/claim

Request samples

application/json

{"financialInstrumentId": "457ef7ad-2172-4a22-a10a-5beda28d3ae1",
"rewardId": "02c89c5a-d051-4afa-8c9b-bc6cc5f64b5d"
}

Response samples

400
default

application/json

RewardId {rewardId} is not recognised.

{"timestamp": 1692016778499,
"correlationId": "0HMB2TA322CA7:00000001",
"errors": [{"errorCode": "REWARD_ID_NOT_RECOGNISED",
"message": "RewardId [rewardId] is not recognised.",
"messageTemplate": "RewardId {rewardId} is not recognised.",
"metadata": {"rewardId": "rewardId"
}
}
]
}