---
title: "Get a list of payment request transactions"
method: GET
path: "/v2/paymentrequests/sent"
tags: ["Open Banking"]
---

# Get a list of payment request transactions

`GET /v2/paymentrequests/sent`

This endpoint will retrieve the list of open banking payment requests made on your account. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_TRANSACTIONS to use this endpoint.

## Response `200`

The list of payment requests sent

- PaymentRequestsSent
  - `total` integer — The total number of payment request payments in the list.
  - `dateRangeTo` integer — Date Range
  - `paymentRequests` PaymentRequestSummary[]
    - `accountName` string — Name on the Account
    - `amount` integer — Amount of the transaction
    - `code` string — The code that was returned when you created the payment request
    - `currency` string — Currency transaction was completed in
    - `dateCreated` string — This is the date the payment was initiated.
    - `description` string — A public facing description of the request. This will be shown to the user when they tap or scan the request. Fire will truncate to 18 characters to ensure it is accepted by all banks. It is safest to use only numbers, letters, spaces and a fullstop (.) Special characters are not accepted by most banks and errors will only occur after the customer has approved the payment.
    - `direction` string — Payment direction
    - `icanTo` integer — The ican of the account to collect the funds into. Must be one of your fire.com Accounts.
    - `maxNumberPayments` integer — The max number of people who can pay this request. Must be set to 1 for the ECOMMERCE_GOODS and ECOMMERCE_SERVICES types.
    - `myRef` string — An internal description of the 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
    - `status` 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'AWAITING_MULTI_AUTHORISATION' | 'NOT_AUTHORISED' | 'SETTLED' | 'REJECTED' | 'ACCEPTED' | 'RECEIVED' | 'FUNDS_CONFIRMED' — The status of the transaction
    - `type` 'OTHER' | 'DIRECT' | 'SHAREABLE' | 'PARTY_TO_PARTY' | 'BILL_PAYMENT' | 'ECOMMERCE_GOODS' | 'ECOMMERCE_SERVICES' — The type of Fire Open Payment that was created

## 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)