v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Faster payments

Release FPS inbound transaction [beta]

This endpoint moves the suspended transaction amount from additional funds to available balance and marks the transaction as settled.

This endpoint generates a FPS inbound payment processed event with status SETTLED.

post/v1/payments/fps/release/{endToEndId}

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 identifier.

x-cidstring

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

Response

Response Body

end_to_end_idstring

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

status'SETTLED'
  • SETTLED - Transaction was completed processed and settled
amountnumber double

Fee amount.

Example response

{
  "end_to_end_id": "1374f841568e4ff4b3a63b023c170ec",
  "status": "SETTLED",
  "amount": 215
}