Get Webhooks

GET

https://api-stg.transak.com/partners/api/v2/webhooks

GET

/partners/api/v2/webhooks

curl https://api-stg.transak.com/partners/api/v2/webhooks \
     -H "access-token: " \
     -H "x-api-key: "

{
  "meta": {
    "limit": 100,
    "skip": 0,
    "totalCount": 1,
    "orderID": "322dc79c-fad2-4df1-bf50-b292191fc953",
    "eventID": "ORDER_COMPLETED",
    "status": "success"
  },
  "data": [
    {
      "id": "670e7c469f2a5dd93fbe4406",
      "partnerApiKey": "d79671a4-b021-4a4f-a444-6862a680a94b",
      "createdAt": "2024-10-15T14:29:26.929Z",
      "eventID": "ORDER_COMPLETED",
      "webhookData": {
        "id": "322dc79c-fad2-4df1-bf50-b292191fc953",
        "walletAddress": "0xD902d7E",
        "createdAt": "2024-10-15T14:29:11.104Z",
        "status": "COMPLETED",
        "fiatCurrency": "GBP",
        "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
        "cryptoCurrency": "ETH",
        "isBuyOrSell": "BUY",
        "fiatAmount": 45,
        "ipAddress": "35.177.158.9",
        "amountPaid": 45,
        "paymentOptionId": "gbp_bank_transfer",
        "bankReference": "VD180620260000056",
        "walletLink": "https://sepolia.etherscan.io/address/0xD902d7eBFeE",
        "quoteId": "20148892-f984-4e3f-8bb7-fba6c0ec9182",
        "orderProcessingType": "NORMAL",
        "addressAdditionalData": false,
        "network": "ethereum",
        "conversionPrice": 0.0004122498271491127,
        "cryptoAmount": 0.01788752,
        "totalFeeInFiat": 1.61,
        "fiatAmountInUsd": 49.1,
        "countryCode": "IN",
        "stateCode": "Karnataka",
        "orderChannelType": "WIDGET",
        "tokenContractAddress": "0x0000000000000000000000000000000000000000",
        "userKycType": "STANDARD",
        "cardPaymentData": {
          "orderId": "322dc79c-fad2-4df1-bf50-b292191fc953",
          "paymentId": "670e7c387b5777f9332927b6",
          "pgData": {
            "liquidityProvider": "OPENPAYD_MALTA",
            "status": "CREATED",
            "beneficiaryName": "Abc Xyz",
            "paymentOptions": [
              {
                "currency": "GBP",
                "id": "gbp_bank_transfer",
                "name": "Bank Transfer Details",
                "fields": [
                  {
                    "name": "Account Type",
                    "value": "Personal"
                  },
                  {
                    "name": "Amount",
                    "value": "45 GBP"
                  },
                  {
                    "name": "First Name (Beneficiary)",
                    "value": "Abc"
                  },
                  {
                    "name": "Last Name (Beneficiary)",
                    "value": "Xyz"
                  },
                  {
                    "name": "IBAN",
                    "value": "GB57SEOU19870010260405"
                  },
                  {
                    "name": "Bank Name",
                    "value": "Simulator Bank"
                  },
                  {
                    "name": "Bank Country",
                    "value": "Malta"
                  },
                  {
                    "name": "Bank Address",
                    "value": "The Bower, 207-211 Old Street, London, England, EC1V 9NR"
                  }
                ]
              }
            ]
          },
          "liquidityProvider": "OPENPAYD_MALTA",
          "updatedAt": "2024-10-15T14:29:12.243Z"
        },
        "statusHistories": [
          {
            "status": "PENDING_DELIVERY_FROM_TRANSAK",
            "createdAt": "2024-10-15T14:29:15.542Z",
            "message": "💸 Payment reconciled successfully. Received 45 GBP",
            "isEmailSentToUser": false,
            "partnerEventId": "ORDER_PROCESSING"
          }
        ],
        "isFirstOrder": false,
        "updatedAt": "2024-10-15T14:29:19.220Z",
        "completedAt": "2024-10-15T14:29:26.029Z",
        "transactionHash": "DUMMY_TX_ID",
        "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
        "conversionPriceData": {
          "_id": "a28c76cc-b9e3-4ba4-81fc-0eece6f28559",
          "id": "a28c76cc-b9e3-4ba4-81fc-0eece6f28559",
          "createdAt": "2024-10-15T14:29:19.198Z",
          "fiatCurrency": "GBP",
          "cryptoCurrency": "ETH",
          "paymentMethod": "gbp_bank_transfer",
          "fiatAmount": 45,
          "network": "ethereum",
          "cryptoAmount": 0.01788752,
          "isBuyOrSell": "BUY",
          "conversionPrice": 0.0004122498711328036,
          "marketConversionPrice": 0.00041436312306041164,
          "slippage": 0.51,
          "cryptoLiquidityProvider": "transak",
          "fiatLiquidityProvider": "coinbase",
          "partnerApiKey": "d79671a4-b021-4a4f-a444-6862a680a94b",
          "sourceTokenAmount": 0.017887521908452348,
          "sourceToken": "ETH",
          "notes": [],
          "fiatFeeAmount": 1.61,
          "feeDecimal": 0.03577777777777778,
          "swaps": [
            {
              "sourceCurrency": "GBP",
              "destinationCurrency": "USDT",
              "sourceAmount": 45,
              "destinationAmount": 49.10881925158181,
              "paymentMethod": "gbp_bank_transfer",
              "liquidityProvider": "coinbase",
              "conversionPrice": 1.0913070944795957,
              "feeInSourceAmount": 0,
              "networkFeeInSourceAmount": 0,
              "marketConversionPrice": 1.0913070944795957,
              "isNonCustodial": false,
              "isFiatliquidityProvider": true,
              "isFiatPartnerDirectCryptoDeposit": false,
              "isFiatPartnerAccountWalletDeposit": false,
              "liquidityProviderData": false,
              "originalDestinationAmount": 49.10881925158181
            },
            {
              "sourceCurrency": "USDT",
              "destinationCurrency": "ETH",
              "sourceAmount": 0,
              "destinationAmount": 0.01855124420097616,
              "liquidityProvider": "transak",
              "conversionPrice": 0.00037775789529654837,
              "networkFeeInSourceAmount": 0,
              "marketConversionPrice": 0.00037775789529654837,
              "isNonCustodial": false,
              "liquidityProviderData": false,
              "networkFeeInDestinationAmount": 0
            },
            {
              "sourceCurrency": "ETH",
              "destinationCurrency": "ETH",
              "sourceAmount": 0,
              "destinationAmount": 0.01855124420097616,
              "liquidityProvider": "transak",
              "conversionPrice": 1,
              "networkFeeInSourceAmount": 0,
              "marketConversionPrice": 1,
              "isFiatPartnerAccountWalletDeposit": false,
              "liquidityProviderData": false,
              "isCryptoliquidityProvider": true,
              "networkFeeInDestinationAmount": 0.000067634257104
            }
          ],
          "fees": [
            {
              "name": "Transak fee",
              "value": 1,
              "id": "transak_fee",
              "ids": [
                "transak_fee"
              ]
            },
            {
              "name": "Staging fee",
              "value": 0,
              "id": "partner_fee",
              "ids": [
                "partner_fee"
              ]
            },
            {
              "name": "Network/Exchange fee",
              "value": 0,
              "id": "network_fee",
              "ids": [
                "network_fee"
              ]
            }
          ],
          "fiatAmountInUsd": 49.1,
          "internalFees": [
            {
              "name": "Network/Exchange fee",
              "id": "network_fee",
              "value": 0.16
            },
            {
              "name": "Transak fee",
              "id": "transak_fee",
              "value": 1
            },
            {
              "name": "Staging fee",
              "id": "partner_fee",
              "value": 0.45
            }
          ],
          "cost": {
            "ethPriceInLocalCurrency": 2413.3421734400004,
            "gasCostinLocalCurrency": 0.16410726779392,
            "transakMinimumFee": 1,
            "transakFeeAmount": 1,
            "fiatLiquidityProviderFee": 0,
            "gasCostinLocalCurrencyByFiatPartner": 0,
            "gasCostinLocalCurrencyByCryptoPartner": 0,
            "partnerFeeDecimal": 0.01,
            "partnerFeeInLocalCurrency": 0.45,
            "totalFeeDecimal": 0.03577777777777778,
            "totalFeeAmount": 1.61,
            "gasCurrency": "ETH",
            "gasInNativeToken": 0.000068,
            "gasCurrencyRateInUsd": 0.0003798006806028196,
            "totalAmountChargedByTransak": 1.6141072677939199
          }
        },
        "partnerFeeInLocalCurrency": 0.45
      }
    }
  ]
}

Retrieves a list of webhook events based on an eventID filter. You can apply filters to narrow down the response.

Supported eventID values:

ORDER_CREATED
ORDER_PROCESSING
ORDER_PAYMENT_VERIFYING
ORDER_COMPLETED
ORDER_FAILED
ORDER_CANCELLED

To fetch relevant data, provide orderID along with the eventID filter.

Query parameters

eventIDstringOptional

Filter by event id (ORDER_COMPLETED, ORDER_CANCELLED, ORDER_CREATED, ORDER_FAILED, ORDER_PROCESSING,ORDER_PAYMENT_VERIFYING))

orderIDstringOptional

Filter by order id

limitintegerOptionalDefaults to 100

limits the number of records returned.

skipintegerOptionalDefaults to 0

skip omits the specified number of returned records

startDatestringOptional

startDate in YYYY-MM-DD format. Filters by createdAt from this date.

endDatestringOptional

endDate in YYYY-MM-DD format. Filters by createdAt up to this date.

statusstringOptional

Filter by delivery outcome. Supported values are success and failed.

Response

200

metaobjectOptional

Only includes the filters that were actually applied.

datalist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

Headers

Query parameters

Response

Errors