Rewards

Authorize Reward PayoutDeprecated

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

410

Gone.

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

default

application/json

{"status": 401,
"title": "Unauthorized",
"detail": "Invalid token",
"type": "https://httpproblems.com/http-status/401",
"instance": "/v1/customer-vault/customer1/international-bank-account/",
"trace": {"timestamp": "2023-01-31T23:56:21Z",
"requestId": "4487062e-52db-4d89-b46b-7035d681cb40"
}
}

Claim RewardDeprecated

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

410

Gone.

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

default

application/json

{"status": 401,
"title": "Unauthorized",
"detail": "Invalid token",
"type": "https://httpproblems.com/http-status/401",
"instance": "/v1/customer-vault/customer1/international-bank-account/",
"trace": {"timestamp": "2023-01-31T23:56:21Z",
"requestId": "4487062e-52db-4d89-b46b-7035d681cb40"
}
}