Webhook

This module contains endpoints with webhooks.

---

User bas balance is created webhook

Method: POST
Endpoint: /webhook/user/status

Body

Name	Type	Required	Description
externalUserId	string	Yes	External user id (from your system)
status	string	Yes	User bas account create status.

Example body

{
  "externalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "status": "ACTIVE"
}

---

KYC file added webhook

Method: POST
Endpoint: /webhook/kyc-files/status

Body

Name	Type	Required	Description
externalUserId	string	Yes	External user id (from your system)
status	string	Yes	KYC file added status. Enum: [ ADDED, ERROR ]

Example body

{
  "externalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "status": "ADDED"
}

---

Transfer webhook

Method: POST
Endpoint: /transfer-webhook

Body

Name	Type	Required	Description
id	string	Yes	Transfer id
sourceExternalUserId	string	No	External user id (from your system)
destinationExternalUserId	string	No	External user id (from your system)
amount	number	Yes	Transfer amount
currency	string	Yes	Transfer currency
status	string	Yes	Transfer status
createdAt	date	Yes	Transfer created date
error	json	No	Description and status error

Example body

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "sourceExternalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "destinationExternalUserId": null,
  "amount": 10,
  "currency": "eur",
  "status": "SUCCESSFUL",
  "createdAt": "2025-01-20T11:04:29.719Z",
  "error": {
    "description": "Error",
    "status": "Error"
  }
}

---

Crypto withdrawal webhook

Method: POST
Endpoint: /crypto-withdrawal-webhook

Body

Name	Type	Required	Description
id	string	Yes	Crypto withdrawal id
amount	number	Yes	Crypto withdrawal amount
fee	number	Yes	Crypto withdrawal fee
destination	string	Yes	Destination wallet address
status	string	Yes	Crypto withdrawal status
transactionHash	string	Yes	Transaction hash
currency	json	Yes	Currency and network
createdAt	date	Yes	Crypto withdrawal created date
user	json	No	User details

Example body

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "amount": 0.1,
  "fee": 0.002,
  "destination": "34BswSPLbveHiULzdAahf6qr8V1VdkdHFa",
  "status": "SUCCESSFUL",
  "transactionHash": "b768f1fb7d9e69c9e6c3f1ccb8481ff4b0f1940a1c9e7c87d374d1814fd6383b",
  "currency": {
    "network": "",
    "name": "LTC"
  },
  "createdAt": "2024-11-05T10:54:02.982Z",
  "user": {
    "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
    "email": "Giovani34@yahoo.com",
    "firstName": "Will",
    "lastName": "Hahn",
    "address": "0294 Greenholt Burgs",
    "city": "Wilfredchester",
    "country": "BM",
    "documentType": "id",
    "documentNumber": "109314",
    "pesel": null,
    "birthCountry": null,
    "birthDate": null
  }
}

 

Body with error

Name	Type	Required	Description
id	string	Yes	Crypto withdrawal id
error	json	Yes	Description and status error
createdAt	date	Yes	Crypto withdrawal created date
user	json	No	User details

Example body with error

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "error": {
    "description": "Error",
    "status": "Error"
  },
  "createdAt": "2024-11-05T10:54:02.982Z",
  "user": {
    "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
    "email": "Giovani34@yahoo.com",
    "firstName": "Will",
    "lastName": "Hahn",
    "address": "0294 Greenholt Burgs",
    "city": "Wilfredchester",
    "country": "BM",
    "documentType": "id",
    "documentNumber": "109314",
    "pesel": null,
    "birthCountry": null,
    "birthDate": null
  }
}

Crypto Deposit Webhook

Method: POST
Endpoint: /crypto-deposit-webhook

Body

Name	Type	Required	Description
externalUserId	string	No	External user ID from your system
cryptoDepositId	string	Yes	Unique identifier of the deposit
amount	number	Yes	Amount of the deposited crypto
currency	string	Yes	Currency of the deposited crypto
status	string	Yes	Status of the deposit transaction
transactionHash	string	Yes	Blockchain transaction hash
createdAt	string (ISO 8601)	Yes	Deposit creation timestamp (UTC)

---

Status Values

Status	Description
SUCCESSFUL	The deposit has been successfully processed.
UNSUCCESSFUL	The deposit was rejected or failed.
WAITING_FOR_VERIFICATION	The deposit is pending verification.
WAITING_FOR_TR_DATA	The deposit is awaiting additional Travel Rule data.

---

Example Body

{
  "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
  "cryptoDepositId": "facc5951-bdc8-46bc-a01c-9b36f25be6af",
  "amount": 0.001,
  "currency": "eth",
  "status": "WAITING_FOR_TR_DATA",
  "transactionHash": "0x10d5bd4367fd6623a16f56889abb3bb2352b8ea7df7b21537f1fc56fc2d07a87",
  "createdAt": "2025-03-20T11:34:37.646Z"
}

 

---

Exchange webhook

Method: POST
Endpoint: /exchange-webhook

Body

