Crypto on-ramp

Event	Trigger
order:crypto-onramp:committed	User placed an order.
order:crypto-onramp:charged	User has been charged for their order.
order:crypto-onramp:completed	User's order has completed.
order:crypto-onramp:failed	User's order has failed.
order:crypto-onramp:refund:completed	User's order has been successfully refunded.

order:crypto-onramp:committed

Triggered when a user has placed an order.

Schema

• id: UUID of the order.
• status: Status of the order (pending).
• createdAt: Timestamp at which the order was created.
• updatedAt: Timestamp at which the order was last updated.
• origin: Object containing information about how the user paid.
  • amount: Amount the user will pay.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• destination: Object containing information about what the user will receive.
  • amount: Amount the user will receive.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user will receive.
  • network: Network of the receiving asset.
  • address: Recipient wallet address.
  • tag (optional): Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
  • priority (optional): Priority of the crypto transaction.
• fees: Array containing fees associated with the order.
  • amount: Amount user was charged for this fee.
  • asset: Asset used to charge the fee.
  • normalized: Amount in USD that the user was charged for this fee.
  • type: Type of fee (network, deposit or partner).
• widget: Widget associated with the session.
  • id UUID of the widget.
  • name: Name of the widget.
  • flow: Flow associated with the widget.

note

The values for origin.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-onramp:committed",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "id": "966b8e24-6a65-442a-942e-577f16288789",
    "status": "pending",
    "createdAt": "2023-06-12T17:21:21.240Z",
    "updatedAt": "2023-06-12T17:21:21.240Z",
    "origin": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "destination": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268"
    },
    "fees": [
      {
        "amount": "14.17",
        "asset": "USD",
        "normalized": "14.17",
        "type": "network"
      },
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_onramp"
    }
  }
}

order:crypto-onramp:charged

Triggered when a user has been charged.

Schema

• id: UUID of the order.
• status: Status of the order (processing).
• createdAt: Timestamp at which the order was created.
• updatedAt: Timestamp at which the order was last updated.
• origin: Object containing information about how the user paid.
  • amount: Amount the user paid.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• destination: Object containing information about what the user will receive.
  • amount: Amount the user will receive.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user will receive.
  • network: Network of the receiving asset.
  • address: Recipient wallet address.
  • tag (optional): Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
  • priority (optional): Priority of the crypto transaction.
• fees: Array containing fees associated with the order.
  • amount: Amount user was charged for this fee.
  • asset: Asset used to charge the fee.
  • normalized: Amount in USD that the user was charged for this fee.
  • type: Type of fee (network, deposit or partner).
• widget: Widget associated with the session.
  • id UUID of the widget.
  • name: Name of the widget.
  • flow: Flow associated with the widget.

note

The values for origin.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-onramp:charged",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "id": "966b8e24-6a65-442a-942e-577f16288789",
    "status": "processing",
    "createdAt": "2023-06-12T17:21:21.240Z",
    "updatedAt": "2023-06-12T17:21:21.240Z",
    "origin": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "destination": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268"
    },
    "fees": [
      {
        "amount": "14.17",
        "asset": "USD",
        "normalized": "14.17",
        "type": "network"
      },
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_onramp"
    }
  }
}

order:crypto-onramp:completed

Triggered when a user's order has completed.

Schema

• id: UUID of the order.
• status: Status of the order (completed).
• createdAt: Timestamp at which the order was created.
• updatedAt: Timestamp at which the order was last updated.
• origin: Object containing information about how the user paid.
  • amount: Amount the user paid.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• destination: Object containing information about what the user received.
  • amount: Amount the user received.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user received.
  • blockchainUrl (deprecated): URL to view the transaction details on a blockchain explorer.
  • network: Network of the receiving asset.
  • address: Recipient wallet address.
  • tag (optional): Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
  • priority (optional): Priority of the crypto transaction.
  • ledger (optional): Object containing information about the transaction on the ledger.
    • txid: Transaction ID on the ledger.
    • url: URL to view the transaction details on a blockchain explorer.
• fees: Array containing fees associated with the order.
  • amount: Amount user was charged for this fee.
  • asset: Asset used to charge the fee.
  • normalized: Amount in USD that the user was charged for this fee.
  • type: Type of fee (network, deposit or partner).
