First step

Developers must first configure the transaction fee rate，More about create fee rate refer here，
If you have already set it up, please skip this step.

request example

Second step

Initiate a payment request to perform OnRamp crediting, more info you can refer here

you requestType must choose（1）,more about enums you can refer here

request example

response example

{
    "retcode": "200",
    "retdata": {
        "id": 834,
        "txNo": "TR202512250254492609",
        "clientId": 600002476,
        "requestId": "544b66e1-0d00-4d4a-89ba-a360cec35f01",
        "fromCurrency": "USD",
        "toCurrency": "USDC",
        "amount": 120,
        "reallyAmount": 120,
        "totalFee": 0,
        "walletTo": "0xd6b9f3e54ac111b91588f13f2a1fb4fc20806dec",
        "requestType": 1,
        "status": 2,
        "messageHash": "BRGMVK2Z4CKZND34UCUA",
        "rate": 1,
        "bankAccountNumber": "11223344556677",
        "bankRoutingNumber": "123456789",
        "bankBeneficiaryName": "Bridge Ventures Inc",
        "bankBeneficiaryAddress": "1234 Elm St, Springfield, IL 12345",
        "bankName": "Bank of Nowhere",
        "bankAddress": "1800 North Pole St., Orlando, FL 32801",
        "needConfirm": false
    },
    "success": true
}

Third step

Using the bank information (account number, routing code, etc.) from the API response, deposit the indicated fiat sum into the corresponding bank account.

Fourth step（Execute based on conditions.）

In Step 2, if the response indicates "needConfirm": true, you must invoke the confirmTransactionAPI to confirm the transaction.
More about Confirm Transaction here

example request

example response

{
    "retcode": "200",
    "success": true
}

Final step

Call the query request to check the transaction execution result

example request

example response

{
    "retcode": "200",
    "retdata": {
        "status": "Completed",
        "paymentRequest": {
            "id": 687,
            "txNo": "TR202510310621563495",
            "clientId": 600002476,
            "requestId": "d3a4e1f0-9b3c-4d5e-8f3a-1b2c3d4f5435",
            "fromCurrency": "USD",
            "toCurrency": "WUSD",
            "amount": 100.00000000,
            "reallyAmount": 100.00000000,
            "totalFee": 0E-8,
            "walletTo": "0x8D33153772DDe6e6eaF21E6217777f867d08519C",
            "requestType": 1,
            "status": 3,
            "createdAt": "2025-10-31T06:21:56.302186",
            "gasFee": 0.00004584
        },
        "paymentFund": {
            "id": 368,
            "clientId": 600002476,
            "requestId": "624d4b3c-5eff-4d79-a9ed-351edac778d6",
            "currency": "USD",
            "fundType": "Fiat",
            "amount": 100.00000000,
            "depositId": "624d4b3c-5eff-4d79-a9ed-351edac778d6",
            "amountLimit": 20.00000000,
            "status": "Executed"
        },
        "executeLegs": [
            {
                "id": 1285,
                "requestId": 687,
                "legType": 1,
                "fromCurrency": "USD",
                "toCurrency": "WUSD",
                "channel": "cmsCryptoWithdrawExecutor",
                "stage": 2,
                "routeId": 11,
                "status": 4
            },
            {
                "id": 1286,
                "requestId": 687,
                "legType": 1,
                "fromCurrency": "USD",
                "toCurrency": "WUSD",
                "channel": "cmsOnRampExecutor",
                "stage": 1,
                "routeId": 11,
                "status": 3
            }
        ]
    },
    "success": true
}

If the status is "Completed", it means this OnRamp transaction has succeeded.You can view the enums of ClientStatus here.

create on-ramp request

First step#

request example#

Second step#

request example#

response example#

Third step#

Fourth step（Execute based on conditions.）#

example request#

example response#

Final step#

example request#

example response#

First step

request example

Second step

request example

response example

Third step

Fourth step（Execute based on conditions.）

example request

example response

Final step

example request

example response