Get Payment Request

/api/payhub/v1/payment/request/{paymentRequestId}

Retrieves the full details of a payment request created by the authenticated merchant, including identifiers, amounts, lifecycle timestamps, debtor info and a summary of related payment attempts. Only the merchant who created the payment request can retrieve it.

Request parameters

Responses

{
  "paymentRequestId": 123,
  "paycode": "ABC123XYZ",
  "paylink": "https://pay.example.com/ABC123XYZ",
  "qr": "https://pay.example.com/qr/ABC123XYZ.png",
  "providerReferenceId": "klarna-session-9f7c",
  "amount": 100.0,
  "taxAmount": 24.0,
  "totalAmount": 124.0,
  "currency": "EUR",
  "paymentType": "fixed",
  "provider": "klarna",
  "country": "GR",
  "paymentDescription": "Order #4567",
  "status": "pending",
  "active": true,
  "createdDate": "2026-08-10T12:30:00Z",
  "updatedDate": "2026-08-10T12:35:00+00:00",
  "canceledDate": null,
  "canceledBy": null,
  "debtor": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+306912345678",
    "companyName": null,
    "vrn": null
  },
  "payments": [
    {
      "paymentId": 987,
      "bankOrderId": "BNK-2026-000987",
      "syncedStatus": "settled",
      "amount": 124.0,
      "createdDate": "2026-08-10T12:34:00Z",
      "paymentDate": "2026-08-10T12:34:12Z"
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "instance": "/api/payhub/v1/payment/request/0",
  "traceId": null,
  "detail": "Invalid payment request ID",
  "errors": [
    {
      "name": "PaymentRequestId",
      "reason": "Payment request ID must be a positive integer",
      "code": null,
      "severity": null
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "/api/payhub/v1/payment/request/123",
  "traceId": null,
  "detail": "API key is missing or invalid",
  "errors": [
    {
      "name": "Authorization",
      "reason": "x-api-key header is required",
      "code": null,
      "severity": null
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.3",
  "title": "Forbidden",
  "status": 403,
  "instance": "/api/payhub/v1/payment/request/123",
  "traceId": null,
  "detail": "You are not authorized to access this payment request",
  "errors": [
    {
      "name": "Authorization",
      "reason": "Payment request belongs to a different merchant",
      "code": null,
      "severity": null
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "instance": "/api/payhub/v1/payment/request/123",
  "traceId": null,
  "detail": "Payment request not found",
  "errors": [
    {
      "name": "PaymentRequest",
      "reason": "No payment request found with the given ID",
      "code": null,
      "severity": null
    }
  ]
}

{
  "type": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1",
  "title": "One or more errors occurred.",
  "status": 500,
  "instance": "/api/payhub/v1/payment/request/123",
  "traceId": null,
  "detail": "Failed to retrieve payment request",
  "errors": [
    {
      "name": "Server",
      "reason": "Internal server error",
      "code": null,
      "severity": null
    }
  ]
}

Last modified: 11 August 2026