Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Open Banking

Get payment request details

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.

get/v1/paymentrequests/{paymentRequestCode}

Path parameters

paymentRequestCodestring required

The unique 8-character code identifying the payment request.

Example:1234abcd

Response

The Payment Request details object

codestring

The code of the payment request called

typestring

The type of Payment Request

directionstring

The direction of the payment request

statusstring

The status of the payment request

currencystring

The currency the payment request was sent in

accountNamestring

The account associated with the payment request

amountinteger

The amount of funds associated with the payment request

descriptionstring

The description added to the payment request

myRefstring

The reference added to the payment request

dateCreatedstring date-time

The date that the payment request was created

icanTointeger

The ican associated with the payment request

countTimesViewedPaymentDetailsPageinteger

The count of the times the Payment Details page was viewed

countTimesViewedSelectBankPageinteger

The count of the times the Select Bank page was viewed

countTimesViewedConsentPageinteger

The count of the times the Consent page was viewed

countTimesViewedResponsePageinteger

The count of the times the Response page was viewed

countTimesConsentedinteger

The count of the times the payment request was consented to

countTimesAuthorisedinteger

The count of the times the payment request was authorised

totalAmountAuthorisedinteger

The amount the payment request was authorised for

countTimesPaidinteger

The count of the times the payment request was paid

totalAmountPaidinteger

The total amount paid via the payment request

Example response

{
  "code": "1234abcd",
  "type": "OTHER",
  "direction": "SENT",
  "status": "ACTIVE",
  "currency": "GBP",
  "accountName": "Sterling Account",
  "amount": 1000,
  "description": "test",
  "myRef": "test",
  "dateCreated": "2019-08-22T07:48:56.460Z",
  "icanTo": 1234,
  "orderDetails": {
    "merchantNumber": "1234567",
    "orderId": "6c28a47d-4502-4111",
    "productId": "ZFDAA-1221",
    "customerNumber": "123645",
    "variableReference": "John Doe",
    "comment1": "Additional comments about the transaction",
    "comment2": "Additional comments about the transaction",
    "merchantCustomerIdentification": "CustNum-303863544",
    "deliveryAddressLine1": "12 The Street",
    "deliveryAddressLine2": "The Way",
    "deliveryCity": "London",
    "deliveryPostCode": "EC15155",
    "deliveryCountry": "GB"
  }
}