PIpismo
Faster payments

Get FPS transaction [beta]

Gets a FPS transaction given its end-to-end identifier in the path.

The Faster Payments System (FPS) is a UK service that allows near-instant electronic money transfers between banks.

get/v1/payments/fps/{endToEndId}

Request

  • Base URL
    https://sandbox.pismolabs.io/fps
  • URL
    https://sandbox.pismolabs.io/fps/v1/payments/fps/{endToEndId}
  • Auth
    none declared. Required headers: Authorization, x-tenant

Path parameters

endToEndIdstring required

FPS transaction's end to end ID.

Headers

Authorizationstring required

Account token—token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

x-tenantstring required

Organization ID

x-cidstring

Request tracking identifier. If not provided, a random UUID will be generated.

Response

Response Body

end_to_end_idstring

Client-generated transaction identifier. Must be unique for each transaction.

status'CREATED' | 'PROCESSING' | 'SETTLED' | 'CANCELLED' | 'HOLD'
  • CREATED - Payment has been created and is pending processing
  • PROCESSING - P2P balance was impacted and waiting for provider confirmation
  • SETTLED - Transaction completed processing and is settled
  • CANCELLED - Something went wrong and the transaction is cancelled. Refer to reason for more details
  • HOLD - The payment is on hold, pending further review
amountnumber

Transaction amount

Example response

{
  "end_to_end_id": "1374f841568e4ff4b3a63b023c170ec",
  "status": "PROCESSING",
  "amount": 853.09
}

Changes

No recorded changes to this operation across all 1 revision of this API.