Crypto off-ramp

Event	Trigger
order:crypto-offramp:committed	User placed an order.
order:crypto-offramp:funds-sent	User has sent funds for their order.
order:crypto-offramp:funds-received	User has sent funds for their order and we have received them.
order:crypto-offramp:completed	User's order has completed.
order:crypto-offramp:failed	User's order has failed.
order:crypto-offramp:refund:completed	User's order has been successfully refunded.

order:crypto-offramp:committed

Triggered when a user has placed an order.

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 what the user will send.
  • amount: Amount the user will send.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user will send.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• destination: Object containing information about what the user will receive.
  • amount: Amount the user will receive.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp:committed",
  "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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "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_offramp"
    }
  }
}

order:crypto-offramp:funds-sent

Triggered when a user has sent funds for their order.

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 what the user sent.
  • amount: Amount the user sent.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user sent.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• destination: Object containing information about what the user will receive.
  • amount: Amount the user will receive.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp:funds-sent",
  "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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "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_offramp"
    }
  }
}

order:crypto-offramp:funds-received

Triggered when a user has sent funds for their order and we have received them.

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 what the user sent.
  • amount: Amount the user sent.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user sent.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• destination: Object containing information about what the user will receive.
  • amount: Amount the user will receive.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp:funds-received",
  "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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "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_offramp"
    }
  }
}

order:crypto-offramp: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 what the user sent.
  • amount: Amount the user sent.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user sent.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• destination: Object containing information about what the user received.
  • amount: Amount the user received.
  • rate: Rate used to calculate the amount.
  • asset: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp:completed",
  "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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "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_offramp"
    }
  }
}

order:crypto-offramp: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 what the user sent.
  • amount: Amount the user sent.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user sent.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• 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: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp: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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "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_offramp"
    },
    "error": {
      "reason": "fraud"
    }
  }
}

order:crypto-offramp:refund:completed

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

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 what the user sent.
  • amount: Amount the user sent.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user sent.
  • network: Network of the sending asset.
  • depositAddress: Object containing information related to the deposit.
    • expiredAt: Timestamp at which the deposit expires.
    • remindAt: Timestamp at which the user is reminded.
    • tag: Tag of the crypto transaction, used to complement the address.
      • type: Tag type.
      • value: Tag value.
    • value: Address to which the user sends the funds.
• 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: Currency code in the ISO 4217 format used to receive the funds.
  • paymentMethod: Object containing information about the payment method used.
    • type: Type of payment method.
• 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.
  • amount: Amount the user received.
  • rate: Rate used to calculate the amount.
  • asset: Cryptoasset the user received.
  • network: Network of the receiving asset.
  • address: User's wallet address to receive funds.
  • priority: Priority of the crypto transaction.
  • tag: Tag of the crypto transaction, used to complement the address.
    • type: Tag type (e.g.: memo or destination-tag).
    • value: Tag value.
• 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 destination.paymentMethod.type can be found using our REST API, via the payment methods endpoint.

Example

{
  "name": "order:crypto-offramp:refund:completed",
  "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": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "depositAddress": {
        "expiredAt": "2023-06-12T17:21:21.240Z",
        "remindAt": "2023-06-12T17:21:21.240Z",
        "value": "0xb794F5eA0ba39494cE839613fffBA74279579268"
      }
    },
    "destination": {
      "amount": "100.00",
      "rate": "1770.27534301775263314892",
      "asset": "USD",
      "paymentMethod": {
        "type": "credit-card"
      }
    },
    "fees": [
      {
        "amount": "2.42",
        "asset": "USD",
        "normalized": "2.42",
        "type": "deposit"
      },
      {
        "amount": "1.00",
        "asset": "USD",
        "normalized": "1.00",
        "type": "partner"
      }
    ],
    "refund": {
      "amount": "0.047116964221968237",
      "rate": "0.00056488387749632223",
      "asset": "ETH",
      "network": "ethereum",
      "address": "0xb794F5eA0ba39494cE839613fffBA74279579268",
      "priority": "normal"
    },
    "widget": {
      "id": "998544f2-5b01-4062-9394-22827ff5db6c",
      "name": "ACME",
      "flow": "crypto_offramp"
    }
  }
}