This section provides a comprehensive reference for the Payment API, including endpoints, parameters, and usage examples.

Endpoints

  • GET /api/payment/transactions
    • Retrieve a list of transactions.
  • POST /api/payment/transactions
    • Create a new transaction.
  • PUT /api/payment/transactions/{transaction_id}
    • Update an existing transaction.
  • DELETE /api/payment/transactions/{transaction_id}
    • Delete a transaction.

Parameters

Common Parameters

  • amount (required, number) - The amount of the transaction.
  • currency (required, string) - The currency of the transaction.
  • payment_method (required, string) - The payment method used for the transaction.

Transaction-Specific Parameters

  • description (optional, string) - A description of the transaction.
  • customer_id (optional, string) - The ID of the customer associated with the transaction.

Usage Examples

Retrieve Transactions

GET /api/payment/transactions

Create a Transaction

POST /api/payment/transactions
Content-Type: application/json

{
  "amount": 100.00,
  "currency": "USD",
  "payment_method": "credit_card",
  "description": "Purchase of product XYZ",
  "customer_id": "c12345"
}

Related Resources

For more information on our Payment API, please visit our Developer Center.

Payment Processing Flow