---
title: "List details of a public payment request"
method: GET
path: "/v2/paymentrequests/{paymentRequestCode}/public"
tags: ["Open Banking"]
---

# List details of a public payment request

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

This endpoint returns an object of payment request information. You will need to enable PERM_BUSINESS_GET_PUBLIC_PAYMENT_REQUEST to use this endpoint.

## Path parameters

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

## Response `200`

The Payment Request Information

- PublicPaymentRequest
  - `code` string — This is the payment request code
  - `pisp` string — Payment Initiation Service Provider
  - `status` string — This is the status of the payment request
  - `currency` Currency — The currency.
    - `code` string — The three letter code for the currency.
    - `description` string — The name of the currency
  - `amount` integer — The amount sent in the payment request
  - `description` string — This is the reference description that was added to the payment request
  - `dateCreated` string — This is the date the payment was initiated.
  - `mandatoryFields` string — For the hosted option, these fields will be madatory for the payer to fill in on the hosted payment page. You can choose to collect any the payer's `ADDRESS`, `REFERENCE` and/or `COMMENT1`. If you choose to collect these fields from the payer, you cannot set 'delivery’, 'variableReference’ or 'comment1’ fields respectively.
  - `sender` Sender
    - `type` string — This is the type of account the sender holds
    - `name` string — This is the name of the sender
    - `businessAddress` BusinessAddress
      - `type` string — This is the type of account the sender holds
      - `address1` string — This is the address of the sender
      - `city` string — This is the city the sender lives in
      - `country` Country
        - `code` string — The 2-letter code for the country - e.g. `IE`, `GP`...
        - `description` string — The name of the country

## Other responses

- `400` — An error has occured. 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 occured. 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 occured. 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.net/firefinancialservices/apis/fire-financial-services-business-api.md) · [All operations](https://skmtc.net/firefinancialservices/apis/fire-financial-services-business-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firefinancialservices/fire-financial-services-business-api/versions/1d19896d095c/schema)