vrtx Docs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
  • Coming Soon!
  1. Webhooks
  • Welcome ๐Ÿ‘‹
  • Get Started
  • Authentication
  • Responses
  • Pagination
  • Auth
    • Token
      POST
  • Businesses
    • List businesses
      GET
    • Create business
      POST
  • Money Movement
    • Create fund
      POST
    • Create payout
      POST
    • Get payout
      GET
    • Create refund
      POST
    • Create transfer
      POST
    • Create withdrawal
      POST
  • Labels
    • List labels
      GET
    • Create label
      POST
  • Transactions
    • List transactions
      GET
    • Get transaction
      GET
    • List wallet transactions
      GET
  • Wallets
    • List wallets
      GET
    • Create wallet
      POST
    • Lookup wallet
      GET
    • Update wallet
      PATCH
    • Get wallet
      GET
    • Get wallet balance
      GET
    • Remove label
      DELETE
    • Assign label
      PUT
  • Wallet Statements
    • Retrieve wallet statement (preview)
  • Webhooks
    • Register webhook endpoint (preview)
      POST
    • List webhook endpoints (preview)
      GET
  1. Webhooks

Register webhook endpoint (preview)

POST
https://api.staging.vrtx.sa/cl/v1/webhooks/endpoints
Last modified:2025-12-03 07:59:44
x-release-stage:preview
x-disabled:true
This operation is visible for integration planning but is not yet enabled.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Example
{
    "url": "https://webhook.site/abcd",
    "secret": "super-secret-token",
    "events": [
        "string"
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.staging.vrtx.sa/cl/v1/webhooks/endpoints' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://webhook.site/abcd",
    "secret": "super-secret-token",
    "events": [
        "string"
    ]
}'

Responses

๐ŸŸข200OK
application/json
OK
Headers

Body

Example
{}
๐ŸŸ 400Bad Request
Modified atย 2025-12-03 07:59:44
Previous
Retrieve wallet statement (preview)
Next
List webhook endpoints (preview)
Built with