Open Banking

Get a report from a payment request

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.

get/v2/paymentrequests/{paymentRequestCode}/reports

Request

Base URL
https://api.fire.com/business
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.

Path parameters

paymentRequestCodestring required

The unique 8-character code identifying the payment request.

Example:1234abcd

Response

The Payment Request Report

currencystring

Currency payment request was sent in

amountinteger

Amount in payment request

numberOfTimesinteger

Payments made for this amount and currency

Example response

{
  "currency": "EUR"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.