Skip to main content
POST
Create Payin

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Payins:Create: Always required.

Authorizations

Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

X-DFNS-USERACTION
string
header
required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Body

application/json
walletId
string
required

The destination wallet for the on-ramped funds.

Required string length: 1 - 64
Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

amount
string
required

The amount to deliver on-chain, in currency units (e.g. "100.00").

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
provider
enum<string>
required
Available options:
CircleMint
currency
enum<string>
required

Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).

Available options:
USD,
EUR

Response

200 - application/json

Success

id
string
required

Payin id.

Required string length: 1 - 64
Pattern: ^payin-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"payin-59t9u-eng2t-dd9p5nm02uc81sto"

walletId
string
required

The destination wallet for the on-ramped funds.

Required string length: 1 - 64
Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

amount
string
required

The amount to deliver on-chain, in currency units (e.g. "100.00").

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
currency
enum<string>
required

Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).

Available options:
USD,
EUR
network
enum<string>
required

The network the funds are delivered on (the destination wallet network).

Available options:
Algorand,
AlgorandTestnet,
Aptos,
AptosTestnet,
ArbitrumOne,
ArbitrumSepolia,
ArcTestnet,
AvalancheC,
AvalancheCFuji,
BabylonGenesis,
BabylonTestnet5,
Base,
BaseSepolia,
Berachain,
BerachainBepolia,
Bitcoin,
BitcoinSignet,
BitcoinTestnet4,
BitcoinCash,
Bob,
BobSepolia,
Bsc,
BscTestnet,
Canton,
CantonTestnet,
Cardano,
CardanoPreprod,
Concordium,
ConcordiumTestnet,
Celo,
CeloAlfajores,
Codex,
CodexSepolia,
CosmosHub4,
CosmosIcsTestnet,
Dogecoin,
DogecoinTestnet,
Ethereum,
EthereumClassic,
EthereumClassicMordor,
EthereumSepolia,
EthereumHoodi,
FlareC,
FlareCCoston2,
FlowEvm,
FlowEvmTestnet,
Hedera,
HederaTestnet,
Ink,
InkSepolia,
InternetComputer,
Ion,
IonTestnet,
Iota,
IotaTestnet,
Kusama,
KusamaAssetHub,
Litecoin,
LitecoinTestnet,
Movement,
MovementTestnet,
Near,
NearTestnet,
Optimism,
OptimismSepolia,
Origyn,
Plasma,
PlasmaTestnet,
Plume,
PlumeSepolia,
Paseo,
PaseoAssetHub,
Polkadot,
PolkadotAssetHub,
Polygon,
PolygonAmoy,
Polymesh,
PolymeshTestnet,
Race,
RaceSepolia,
Rayls,
RaylsTestnet,
Robinhood,
RobinhoodSepolia,
SeiAtlantic2,
SeiPacific1,
Solana,
SolanaDevnet,
Sonic,
SonicTestnet,
Starknet,
StarknetSepolia,
Stellar,
StellarTestnet,
Sui,
SuiTestnet,
Tezos,
TezosGhostnet,
TezosShadownet,
Tempo,
TempoModerato,
Tsc,
TscTestnet1,
Ton,
TonTestnet,
Tron,
TronNile,
Westend,
WestendAssetHub,
Xdc,
XdcApothem,
XLayer,
XLayerSepolia,
XrpLedger,
XrpLedgerTestnet
status
enum<string>
required

The current status of the payin.

Available options:
Processing,
Completed,
Failed
requester
object
required

The user/token that initiated the payin.

dateCreated
string<date-time>
required

ISO 8601 date (must be UTC). ISO 8601 timestamp when the payin was created.

Example:

"2023-04-14T20:41:28.715Z"

provider
enum<string>
required
Available options:
CircleMint
data
object
required

Circle Mint provider-specific payin data.

dateFinalized
string<date-time>

ISO 8601 date (must be UTC). ISO 8601 timestamp when the payin was finalized.

Example:

"2023-04-14T20:41:28.715Z"

Last modified on July 22, 2026