Get Webhooks

GET

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

GET

/partners/api/v2/webhooks

1 curl https://api-stg.transak.com/partners/api/v2/webhooks \
2      -H "access-token: YOUR_ACCESS_TOKEN"

1 {
2   "meta": {
3     "orderID": "322dc79c-fad2-4df1-bf50-b292191fc953",
4     "eventID": "ORDER_COMPLETED"
5   },
6   "data": [
7     {
8       "id": "670e7c469f2a5dd93fbe4406",
9       "partnerApiKey": "d79671a4-b021-4a4f-a444-6862a680a94b",
10       "createdAt": "2024-10-15T14:29:26.929Z",
11       "eventID": "ORDER_COMPLETED",
12       "webhookData": {
13         "id": "322dc79c-fad2-4df1-bf50-b292191fc953",
14         "walletAddress": "0xD902d7E",
15         "createdAt": "2024-10-15T14:29:11.104Z",
16         "status": "COMPLETED",
17         "fiatCurrency": "EUR",
18         "userId": "243a8ce2-9cc6-41a9-aaeb-b0deeb0b19a3",
19         "cryptoCurrency": "ETH",
20         "isBuyOrSell": "BUY",
21         "fiatAmount": 45,
22         "ipAddress": "35.177.158.9",
23         "amountPaid": 45,
24         "paymentOptionId": "sepa_bank_transfer",
25         "walletLink": "https://sepolia.etherscan.io/address/0xD902d7eBFeE",
26         "quoteId": "20148892-f984-4e3f-8bb7-fba6c0ec9182",
27         "orderProcessingType": "NORMAL",
28         "addressAdditionalData": false,
29         "network": "ethereum",
30         "conversionPrice": 0.0004122498271491127,
31         "cryptoAmount": 0.01788752,
32         "totalFeeInFiat": 1.61,
33         "fiatAmountInUsd": 49.1,
34         "countryCode": "IN",
35         "stateCode": "Karnataka",
36         "orderChannelType": "WIDGET",
37         "tokenContractAddress": "0x0000000000000000000000000000000000000000",
38         "userKycType": "STANDARD",
39         "cardPaymentData": {
40           "orderId": "322dc79c-fad2-4df1-bf50-b292191fc953",
41           "paymentId": "670e7c387b5777f9332927b6",
42           "pgData": {
43             "liquidityProvider": "OPENPAYD_MALTA",
44             "status": "CREATED",
45             "beneficiaryName": "Abc Xyz",
46             "paymentOptions": [
47               {
48                 "currency": "EUR",
49                 "id": "sepa_bank_transfer",
50                 "name": "Bank Transfer Details",
51                 "fields": [
52                   {
53                     "name": "Account Type",
54                     "value": "Personal"
55                   },
56                   {
57                     "name": "Amount",
58                     "value": "45 EUR"
59                   },
60                   {
61                     "name": "First Name (Beneficiary)",
62                     "value": "Abc"
63                   },
64                   {
65                     "name": "Last Name (Beneficiary)",
66                     "value": "Xyz"
67                   },
68                   {
69                     "name": "IBAN",
70                     "value": "GB57SEOU19870010260405"
71                   },
72                   {
73                     "name": "Bank Name",
74                     "value": "Simulator Bank"
75                   },
76                   {
77                     "name": "Bank Country",
78                     "value": "Malta"
79                   },
80                   {
81                     "name": "Bank Address",
82                     "value": "The Bower, 207-211 Old Street, London, England, EC1V 9NR"
83                   }
84                 ]
85               }
86             ]
87           },
88           "liquidityProvider": "OPENPAYD_MALTA",
89           "updatedAt": "2024-10-15T14:29:12.243Z"
90         },
91         "statusHistories": [
92           {
93             "status": "PENDING_DELIVERY_FROM_TRANSAK",
94             "createdAt": "2024-10-15T14:29:15.542Z",
95             "message": "💸 Payment reconciled successfully. Received 45 EUR",
96             "isEmailSentToUser": false,
97             "partnerEventId": "ORDER_PROCESSING"
98           }
99         ],
100         "isFirstOrder": false,
101         "updatedAt": "2024-10-15T14:29:19.220Z",
102         "completedAt": "2024-10-15T14:29:26.029Z",
103         "transactionHash": "DUMMY_TX_ID",
104         "transactionLink": "https://sepolia.etherscan.io/tx/DUMMY_TX_ID",
105         "conversionPriceData": {
106           "_id": "a28c76cc-b9e3-4ba4-81fc-0eece6f28559",
107           "id": "a28c76cc-b9e3-4ba4-81fc-0eece6f28559",
108           "createdAt": "2024-10-15T14:29:19.198Z",
109           "fiatCurrency": "EUR",
110           "cryptoCurrency": "ETH",
111           "paymentMethod": "sepa_bank_transfer",
112           "fiatAmount": 45,
113           "network": "ethereum",
114           "cryptoAmount": 0.01788752,
115           "isBuyOrSell": "BUY",
116           "conversionPrice": 0.0004122498711328036,
117           "marketConversionPrice": 0.00041436312306041164,
118           "slippage": 0.51,
119           "cryptoLiquidityProvider": "transak",
120           "fiatLiquidityProvider": "coinbase",
121           "partnerApiKey": "d79671a4-b021-4a4f-a444-6862a680a94b",
122           "sourceTokenAmount": 0.017887521908452348,
123           "sourceToken": "ETH",
124           "notes": [],
125           "fiatFeeAmount": 1.61,
126           "feeDecimal": 0.03577777777777778,
127           "swaps": [
128             {
129               "sourceCurrency": "EUR",
130               "destinationCurrency": "USDT",
131               "sourceAmount": 45,
132               "destinationAmount": 49.10881925158181,
133               "paymentMethod": "sepa_bank_transfer",
134               "liquidityProvider": "coinbase",
135               "conversionPrice": 1.0913070944795957,
136               "feeInSourceAmount": 0,
137               "networkFeeInSourceAmount": 0,
138               "marketConversionPrice": 1.0913070944795957,
139               "isNonCustodial": false,
140               "isFiatliquidityProvider": true,
141               "isFiatPartnerDirectCryptoDeposit": false,
142               "isFiatPartnerAccountWalletDeposit": false,
143               "liquidityProviderData": false,
144               "originalDestinationAmount": 49.10881925158181
145             },
146             {
147               "sourceCurrency": "USDT",
148               "destinationCurrency": "ETH",
149               "sourceAmount": 0,
150               "destinationAmount": 0.01855124420097616,
151               "liquidityProvider": "transak",
152               "conversionPrice": 0.00037775789529654837,
153               "networkFeeInSourceAmount": 0,
154               "marketConversionPrice": 0.00037775789529654837,
155               "isNonCustodial": false,
156               "liquidityProviderData": false,
157               "networkFeeInDestinationAmount": 0
158             },
159             {
160               "sourceCurrency": "ETH",
161               "destinationCurrency": "ETH",
162               "sourceAmount": 0,
163               "destinationAmount": 0.01855124420097616,
164               "liquidityProvider": "transak",
165               "conversionPrice": 1,
166               "networkFeeInSourceAmount": 0,
167               "marketConversionPrice": 1,
168               "isFiatPartnerAccountWalletDeposit": false,
169               "liquidityProviderData": false,
170               "isCryptoliquidityProvider": true,
171               "networkFeeInDestinationAmount": 0.000067634257104
172             }
173           ],
174           "fees": [
175             {
176               "name": "Transak fee",
177               "value": 1,
178               "id": "transak_fee",
179               "ids": [
180                 "transak_fee"
181               ]
182             },
183             {
184               "name": "Staging fee",
185               "value": 0,
186               "id": "partner_fee",
187               "ids": [
188                 "partner_fee"
189               ]
190             },
191             {
192               "name": "Network/Exchange fee",
193               "value": 0,
194               "id": "network_fee",
195               "ids": [
196                 "network_fee"
197               ]
198             }
199           ],
200           "fiatAmountInUsd": 49.1,
201           "internalFees": [
202             {
203               "name": "Network/Exchange fee",
204               "id": "network_fee",
205               "value": 0.16
206             },
207             {
208               "name": "Transak fee",
209               "id": "transak_fee",
210               "value": 1
211             },
212             {
213               "name": "Staging fee",
214               "id": "partner_fee",
215               "value": 0.45
216             }
217           ],
218           "cost": {
219             "ethPriceInLocalCurrency": 2413.3421734400004,
220             "gasCostinLocalCurrency": 0.16410726779392,
221             "transakMinimumFee": 1,
222             "transakFeeAmount": 1,
223             "fiatLiquidityProviderFee": 0,
224             "gasCostinLocalCurrencyByFiatPartner": 0,
225             "gasCostinLocalCurrencyByCryptoPartner": 0,
226             "partnerFeeDecimal": 0.01,
227             "partnerFeeInLocalCurrency": 0.45,
228             "totalFeeDecimal": 0.03577777777777778,
229             "totalFeeAmount": 1.61,
230             "gasCurrency": "ETH",
231             "gasInNativeToken": 0.000068,
232             "gasCurrencyRateInUsd": 0.0003798006806028196,
233             "totalAmountChargedByTransak": 1.6141072677939199
234           }
235         },
236         "partnerFeeInLocalCurrency": 0.45
237       },
238       "webhookResponse": {
239         "body": {
240           "success": false,
241           "error": {
242             "message": "Token \"e6228527-526f-44a8-a8c1-a2f7a8bb2927\" not found"
243           }
244         },
245         "statusCode": 404,
246         "statusMessage": "Not Found",
247         "url": "https://webhook.site/e6228527-526f-44a8-a8c1-a2f7a8bb2927"
248       }
249     }
250   ]
251 }

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.

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` <Callout intent="note"> To fetch relevant data, provide `orderID` along with the `eventID` filter. </Callout>

Query parameters

eventIDstringOptionalDefaults to ORDER_COMPLETED

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

orderIDstringOptionalDefaults to YOUR_ORDER_ID

Filter by order id

Response

200

metaobject

datalist of objects

Errors

401

Unauthorized Error

Headers

Query parameters

Response

Errors