Guides
API Reference

🏦 Transaction Events

Transaction events are notifications sent to partners when there are updates or changes related to transactions involving their users. These notifications help partners stay informed about the status of various transactions.

Suggest Edits

Types of Transaction Events

  1. COMPLETED_ON_RAMP (Completed On-Ramp):

    • Description: This event is triggered when an "on-ramp" transaction (converting fiat currency to cryptocurrency) has been successfully completed.
    • Use Case: The partner updates their system to reflect that the user's on-ramp transaction has been finalized, allowing the user to access or utilize their newly acquired cryptocurrency.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "COMPLETED_ON_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "e02f6f44-ec8e-4b96-9d3b-2f05fa1d0f1a",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO",
  "blockchain": "Ethereum",
  "cryptoCurrency": "ETH",
  "fiatCurrency": "USD",
  "fiatAmount": "1000"
}

  2. COMPLETED_OFF_RAMP (Completed Off-Ramp):

    • Description: This event is triggered when an "off-ramp" transaction (converting cryptocurrency to fiat currency) has been successfully completed.
    • Use Case: The partner updates their system to reflect that the user's off-ramp transaction has been finalized, indicating the user has received their fiat currency.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "COMPLETED_OFF_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "ed3b9c98-5f08-4e75-9e1c-6bd75ff2d023",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO",
  "blockchain": "Bitcoin",
  "cryptoCurrency": "BTC",
  "fiatCurrency": "EUR",
  "cryptoAmount": "0.05"
}

  3. CREATED_ON_RAMP (Created On-Ramp):

    • Description: This event is triggered when a new on-ramp transaction (fiat to cryptocurrency) has been initiated.
    • Use Case: The partner can record the initiation of a new on-ramp transaction and begin tracking its status.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "CREATED_ON_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "b0a7de5e-0f6d-4f78-90c3-6e4c9e623d75",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO"
}

  4. RECEIVED_USER_CRYPTO (Received User Crypto):

    • Description: This event is triggered when a partner's user has sent cryptocurrency to Capa's wallet, and Capa is starting the process of sending the equivalent fiat currency to the user's account with the partner.
    • Use Case: The partner is informed that the user has transferred cryptocurrency to Capa, and the process to exchange it for fiat currency and deposit it into the user’s account has begun. The partner can update their system to reflect this ongoing transaction status.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "RECEIVED_USER_CRYPTO",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "a1f2b3c4-5678-4abc-8def-1234567890ab",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO"
}

  5. CREATED_OFF_RAMP (Created Off-Ramp):

    • Description: This event is triggered when a new off-ramp transaction (cryptocurrency to fiat) has been initiated.
    • Use Case: The partner can record the initiation of a new off-ramp transaction and begin tracking its status.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "CREATED_OFF_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "c3f4d5e6-7890-4def-8abc-0987654321fe",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO"
}

  6. CANCELLED_ON_RAMP (Cancelled On-Ramp):

    • Description: This event is triggered when an on-ramp transaction (fiat to cryptocurrency) has been cancelled.
    • Use Case: The partner can update their system to reflect that the user's on-ramp transaction has been cancelled.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "CANCELLED_ON_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "e7f8g9h0-1234-4abc-8def-9876543210ab",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO",
  "blockchain": "Ethereum",
  "cryptoCurrency": "ETH",
  "fiatCurrency": "USD",
  "fiatAmount": "1000"
}

  7. CANCELLED_OFF_RAMP (Cancelled Off-Ramp):

    • Description: This event is triggered when an off-ramp transaction (cryptocurrency to fiat) has been cancelled.
    • Use Case: The partner can update their system to reflect that the user's off-ramp transaction has been cancelled.
    • Example Payload: 
      {
  "type": "TRANSACTION",
  "event": "CANCELLED_OFF_RAMP",
  "externalUserId": "4e6c9c80-6c4a-4bfe-8f70-3a0e4db6d015",
  "transactionId": "h1i2j3k4-5678-4def-8abc-2345678901cd",
  "firstName": "SATOSHI",
  "lastName": "NAKAMOTO",
  "blockchain": "Bitcoin",
  "cryptoCurrency": "BTC",
  "fiatCurrency": "EUR",
  "cryptoAmount": "0.05"
}

Summary of Transaction Events

These transaction events help partners automate their response to changes in transaction statuses:

  • COMPLETED_ON_RAMP and COMPLETED_OFF_RAMP: Confirm that a user's transaction has been successfully completed.
  • CREATED_ON_RAMP and CREATED_OFF_RAMP: Notify the partner when a new transaction is initiated.
  • CANCELLED_ON_RAMP and CANCELLED_OFF_RAMP: Alert the partner that a user's transaction has been cancelled.
  • RECEIVED_USER_CRYPTO: Indicates that Capa has received cryptocurrency from a partner's user and the process of sending fiat currency to the user has started.

By processing these events, partners can ensure their systems are up-to-date with the latest transaction statuses and take appropriate actions to manage user interactions and maintain accurate records.

Updated 3 months ago