Payop REST-like API Reference

Payop API is organized around REST.

Payop API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON responses and uses standard HTTPS response codes.

Each request to Payop API should have a Content-Type HTTPS header with application/json value.

Contents

0. Integration

• Integration via API

  • API Integration Types
  • Pre-setup integration plugins
    • Woocommerce

• Response examples

• Signature generation

1. Invoice

An invoice is the core element of any payment. Every payment is made against an invoice, and checkout transactions can only be initiated for existing invoices.

• Invoice

2. Checkout

Handling Payments Through the Checkout Flow

• Checkout

3. Withdrawal

Steps to prepare and request a withdrawal.

• Encrypt withdrawal data
• Send withdrawal

4. Refund

How to process and handle refunds.

• Refund

5. IPN (Instant Payment Notification)

Learn to receive and handle Instant Payment Notifications.

• IPN