Create an improvement tier

Creates an improvement tier for a source currency. A tier defines a threshold and an improvement in basis points that applies to your base rate for transactions at or above that threshold. If a live tier already exists for the same source currency and threshold, it is automatically superseded. When Nexus generates a quote, it selects the tier with the greatest threshold that does not exceed the transaction amount, and adds tier and PSP improvements together in basis points before applying them, so improvements never compound. An idempotency key header is recommended. Requires the scope tiers.write. Used by: FX Providers (FXPs)

Idempotency-Keystring uuid

Recommended for POST requests. A UUID used to deduplicate retried submissions.

Request body

sourceCurrencystring required

ISO 4217 currency code of the source currency, three uppercase letters.

thresholdnumber required

Minimum transaction size, in the source currency, at which the tier applies. Must be greater than 0.

improvementBpsinteger required

Improvement applied to the base rate, in basis points. Must be greater than or equal to 0.

Response

The created tier record.

tierIdstring required

Unique ID of the tier record.

fxpIdstring required

ID of the FXP that owns this tier.

sourceCurrencystring required

ISO 4217 currency code of the source currency, three uppercase letters.

thresholdnumber required

Minimum transaction size, in the source currency, at which the tier applies. Must be greater than 0.

improvementBpsinteger required

Improvement applied to the base rate, in basis points. Must be greater than or equal to 0.

createdDateTimestring date-time required

Timestamp at which the tier record was created.

isExpiredboolean required

Historical marker set to true when the tier is replaced or withdrawn.

expiryDateTimestring date-time nullable

Timestamp at which the tier was replaced or withdrawn. A historical marker only.

b3e625f21841

Create an improvement tier

Headers

Request body

Response