---
title: "Get a report from a payment request"
method: GET
path: "/v2/paymentrequests/{paymentRequestCode}/reports"
tags: ["Open Banking"]
---

# Get a report from a payment request

`GET /v2/paymentrequests/{paymentRequestCode}/reports`

## Request

- Base URL: `https://api.fire.com/business`
- URL: `https://api.fire.com/business/v2/paymentrequests/{paymentRequestCode}/reports`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/firefinancialservices/apis/fire-financial-services-business-api/docs/v2/paymentrequests/:paymentRequestCode/reports/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint will retrieve a report for an Open Banking Payment request. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_REPORTS to use this endpoint.

## Path parameters

- `paymentRequestCode` string, required: The unique 8-character code identifying the payment request.

## Response `200`

The Payment Request Report

- PaymentRequestReport
  - `currency` string: Currency payment request was sent in
  - `amount` integer: Amount in payment request
  - `numberOfTimes` integer: Payments made for this amount and currency

## Other responses

- `400`: An error has occurred. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `401`: An error has occurred. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.
- `403`: An error has occurred. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.

---

[API](https://skmtc.dev/firefinancialservices/apis/fire-financial-services-business-api.md) - [All operations](https://skmtc.dev/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/firefinancialservices/apis/fire-financial-services-business-api/revisions/9326fd0a20ea?raw)