Vzlaonlineservices API V3
    Vzlaonlineservices API V3
    • INTRODUCTION
    • CHANGELOG
    • Requests Validations
    • Hash Validations
    • Other Validations
    • Operator Validation
    • Webhook Integration
    • Webhook Notification Example
    • MOVISTAR
      • /send
        POST
      • /landline
        POST
      • /lookup
        POST
      • /pay (POSTPAID)
        POST
    • DIGITEL
      • /lookup
        POST
      • /send
        POST
      • /pay (POSTPAID)
        POST
    • MOVILNET
      • /send
        POST
    • SIMPLE TV
      • /send
        POST
      • /lookup
        POST
    • /me
      GET
    • /operators
      GET
    • /send
      POST
    • /products
      GET
    • /transaction-status/{hash}
      GET

      /send

      POST
      /send
      This endpoint allows processing synchronous and asynchronous transactions for most of the operators. The endpoint determines the correct flow (sync or async) based on the request payload. Users can specify whether to process a synchronous or asynchronous transaction by using the parameters useWebhook and webhookUrl.

      Supported Operators#

      The following table lists the operators currently supported. Please update this table as new operators are added or existing ones are modified.
      Operator NameSupported
      Movistar PostpaidNo
      Movistar PrepaidYes
      Digitel PrepaidYes
      Digitel PostpaidNo
      Movilnet PrepaidYes
      SimpleTVYes

      Features#

      Automatic Mode Selection: Determines whether the transaction will follow a synchronous or asynchronous flow based on the optional parameters useWebhook and webhookUrl in the request payload. If these parameters are omitted, the transaction defaults to synchronous mode.
      Error Handling: Provides clear error messages if the operator or transaction type is unsupported.
      Scalable Design: Built to accommodate the addition of new operators without affecting existing functionality.

      Usage#

      To process a transaction, send a request to the endpoint with the necessary parameters.

      Request

      Header Params

      Body Params application/json

      Example
      {
          "destination": "+584246105907",
          "operatorId" : 2,
          "amount": "60",
          "hash": "2deb110bs7bfak9dj2u10zkWd9628001",
          "useWebhook": true,
          "webhookUrl": "https://yourdomain.com/webhook"
      }

      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 '/send' \
      --header 'x-api-key: {{apiKey}}' \
      --header 'x-api-secret: {{apiSecret}}' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "destination": "+584246105907",
          "operatorId" : 2,
          "amount": "60",
          "hash": "2deb110bs7bfak9dj2u10zkWd9628001",
          "useWebhook": true,
          "webhookUrl": "https://yourdomain.com/webhook"
      }'

      Responses

      🟢200OK
      application/json
      Body

      Example
      {
          "success": true,
          "message": "OK",
          "data": {
              "destination": "+584126783743",
              "amount": "50",
              "hash": "2deb110b57bfac9d72c14d4ed9622230",
              "transactionId": "6134793d1ba6b345e56e943c83541637",
              "operator": "DIGITEL PREPAID",
              "operatorReference": null,
              "status": "PENDING",
              "useWebhook": true,
              "webhookUrl": "https://mywebhookurl.mydomain/myendpoint"
          }
      }
      Modified at 2025-02-11 15:15:53
      Previous
      /operators
      Next
      /products
      Built with