API Reference

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

networkStrstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

burnTxidstringRequiredPattern: ^0x[0-9a-fA-F]*$

eventIndexnumberRequired

withdrawalIdstringRequired

Responses

200

Response for status 200

application/json

withdrawalIdstringRequired

The UUID of the withdrawal

400

Response for status 400

text/plain

401

Response for status 401

text/plain

post

/{networkStr}/withdrawals

HTTPcURLJavaScriptPython

POST /{networkStr}/withdrawals HTTP/1.1
Host: api.usdc-on-stacks.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 880

{
  "burnEventData": {
    "amount": "text",
    "nativeDomain": "text",
    "nativeRecipient": "text",
    "sender": "text",
    "topic": null
  },
  "burnIntent": {
    "maxBlockHeight": "text",
    "maxFee": "text",
    "spec": {
      "destinationCaller": "text",
      "destinationContract": "text",
      "destinationDomain": 1,
      "destinationRecipient": "text",
      "destinationToken": "text",
      "hookData": {
        "forwardingCalldata": "text",
        "forwardingContractAddress": "text",
        "remoteDepositor": "text",
        "remoteDomain": 1,
        "remoteToken": "text"
      },
      "salt": "text",
      "sourceContract": "text",
      "sourceDepositor": "text",
      "sourceDomain": 1,
      "sourceSigner": "text",
      "sourceToken": "text",
      "value": "text",
      "version": 1
    }
  },
  "burnTxid": "text",
  "circleResponse": {
    "burnTxId": "text",
    "status": null,
    "transferSpecHashes": [
      "text"
    ],
    "useCircleForwarding": true,
    "withdrawalId": "text",
    "attestation": "text",
    "attestationPayload": "text",
    "failureReason": "text",
    "transactionHash": "text"
  },
  "eventIndex": 1,
  "withdrawalId": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "withdrawalId": "text"
}

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

networkStrstringRequired

Responses

200

Response for status 200

application/json

successbooleanRequired

400

Response for status 400

text/plain

401

Response for status 401

text/plain

post

/{networkStr}/withdrawals/test-authentication

HTTPcURLJavaScriptPython

POST /{networkStr}/withdrawals/test-authentication HTTP/1.1
Host: api.usdc-on-stacks.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

get

Path parameters

burnTxidstringRequiredPattern: ^0x[0-9a-fA-F]*$

eventIndexstringRequiredPattern: ^(?:(?!^-0$)-?(?:(?:0|[1-9]\d*)))$

Responses

200

Response for status 200

application/json

burnTxidstringRequired

createdAtstringRequired

eventIndexnumberRequired

withdrawalIdstringRequired

404

Response for status 404

text/plain

get

/{networkStr}/withdrawals/{burnTxid}/{eventIndex}

HTTPcURLJavaScriptPython

GET /{networkStr}/withdrawals/{burnTxid}/{eventIndex} HTTP/1.1
Host: api.usdc-on-stacks.com
Accept: */*

{
  "burnEventData": {
    "amount": "text",
    "nativeDomain": "text",
    "nativeRecipient": "text",
    "sender": "text",
    "topic": null
  },
  "burnIntent": {
    "maxBlockHeight": "text",
    "maxFee": "text",
    "spec": {
      "destinationCaller": "text",
      "destinationContract": "text",
      "destinationDomain": 1,
      "destinationRecipient": "text",
      "destinationToken": "text",
      "hookData": {
        "forwardingCalldata": "text",
        "forwardingContractAddress": "text",
        "remoteDepositor": "text",
        "remoteDomain": 1,
        "remoteToken": "text"
      },
      "salt": "text",
      "sourceContract": "text",
      "sourceDepositor": "text",
      "sourceDomain": 1,
      "sourceSigner": "text",
      "sourceToken": "text",
      "value": "text",
      "version": 1
    }
  },
  "burnTxid": "text",
  "circleResponse": {
    "burnTxId": "text",
    "status": null,
    "transferSpecHashes": [
      "text"
    ],
    "useCircleForwarding": true,
    "withdrawalId": "text",
    "attestation": "text",
    "attestationPayload": "text",
    "failureReason": "text",
    "transactionHash": "text"
  },
  "circleStatus": {
    "burnTxId": "text",
    "status": null,
    "transferSpecHashes": [
      "text"
    ],
    "useCircleForwarding": true,
    "withdrawalId": "text",
    "attestation": "text",
    "attestationPayload": "text",
    "failureReason": "text",
    "transactionHash": "text"
  },
  "createdAt": "text",
  "eventIndex": 1,
  "withdrawalId": "text"
}

get

get

/

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Host: api.usdc-on-stacks.com
Accept: */*