Name	Type	Required	Description
id	string	Yes	Exchange id
sourceAmount	number	Yes	Exchange source amount
destinationAmount	number	Yes	Exchange destination amount
exchangeRate	string	Yes	Exchange rate
status	string	Yes	Exchange status
fee	string	Yes	Exchange fee
sourceCurrency	json	Yes	Exchange source currency
destinationCurrency	string	Yes	Exchange destination currency
exchangeLockId	date	Yes	Exchange lock id
createdAt	json	Yes	Exchange created date
user	json	No	User details

Example body

{
  "id": "8eb77829-dac3-4857-b0c0-3bf70460659c",
  "sourceAmount": "20.00",
  "destinationAmount": "0.00220961",
  "exchangeRate": "0.0001103256",
  "status": "SUCCESSFUL",
  "fee": 0.11,
  "sourceCurrency": "doge",
  "destinationCurrency": "eth",
  "exchangeLockId": "7729c469-4d41-44ed-baa9-d9434301a651",
  "createdAt": "2025-01-20T10:33:23.465Z",
  "user": {
    "externalUserId": "10001",
    "email": "email@email.com",
    "firstName": "Test",
    "lastName": "Test",
    "address": "Test 1",
    "city": "Rzeszow",
    "country": "PL",
    "documentType": "ID_CARD",
    "documentNumber": "ABC12345",
    "pesel": "12345678901",
    "birthCountry": "PL",
    "birthDate": "2000-01-01T00:00:00.000Z"
  }
}

 

Body with error

Name	Type	Required	Description
id	string	Yes	Exchange id
error	json	Yes	Description and status error
createdAt	date	Yes	Exchange created date
user	json	No	User details

Example body with error

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "error": {
    "description": "Error",
    "status": "Error"
  },
  "createdAt": "2024-11-05T10:54:02.982Z",
  "user": {
    "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
    "email": "Giovani34@yahoo.com",
    "firstName": "Will",
    "lastName": "Hahn",
    "address": "0294 Greenholt Burgs",
    "city": "Wilfredchester",
    "country": "BM",
    "documentType": "id",
    "documentNumber": "109314",
    "pesel": null,
    "birthCountry": null,
    "birthDate": null
  }
}

---

Sepa transfer webhook

Method: POST
Endpoint: /sepa-transfer-webhook

Body

Name	Type	Required	Description
id	string	Yes	Exchange id
type	number	Yes	Exchange amount
amount	number	Yes	Exchange fee
transferTitle	string	Yes	Destination wallet address
destinationIban	string	Yes	Exchange fee
fee	string	Yes	Transaction hash
sourceCurrency	json	Yes	Network:
destinationCurrency	string	Yes	Exchange status
exchangeLockId	date	Yes	Exchange created date
createdAt	json	Yes	Description and status error
user	json	No	User details

Example body

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "type": "external",
  "amount": 100,
  "transferTitle": "Bank transfer",
  "destinationIban": "LT601010012345678901",
  "receiverFirstName": "John",
  "receiverLastName": "Doe",
  "status": "SUCCESSFUL",
  "currency": "eur",
  "fee": 10,
  "createdAt": "2024-01-01T12:34:56Z",
  "user": {
    "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
    "email": "Giovani34@yahoo.com",
    "firstName": "Will",
    "lastName": "Hahn",
    "address": "0294 Greenholt Burgs",
    "city": "Wilfredchester",
    "country": "BM",
    "documentType": "id",
    "documentNumber": "109314",
    "pesel": null,
    "birthCountry": null,
    "birthDate": null
  }
}

 

Body with error

Name	Type	Required	Description
id	string	Yes	Exchange id
error	json	Yes	Description and status error
createdAt	date	Yes	Exchange created date
user	json	No	User details

Example body with error

{
  "id": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "error": {
    "description": "Error",
    "status": "Error"
  },
  "createdAt": "2024-11-05T10:54:02.982Z",
  "user": {
    "externalUserId": "8bdd8c8a-e9b7-475e-9690-8a34e8b78dab",
    "email": "Giovani34@yahoo.com",
    "firstName": "Will",
    "lastName": "Hahn",
    "address": "0294 Greenholt Burgs",
    "city": "Wilfredchester",
    "country": "BM",
    "documentType": "id",
    "documentNumber": "109314",
    "pesel": null,
    "birthCountry": null,
    "birthDate": null
  }
}

---

Card 3DS code

Method: POST
Endpoint: /webhook/card/3ds

Body

Name	Type	Required	Description
externalUserId	string	Yes	External user id (from your system)
code	string	Yes	3DS code

Example body

{
  "externalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "code": "123456"
}

---

Card activation code

Method: POST
Endpoint: /webhook/card/activation

Body

Name	Type	Required	Description
externalUserId	string	Yes	External user id (from your system)
cardId	string	Yes	Card id (from our system)
code	string	Yes	Activation code

Example body

{
  "externalUserId": "bca65c48-df49-4831-a7b2-de7903321581",
  "cardId": "8c394557-ba48-4ab4-9349-84d396b4a7f7",
  "code": "123456"
}