---
title: "Get payment request details"
method: GET
path: "/v1/paymentrequests/{paymentRequestCode}"
tags: ["Open Banking"]
---

# Get payment request details

`GET /v1/paymentrequests/{paymentRequestCode}`

This endpoint will retrieve the details of an Open Banking Payment requestYou will need to enable PERM_BUSINESS_GET_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 details object

- PaymentRequest
  - `code` string — The code of the payment request called
  - `type` string — The type of Payment Request
  - `direction` string — The direction of the payment request
  - `status` string — The status of the payment request
  - `currency` string — The currency the payment request was sent in
  - `accountName` string — The account associated with the payment request
  - `amount` integer — The amount of funds associated with the payment request
  - `description` string — The description added to the payment request
  - `myRef` string — The reference added to the payment request
  - `dateCreated` string, date-time — The date that the payment request was created
  - `icanTo` integer — The ican associated with the payment request
  - `orderDetails` OrderDetails
    - `merchantNumber` string — Your Merchant Number (if applicable).
    - `orderId` string — Use this field to store the order id for the transaction. The Order Id cannot be set unless the `maxNumberPayments` is 1.
    - `productId` string — Use this field to store a product id for the transaction (for example).
    - `customerNumber` string — Use this field to store a customer number for the transaction (for example).
    - `variableReference` string — Use this field to store any other reference for the transaction (for example, a phone number).
    - `comment1` string — This is your own comment for the transaction.
    - `comment2` string — This is your own comment for the transaction.
    - `merchantCustomerIdentification` string — This is a reference you use to uniquely identify each of your customers.
    - `deliveryAddressLine1` string — The first line of the delivery address.
    - `deliveryAddressLine2` string — The second line of the delivery address.
    - `deliveryCity` string — Delivery address city
    - `deliveryPostCode` string — Delivery address post code
    - `deliveryCountry` string — 2-digit code for the country
  - `countTimesViewedPaymentDetailsPage` integer — The count of the times the Payment Details page was viewed
  - `countTimesViewedSelectBankPage` integer — The count of the times the Select Bank page was viewed
  - `countTimesViewedConsentPage` integer — The count of the times the Consent page was viewed
  - `countTimesViewedResponsePage` integer — The count of the times the Response page was viewed
  - `countTimesConsented` integer — The count of the times the payment request was consented to
  - `countTimesAuthorised` integer — The count of the times the payment request was authorised
  - `totalAmountAuthorised` integer — The amount the payment request was authorised for
  - `countTimesPaid` integer — The count of the times the payment request was paid
  - `totalAmountPaid` integer — The total amount paid via the payment request

## 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/revisions/1d19896d095c/schema)