Skip to content

Create Corridor Rate

POST
/v2/send/corridors/{corridorId}/rates

Create a new corridor rate

corridorId
required
string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09

Corridor ID

object
corridorId
required

Corridor ID

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
stablecoinToFiatRateId
required

Foreign key to exchange_rate table for stablecoin-to-fiat rate

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
fiatToFiatRateId
required

Foreign key to exchange_rate table for fiat-to-fiat rate

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
toleranceMinRateBaseUnits
required

Minimum tolerance rate in base units (6 decimals). e.g., 990000 = 0.9900

string
990000
toleranceMaxRateBaseUnits
required

Maximum tolerance rate in base units (6 decimals). e.g., 1001000 = 1.0010

string
1001000

Created successfully

Corridor rate created successfully

object
corridorId
required

Corridor ID

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
corridorRateId
required

Corridor rate ID

string format: uuid
d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09
corridorName
required

Corridor name

string
USDC/PAK
stablecoinToFiatRateBaseUnits
required

Stablecoin to intermediate fiat rate (e.g., USDC/USD) with 6 decimals of precision

string
1000000
fiatToFiatRateBaseUnits
required

Intermediate fiat to destination fiat rate (e.g., USD/PKR) with 6 decimals of precision

string
27850000
finalRateBaseUnits
required

Combined exchange rate (final USDC to destination fiat rate) with 6 decimals of precision

string
27850000
toleranceMinRateBaseUnits
required

Minimum tolerance rate in base units (6 decimals). Rate value for comparison, e.g., 990000 = 0.9900

string
990000
toleranceMaxRateBaseUnits
required

Maximum tolerance rate in base units (6 decimals). Rate value for comparison, e.g., 1001000 = 1.0010

string
1001000
calculatedAt
required

When this rate was calculated

string format: date-time
expiresAt
required

When this rate expires

string format: date-time

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error