TruBit Business
πŸ‡ΊπŸ‡Έ EN 2025/05/08
πŸ‡ΊπŸ‡Έ EN 2025/05/08
  • πŸ“– Guides
    • A Gentle Introduction
    • Step-by-Step Guide
    • Creating TruBit Account
    • Creating API Key
      • Safely Store Your API Key
      • Configure Whitelisted IPs
      • Enable API Access
      • Create API Token
    • Sandbox
    • Creating Your Merchant
    • Creating Payment Method
    • Payment Method ID
    • Currencies
    • Pair
    • Creating Webhook Listener
    • Fiat to Crypto (On-Ramp)
    • Crypto to Fiat (Off-Ramp)
    • Fiat to Fiat (Global Payment)
  • πŸ“— API Reference
    • Basic Configuration
      • API Endpoint
      • Get List of Countries
      • Get List of Fiat Currencies
      • Get List of Crypto Currencies
      • Get Fiat/Crypto Pairs
      • Get Crypto/Fiat Pairs
      • Get Fiat/Fiat Pairs
      • Get Fiat/Crypto Payment Methods
      • Get Crypto/Fiat Payment Methods
      • Get Fiat/Fiat Payment Methods
    • Account
      • Get Account Details
      • Get Crypto Assets Balance
      • Get Crypto Deposit Address
    • Merchant
      • Add Merchant
      • Get a List of Merchants
      • Get a List of Merchant Accounts
      • Retrieve Pending Fund
      • Claim Pending Fund
      • Get Transfer Pending Funds Fee
      • Transfer Pending Funds
      • Retrieve Funding Records
    • Quote
      • Get User Quote for Crypto/Fiat
      • Get User Quote for Fiat/Fiat
    • Payment Method
      • Get Payment Templates
      • Add Payment Method
      • Get Payment Method
      • Delete Payment Method
      • Set Refund Account
    • Order
      • Create a Fiat to Crypto Order
      • Create a Crypto to Fiat Order
      • Create a Fiat to Fiat Order
      • Confirm a Specific Order
      • Retrieve a Specific Order
      • Retrieve a List of Orders
      • Upload Invoice Documents For a Specific Order
    • Webhooks
      • Create Webhook Endpoints
      • Get Webhook Endpoints
      • Update a Webhook
      • Delete a Webhook
      • Fiat/Crypto Order Message Push
      • Fiat/Fiat Order Message Push
      • Funding Records Message Push
  • πŸ› οΈ Error Reference
    • Error and Warning Dictionary
  • πŸͺ„Changelog
    • πŸ••Changelog
Powered by GitBook
On this page
  1. πŸ“— API Reference
  2. Webhooks

Funding Records Message Push

TruBit uses webhooks to notify merchants of funding-related events in real time, such as deposits, withdrawals, crypto purchases, and refunds. When triggered, a POST request with detailed transaction data is sent to your configured webhook URL.

Endpoint Information

  • Request Method: POST

  • Request Path: (Specify the appropriate path for your webhook notifications)

Request Body Parameters

The request body should include the following fields:

{
    "webhookId": "ebab8a9663704e7cbbebe672c7c67912",  // (number: ID of the webhook)
    "eventType": "FUNDING_WEBHOOK",                  // (string: event type [FUNDING_WEBHOOK: merchant funding event])
    "txId": "1123123123",                            // (number: ID of the fiat claim)
    "merchantId": "3",                               // (number: ID of the merchant)
    "merchantName": "Rrturo Tellez",                 // (string: name of the merchant)
    "fiat": "ARS",                                   // (string: name of the fiat currency)
    "totalAmount": "22.00",                          // (decimal: total fiat amount)
    "amount": "20.00",                               // (decimal: actual fiat amount)
    "fee": "2.00",                                   // (decimal: amount of the fee)
    "userPaymentId": "91",                           // (number: ID of the user payment method)
    "type": "DEPOSIT",                               // (enum: type [DEPOSIT: The add of the funding record, WITHDRAW: The claim of the funding record, BUY_CRYPTO: The buy crypto of the funding record, REFUND: The refund of the funding record])
    "status": "1",                                   // (enum: status [1: pending, 2: completed, 3: canceled])
    "createTime": "1737452292000",                   // (string: timestamp of the create time in milliseconds)
    "updateTime": "1737452344000",                  // (string: timestamp of the update time in milliseconds)
    "payerName": "Matias Alva",                      // (string: name of the entity sending funds)
    "payerAccount": "CH8508843132556121020"          // (string: bank account of the entity sending funds)
    
}

Response Structure

The response will include the following fields:

{
    "callbackStatus": "SUCCESS"                      // (string: callback status; if SUCCESS is returned, the message is successfully notified)
}

Example Request

{
    "webhookId": "ebab8a9663704e7cbbebe672c7c67912",
    "eventType": "FUNDING_WEBHOOK",
    "txId": "1123123123",
    "merchantId": "3",
    "merchantName": "Rrturo Tellez",
    "fiat": "ARS",
    "totalAmount": "22.00",
    "amount": "20.00",
    "fee": "2.00",
    "userPaymentId": "91",
    "type": "DEPOSIT",
    "status": "1",
    "createTime": "1737452292000",
    "updateTime": "1737452344000",
    "payerName": "Matias Alva",
    "payerAccount": "CH8508843132556121020" 
}

Example Response

{
    "callbackStatus": "SUCCESS"
}

Notes

  • Ensure that the webhook URL is properly configured to receive and process the notification.

  • The callbackStatus indicates whether the message was successfully sent to the webhook. If it shows SUCCESS, the notification was sent without issues.

PreviousFiat/Fiat Order Message PushNextError and Warning Dictionary

Last updated 1 month ago