🇬🇧
Yativo Documentation
Spanish
English
English
  • Yativo
  • Introduction to Yativo
    • Financial Infrastructure
    • About Us
  • Dashboard
  • Business Plans
  • Getting Started with Yativo API
  • Yativo API Glossary
  • API reference
    • Misc.
      • Countries
      • States
      • City
  • Security and Authentication
    • Security
    • Authentication
    • Idempotency in API Requests
  • Environment
    • Environments
  • Notifications
    • Webhook
  • Compliance
    • Verification
      • KYC
      • KYB
      • KYC/KYB Update
      • KYC Status
      • Global Business Search
    • Supported Jurisdiction
    • Supported Countries, Currencies and Payment Method
  • User Management
    • Customer
      • Get Customers
      • Retrieve customer
      • Add Customer
  • Payments
    • Currencies
    • Crypto Wallets
      • Generate Wallet Address
      • Fetch Wallet Address
      • Crypto Deposit History
      • Single crypto deposit history
    • Payout
      • Payout
      • Get Payouts
      • Get Payout
      • Beneficiaries
        • Get Beneficiaries
        • Add Beneficiary Payment Details
        • Update Beneficiary
        • Archive Beneficiary
        • Add Beneficiary
    • Payin
    • Virtual Cards
      • Supported Currency, Country
      • Create card
      • Fetch card
      • Top up card
      • Get Transactions
      • Freeze and Unfreeze Card
    • Virtual Accounts
      • Create VIrtual Accounts
        • USD Virtual Account
        • Mexico Virtual Account
        • Brazil PIX QR
      • Virtual Account Management
      • Transaction History
  • Foreign Exchange
    • Exchange Rate
      • Request Quote
  • Transactions
    • Transaction Summary
    • Get Single Transaction
  • Crypto System
    • Yativo Crypto Platform API
Powered by GitBook
On this page
  1. Notifications

Webhook

PreviousEnvironmentsNextVerification

Last updated 2 months ago

Set Webhook Endpoint

This API allows you to set a webhook URL where status notifications from Yativo will be sent.

  • Endpoint: {{baseUrl}}/api/v1/business/webhook

  • Method: POST

  • Content-Type: application/json

{
  "url": "Your_Webhook_Address"
}

Get Webhook Endpoint

This API allows you to Get the webhook URL you set.

  • Endpoint: {{baseUrl}}/api/v1/business/webhook

  • Method: GET

  • Content-Type: application/json

Update Webhook Endpoint

This API allows you to Get the webhook URL you set.

  • Endpoint: {{baseUrl}}/api/v1/business/webhook

  • Method: PUT

  • Content-Type: application/json

Add/Update Webhook

post
Authorizations
Body
all ofOptional
and
anyOptionalExample: {"url":"https://webhook-test.com/c3bafd7ef3d5c13ee525832fe47d0ad4x"}
Responses
200
OK
application/json
Responseall of
and
anyOptionalExample: {"status":"success","status_code":200,"message":"Request successful","data":{"id":"d50e8c5b-6fda-4b53-aa4a-d719421493d6","url":"https://webhook.yativo.com/deposit/process","secret":null,"events":"general","created_at":"2024-07-31T18:46:14.000000Z","updated_at":"2024-07-31T18:46:14.000000Z"}}
post
POST /api/v1/business/webhook HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "url": "https://webhook-test.com/c3bafd7ef3d5c13ee525832fe47d0ad4x"
}
200

OK

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "id": "d50e8c5b-6fda-4b53-aa4a-d719421493d6",
    "url": "https://webhook.yativo.com/deposit/process",
    "secret": null,
    "events": "general",
    "created_at": "2024-07-31T18:46:14.000000Z",
    "updated_at": "2024-07-31T18:46:14.000000Z"
  }
}