Payment Methods API - Venddor API

Payment Methods Endpoints

The Payment Methods API allows you to manage payment processing options in the Venddor platform. This documentation outlines the available endpoints and their supported HTTP methods.

Base URL: https://www.venddor.com.br/api

Available Endpoints

GET POST /payments

This endpoint allows you to retrieve all payment methods or create a new payment method.

Supported Methods

Method	Description	Usage
GET	Retrieve all payment methods	Returns a list of all available payment methods
POST	Create a new payment method	Requires a JSON body with payment method details

Create Example

List Response

{
  "payment_name": "Credit Card - Mastercard",
  "processor": "stripe",
  "processor_params": {
    "api_key": "pk_test_TYooMQauvdEDq54NiTphI7jx",
    "currency": "BRL",
    "payment_method_types": ["card"]
  },
  "instructions": "Enter your credit card details to complete the payment",
  "min_order_amount": 10.00,
  "max_order_amount": 10000.00,
  "position": 10,
  "status": "A",
  "icon": "mastercard.png"
}

{
  "payments": [
    {
      "payment_id": 1,
      "payment_name": "Credit Card - Mastercard",
      "processor": "stripe",
      "min_order_amount": 10.00,
      "max_order_amount": 10000.00,
      "position": 10,
      "status": "A"
    },
    {
      "payment_id": 2,
      "payment_name": "Credit Card - Visa",
      "processor": "stripe",
      "min_order_amount": 10.00,
      "max_order_amount": 10000.00,
      "position": 20,
      "status": "A"
    },
    {
      "payment_id": 3,
      "payment_name": "Boleto Bancário",
      "processor": "pagseguro",
      "min_order_amount": 5.00,
      "max_order_amount": 5000.00,
      "position": 30,
      "status": "A"
    }
  ]
}

GET PUT DELETE /payments/

This endpoint allows you to work with a specific payment method identified by its ID.

Path Parameters

Parameter	Type	Description
id*	integer	The unique identifier of the payment method

Supported Methods

Method	Description	Usage
GET	Retrieve a specific payment method	Returns detailed information about the specified payment method
PUT	Update a payment method	Requires a JSON body with fields to update
DELETE	Delete a payment method	Permanently removes the payment method from the system

Important: Deleting a payment method will prevent customers from selecting it for new orders, but it will not affect existing orders that already use this payment method.

Update Example

Detail Response

{
  "status": "D",
  "processor_params": {
    "api_key": "pk_live_TYooMQauvdEDq54NiTphI7jx"
  },
  "instructions": "Enter your Mastercard credit card details to complete the payment"
}

{
  "payment_id": 1,
  "payment_name": "Credit Card - Mastercard",
  "processor": "stripe",
  "processor_params": {
    "api_key": "pk_live_TYooMQauvdEDq54NiTphI7jx",
    "currency": "BRL",
    "payment_method_types": ["card"]
  },
  "instructions": "Enter your Mastercard credit card details to complete the payment",
  "min_order_amount": 10.00,
  "max_order_amount": 10000.00,
  "position": 10,
  "status": "D",
  "icon": "mastercard.png",
  "last_modified": "2025-04-16T10:25:32Z"
}

Payment Method Status Values

Status	Description
`A`	Active - Payment method is available for customer selection
`H`	Hidden - Payment method exists but is not visible to customers
`D`	Disabled - Payment method is temporarily disabled

Supported Payment Processors

Processor	Description
`stripe`	Stripe payment gateway for credit card processing
`pagseguro`	PagSeguro payment gateway for Brazilian payment methods
`paypal`	PayPal payment gateway for PayPal accounts
`mercadopago`	Mercado Pago payment gateway for Latin American payment methods
`custom`	Custom payment method for offline payments or manual processing

Tip: To optimize checkout performance, limit the number of active payment methods to those that are most commonly used by your customers. Too many payment options can lead to decision paralysis and abandoned carts.