Create Corridor

POST

/v2/send/corridors

• Staging
• Development

Create a new corridor

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

name

required

Corridor name

string

USDC/PAK

sourceStablecoinSymbol

required

Source stablecoin symbol

string

USDC

sourceStablecoinDecimals

Source stablecoin decimals

number

6

destinationFiatSymbol

required

Destination fiat symbol

string

PAK

destinationFiatDecimals

Destination fiat decimals

number

2

intermediateFiatCurrency

required

Intermediate fiat currency

string

USD

intermediateFiatDecimals

Intermediate fiat decimals

number

2

chain

required

Blockchain network

string

base

contractFeeBasisPoints

Contract fee basis points

number

0

baseFeeBasisPoints

Base fee basis points

number

0

deployerWalletAddress

required

Deployer wallet address

string

0x1234567890abcdef1234567890abcdef12345678

collectionContractDeploymentId

required

Collection contract deployment ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

stablecoinContractDeploymentId

required

Stablecoin contract deployment ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

treasuryWalletAddress

required

Treasury wallet address

string

0xabcdef1234567890abcdef1234567890abcdef12

offrampWalletAddress

required

Offramp wallet address (Circle Mint wallet for withdrawals)

string

0x9876543210fedcba9876543210fedcba98765432

offrampAddressBookId

Offramp address book ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

routeNonce

required

Route nonce for corridor

string

route-nonce-123

isActive

Whether corridor is active

boolean

true

corridorRateId

Optional corridor rate ID to link

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

Responses

201

Corridor created successfully

object

id

required

Corridor unique identifier

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

organisationId

required

Organisation ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Corridor name

string

USDC/PAK

sourceStablecoinSymbol

required

Source stablecoin symbol

string

USDC

destinationFiatSymbol

required

Destination fiat symbol

string

PAK

intermediateFiatCurrency

required

Intermediate fiat currency

string

USD

chain

required

Blockchain network

string

base

contractFeePercentage

required

Contract fee percentage

string

0.0100

baseFeePercentage

required

Base fee percentage

string

0.0200

deployerWalletAddress

required

Deployer wallet address

string

0x1234567890abcdef1234567890abcdef12345678

collectionContractDeploymentId

required

Collection contract deployment ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

stablecoinContractDeploymentId

required

Stablecoin contract deployment ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

treasuryWalletAddress

required

Treasury wallet address

string

0xabcdef1234567890abcdef1234567890abcdef12

offrampWalletAddress

required

Offramp wallet address (Circle Mint wallet for withdrawals)

string

0x9876543210fedcba9876543210fedcba98765432

isActive

required

Whether corridor is active

boolean

corridorRateId

Corridor rate ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error