• widget: Widget associated with the session.
  • id UUID of the widget.
  • name: Name of the widget.
  • flow: Flow associated with the widget.

note

The values for origin.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-onramp:completed",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "id": "966b8e24-6a65-442a-942e-577f16288789",
    "status": "completed",
    "createdAt": "2023-06-12T17:21:21.240Z",
    "updatedAt": "2023-06-12T17:21:21.240Z",
    "origin": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "destination": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "ledger": {
        "txid": "0xdfa1ea4ddb841af466a5ca78c6e1f0edfaef5e54e79a28238d2a5bb2da4f1911",
        "url": "https://etherscan.io/tx/0xdfa1ea4ddb841af466a5ca78c6e1f0edfaef5e54e79a28238d2a5bb2da4f1911"
      },
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268"
    },
    "fees": [
      {
        "amount": "14.17",
        "asset": "USD",
        "normalized": "14.17",
        "type": "network"
      },
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_onramp"
    }
  }
}

order:crypto-onramp:failed

Triggered when a user's order has failed.

Schema

• id: UUID of the order.
• status: Status of the order (failed).
• createdAt: Timestamp at which the order was created.
• updatedAt: Timestamp at which the order was last updated.
• origin: Object containing information about how the user paid.
  • amount: Amount the user paid.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• destination: Object containing information about what the user would have received.
  • amount: Amount the user would have received.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user would have received.
  • network: Network of the receiving asset.
  • address: Recipient wallet address.
  • tag (optional): Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
  • priority (optional): Priority of the crypto transaction.
• fees: Array containing fees associated with the order.
  • amount: Amount user was charged for this fee.
  • asset: Asset used to charge the fee.
  • normalized: Amount in USD that the user was charged for this fee.
  • type: Type of fee (network, deposit or partner).
• widget: Widget associated with the session.
  • id UUID of the widget.
  • name: Name of the widget.
  • flow: Flow associated with the widget.
• error: Indicates specific error information.
  • reason: Indicates the reason for the error, possible values are fraud.

note

The values for origin.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-onramp:failed",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "id": "966b8e24-6a65-442a-942e-577f16288789",
    "status": "failed",
    "createdAt": "2023-06-12T17:21:21.240Z",
    "updatedAt": "2023-06-12T17:21:21.240Z",
    "origin": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "destination": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268"
    },
    "fees": [
      {
        "amount": "14.17",
        "asset": "USD",
        "normalized": "14.17",
        "type": "network"
      },
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_onramp"
    },
    "error": {
      "reason": "fraud"
    }
  }
}

order:crypto-onramp:refund:completed

Triggered when a user's order has been successfully refunded.

Schema

• id: UUID of the order.
• status: Status of the order (refunded).
• createdAt: Timestamp at which the order was created.
• updatedAt: Timestamp at which the order was last updated.
• origin: Object containing information about how the user paid.
  • amount: Amount the user paid.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• destination: Object containing information about what the user would have received.
  • amount: Amount the user would have received.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user would have received.
  • network: Network of the receiving asset.
  • address: Recipient wallet address.
  • tag (optional): Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
  • priority (optional): Priority of the crypto transaction.
• fees: Array containing fees associated with the order.
  • amount: Amount user was charged for this fee.
  • asset: Asset used to charge the fee.
  • normalized: Amount in USD that the user was charged for this fee.
  • type: Type of fee (network, deposit or partner).
• refund: Object containing information about how much was refunded to the user.
  • formattedAmount: Amount refunded to the user
  • asset: Currency code in the ISO 4217 format used to make the payment.
  • rate: Rate used to calculate the amount.
• widget: Widget associated with the session.
  • id UUID of the widget.
  • name: Name of the widget.
  • flow: Flow associated with the widget.

note

The values for origin.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-onramp:refund:completed",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "id": "966b8e24-6a65-442a-942e-577f16288789",
    "status": "refunded",
    "createdAt": "2023-06-12T17:21:21.240Z",
    "updatedAt": "2023-06-12T17:21:21.240Z",
    "origin": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "destination": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268"
    },
    "fees": [
      {
        "amount": "14.17",
        "asset": "USD",
        "normalized": "14.17",
        "type": "network"
      },
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "refund": {
      "asset": "USD",
      "formattedAmount": "$ 100.00",
      "rate": "1770.27534301775263314892"
    },
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_onramp"
    }
  }
}