Welcome to the Vepuy API! Our API allows you to access multiple endpoints, generate and manage payments using different methods, as well as retrieve information related to payments.

The API is designed around REST principles, featuring predictable URLs and a resource-oriented approach. It utilizes standard HTTP response codes to convey the outcome of API requests. All API responses are in JSON format, even in the case of errors.

When making requests, users should expect a 200 status code for successful operations. Any status code other than 200 indicates either an invalid request or an issue with the response. This typically occurs when the provided data fails validation checks performed by Vepuy.

If you have an account with Vepuy, you can access the REST API through the following endpoints:

The Production endpoint provides direct access for generating real transactions. The Sandbox endpoint allows you to test your integration without affecting real data.

To interact with the API, you need to authenticate using the Bearer authentication scheme. Follow these steps to authenticate with the API:

Remember to replace your_public_token and your_private_token with the access keys provided for your application.

1. Get your access keys: Before you can authenticate, you must obtain your unique access keys provided by Vepuy. This includes a Public Token and a Private Token.

2. Include authentication headers: In every API request you make, you must include the following authentication headers:

• Authorization: This header should contain "Bearer" followed by your Public Token.

  Example: Authorization: Bearer your_public_token

• Date: This header should contain the timestamp in the format "YYYY-MM-DDTHH:MM:SSZ" in UTC. Ensure that the timestamp is not more than 5 minutes different from the current time.

  Example in JavaScript:

  const date = new Date().toISOString();
  

  Example in PHP:

  $date = gmdate("Y-m-d\TH:i:s\Z");
  

  Example in Python:

  from datetime import datetime
  date = datetime.utcnow().isoformat()
  

• Sign: This header should contain a signature generated using HMAC-SHA256 with your Private Token and the timestamp (Date).

  Example in JavaScript:

  const crypto = require('crypto');
  const date = new Date().toISOString();
  const your_private_token = 'your_private_token';
  const message = date;
  const key = Buffer.from(your_private_token, 'utf-8');
  const hmac = crypto.createHmac('sha256', key);
  hmac.update(message);
  const sign = hmac.digest('hex');        
  

  Example in PHP:

  $sign = hash_hmac('sha256', $date, $your_private_token);
  

  Example in Python:

  import hashlib
  import hmac
  import time
  
  your_private_token = 'your_private_token'  # Reemplaza con tu token privado
  date = time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime())
  message = date.encode('utf-8')
  
  # Genera la firma HMAC-SHA256
  signature = hmac.new(your_private_token.encode('utf-8'), message, hashlib.sha256).hexdigest()
  

3. Make the request: After including the authentication headers, you can securely make the request.

Examples in Various Programming Languages

Below are examples of how to implement authentication in different programming languages:

• JavaScript:

  const date = new Date().toISOString();
  const sign = crypto.createHmac('sha256', yourPrivateToken).update(date).digest('hex');
  const headers = {
      'Authorization': `Bearer ${yourPublicToken}`,
      'Date': date,
      'Sign': sign
  };
  

• PHP:

  $date = gmdate("Y-m-d\TH:i:s\Z");
  $sign = hash_hmac('sha256', $date, $your_private_token);
  $headers = [
      'Authorization' => 'Bearer ' . $your_public_token,
      'Date' => $date,
      'Sign' => $sign
  ];
  

• Python:

  import hashlib
  import hmac
  import datetime
  
  date = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')
  private_key = "your_private_token"
  public_key = "your_public_token"
  
  message = date.encode('utf-8')
  secret_key = private_key.encode('utf-8')
  
  signature = hmac.new(secret_key, message, hashlib.sha256).hexdigest()
  
  headers = {
      'Authorization': f'Bearer {public_key}',
      'Date': date,
      'Sign': signature
  }
  

If you have an account with Vepuy, you can access the REST API through the following endpoints:

This example provides clear instructions on how to authenticate with the API and includes examples in different programming languages, including PHP. Be sure to replace your_public_token and your_private_token with the access keys provided for your application.