--- title: "Get payment details" method: GET path: "/v2/payments/{paymentUuid}" tags: ["Open Banking"] --- # Get payment details `GET /v2/payments/{paymentUuid}` 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. ## Path parameters - `paymentUuid` string, required — The unique id for the transaction. ## Response `200` The Payment Request details object - PaymentRequestPayment - `type` 'OTHER' — The type of Fire Open Payment that was created - `paymentRequestCode` string — The code that was returned when you created the payment request. - `transactionType` 'REFUND_REQUEST' | 'PAYMENT' — The type of payment request payment - `endToEndId` string — The unique Open Banking payment ID assigned to this payment. - `paymentUuid` string — A unique id for the transaction. - `relatedPaymentUuid` string — The original payment that this payment is linked to - `status` 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'AWAITING_MULTI_AUTHORISATION' | 'NOT_AUTHORISED' | 'SETTLED' | 'REJECTED' | 'ACCEPTED' | 'RECEIVED' | 'FUNDS_CONFIRMED' — The status of the transaction - `reason` string — The reason for the refund. - `amountBeforeCharges` integer — The requested amount (before Fire fees and taxes). Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). - `feeAmount` integer — The fee for the payment - `amountAfterCharges` integer — The amount after Fire fees and taxes. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100). - `currency` Currency — The currency. - `code` string — The three letter code for the currency. - `description` string — The name of the currency - `myRef` string — An internal description of the request. - `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. - `returnUrl` string — The merchant return URL where the customer will be re-directed to with the result of the transaction. - `webhookUrl` string — A URL to be called in the background with the details of the payment after the payment is complete - `relatedAccountTxnId` integer — The ID of the related transaction in your fire account. - `relatedPayeeId` integer — The ID of the payee making the payment. - `dateFundsReceived` string, date-time — The date the funds were received into your fire account. - `dateCreated` string, date-time — This is the date the payment was initiated. - `lastUpdated` string, date-time — The date payment was last updated. - `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 - `to` To - `type` 'FIRE_ACCOUNT' | 'WITHDRAWAL_ACCOUNT' — the type of destination account. - `account` RelatedPartyFireAccount - `type` 'FIRE_ACCOUNT' - `account` object - `id` integer — identifier for the fire.com account (assigned by fire.com) - `alias` string — the name the user gives to the account to help them identify it. - `bic` string — the BIC of the account (provided if currency is EUR). - `iban` string — the IBAN of the account (provided if currency is EUR). - `nsc` string — the Sort Code of the account. - `accountNumber` string — the Account Number of the account. - `bank` Aspsp - `aspspUuid` string — The UUID associated with the ASPSP / bank. - `alias` string — The name of the ASPSP / bank. - `logoUrl` string — A link to the ASPSP / bank's logo in SVG format. - `country` object - `code` string — The 2-letter code for the country - e.g. `IE`, `GP`... - `description` string — The name of the country - `currency` object — The currency. - `code` string — The three letter code for the currency. - `description` string — The name of the currency - `dateCreated` string, date-time — The date the ASPSP / bank was created. - `lastUpdated` string, date-time — The date the ASPSP / bank was last updated. - `domesticPaymentId` string — The ID assigned by the ASPSP to this payment. - `allowFopReceipt` boolean — whether or not a receipt option was offered to the payer. ## 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)