Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Open Banking

List details of a public payment request

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

get/v2/paymentrequests/{paymentRequestCode}/public

Path parameters

paymentRequestCodestring required

The unique 8-character code identifying the payment request.

Example:1234abcd

Response

The Payment Request Information

codestring

This is the payment request code

pispstring

Payment Initiation Service Provider

statusstring

This is the status of the payment request

amountinteger

The amount sent in the payment request

descriptionstring

This is the reference description that was added to the payment request

dateCreatedstring

This is the date the payment was initiated.

mandatoryFieldsstring

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.

Example response

{
  "code": "abcdefgh",
  "pisp": "FIRE",
  "status": "ACTIVE",
  "currency": {
    "code": "EUR",
    "description": "Euro"
  },
  "description": "test",
  "dateCreated": "2024-09-12T14:55:03.857Z",
  "mandatoryFields": "REFERNCE",
  "sender": {
    "type": "BUSINESS",
    "name": "johndoe",
    "businessAddress": {
      "type": "BUSINESS",
      "address1": "1, 1 street, Dublin",
      "city": "Dublin 1",
      "country": {
        "code": "GB",
        "description": "United Kingdom"
      }
    }
  }
}