Overview

The Payment Service API allows client applications to create payments, retrieve payment details, and check transaction status.

Base URL

https://api.example.com/v1

Authentication

All requests require a bearer token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

Endpoints

POST /payments

Creates a new payment.

Request body

{
  "amount": 100.00,
  "currency": "EUR",
  "customer_id": "cust_12345",
  "reference": "INV-2026-001"
}

Response

{
  "payment_id": "pay_78910",
  "status": "pending",
  "amount": 100.00,
  "currency": "EUR"
}

GET /payments/{payment_id}

Returns payment details for the specified payment.

Example response

{
  "payment_id": "pay_78910",
  "status": "completed",
  "amount": 100.00,
  "currency": "EUR",
  "created_at": "2026-03-24T10:15:00Z"
}

GET /payments/{payment_id}/status

Returns the latest processing status.

Example response

{
  "payment_id": "pay_78910",
  "status": "completed"
}

Error handling

Status code Meaning Description
400 Bad Request The request body is invalid or missing required fields.
401 Unauthorized The bearer token is missing or invalid.
404 Not Found The payment ID does not exist.
500 Server Error An unexpected server-side error occurred.

Notes