v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Open Banking

Get payment details

This endpoint will return the details of a specific open banking payment. You will need to enable PERM_BUSINESS_GET_PAYMENT to use this endpoint.

As your customer goes through the payment submission journey, the payment status will change. The endpoint will return one of the following statuses:

AWAITING_AUTHORISATION - This is the initial status of all payments, indicating that the user has consented to be directed to their ASPSP/Bank's application. Payments remaining at this status may be considered abandoned.
AWAITING_MULTI_AUTHORISATION - Some business accounts require dual authorisation for payments.
NOT_AUTHORISED - This is a final status, and indicates that the payment initiation was cancelled by the customer, rejected by the ASPSP/Bank, an error response returned by the ASPSP/Bank, eg. low balance in the customers account.
PENDING - The customer has authorised the payment in their app, but their ASPSP/bank may want to carry out an internal check before funding the transaction.
AUTHORISED - The payment is successfully initiated, having been authorised by your customer and their ASPSP/Bank.

Once the payment is successfully initiated, ie. AUTHORISED, the ASPSP/Bank should settle the funds, which are then applied to your Fire account.

FUNDS_CONFIRMED - This status is currently available for GBP payments only. The payment has been received by Fire and will be applied to your account in the next file run.
SETTLED - This is a final status, indicating that funds have been applied to your Fire GBP or EUR account.

get/v2/payments/{paymentUuid}

Path parameters

paymentUuidstring required

The unique id for the transaction.

Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C

Response

The Payment Request details object

type'OTHER'

The type of Fire Open Payment that was created

paymentRequestCodestring

The code that was returned when you created the payment request.

transactionType'REFUND_REQUEST' | 'PAYMENT'

The type of payment request payment

endToEndIdstring

The unique Open Banking payment ID assigned to this payment.

paymentUuidstring

A unique id for the transaction.

relatedPaymentUuidstring

The original payment that this payment is linked to

The status of the transaction

reasonstring

The reason for the refund.

amountBeforeChargesinteger

The requested amount (before Fire fees and taxes). Note the last two digits represent pennies/cents, (e.g., £1.00 = 100).

feeAmountinteger

The fee for the payment

amountAfterChargesinteger

The amount after Fire fees and taxes. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100).

myRefstring

An internal description of the request.

descriptionstring

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.

returnUrlstring

The merchant return URL where the customer will be re-directed to with the result of the transaction.

webhookUrlstring

A URL to be called in the background with the details of the payment after the payment is complete

relatedAccountTxnIdinteger

The ID of the related transaction in your fire account.

relatedPayeeIdinteger

The ID of the payee making the payment.

dateFundsReceivedstring date-time

The date the funds were received into your fire account.

dateCreatedstring date-time

This is the date the payment was initiated.

lastUpdatedstring date-time

The date payment was last updated.

domesticPaymentIdstring

The ID assigned by the ASPSP to this payment.

allowFopReceiptboolean

whether or not a receipt option was offered to the payer.

Example response

{
  "paymentRequestCode": "1234abcd",
  "endToEndId": "FIRE1234567890",
  "paymentUuid": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
  "relatedPaymentUuid": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
  "reason": "Gym Closed for repairs.",
  "amountBeforeCharges": 1000,
  "feeAmount": 1000,
  "amountAfterCharges": 1000,
  "currency": {
    "code": "EUR",
    "description": "Euro"
  },
  "myRef": "Fees",
  "description": "Gym Fees Oct 2020",
  "returnUrl": "https://example.com/callback",
  "webhookUrl": "https://example.com/webhook",
  "relatedAccountTxnId": 41234,
  "relatedPayeeId": 41234,
  "dateFundsReceived": "2020-10-22T07:48:56.460Z",
  "dateCreated": "2020-10-22T07:48:56.460Z",
  "lastUpdated": "2019-08-22T07:48:56.460Z",
  "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"
  },
  "to": {
    "type": "FIRE_ACCOUNT",
    "account": {
      "account": {
        "id": 42,
        "alias": "Main Account",
        "bic": "CPAYIE2D",
        "iban": "IE54CPAY99119911111111",
        "nsc": "232221",
        "accountNumber": "11111111"
      }
    }
  },
  "bank": {
    "aspspUuid": "4ADFB67A-0F5B-4A9A-9D74-34437250045C",
    "alias": "Demo Bank",
    "logoUrl": "https://assets.fire.com/pisp/demo.svg",
    "country": {
      "code": "GB",
      "description": "United Kingdom"
    },
    "currency": {
      "code": "EUR",
      "description": "Euro"
    },
    "dateCreated": "2019-08-22T07:48:56.460Z",
    "lastUpdated": "2019-08-22T07:48:56.460Z"
  },
  "domesticPaymentId": "sdp-1-66ebd30c-c0e1-4a54-9865-f2a7bfedabcf",
  "allowFopReceipt": true
}