Payments API Overview

​

Key Features

• Multiple Payment Methods: Accept cash, card, Yape, Plin, bank transfers, and other payment types
• Partial Payments: Support split payments where customers can pay an order in multiple transactions
• Daily Summaries: Get aggregated payment data by method and time period
• Payment Tracking: Link payments to orders with detailed reference information
• Tip Management: Track gratuities separately from order totals

​

Authentication

• payments:read - View payment records and summaries
• payments:create - Process new payments

​

Base URL

https://api.restai.app/v1/payments

​

Common Response Format

{
  "success": true,
  "data": {
    // Response data
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Orden no encontrada"
  }
}

​

Payment Methods

• cash - Cash payment
• card - Credit/debit card
• yape - Yape mobile payment
• plin - Plin mobile payment
• transfer - Bank transfer
• other - Other payment methods

​

Payment Status

• completed - Payment successfully processed

​

Next Steps

• Process Payment - Learn how to create payments and handle partial payments