Create Send Configuration

POST

/v2/send/config

• Staging
• Development

Create a new send service configuration for the organisation

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

Unique configuration name (e.g., “alliedx”, “fsco”)

string

alliedx-local

displayName

required

Display name for the configuration

string

AlliedX Send Service

description

Optional description of the configuration

string

isActive

Whether the configuration is active

boolean

default: true

Responses

201

Send configuration created successfully

object

id

required

Send Client ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Send client name

string

allied

displayName

required

Send client display name

string

AlliedX

description

Send service description

string

corridors

required

Supported corridors

Array<object>

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