PIpismo
Faster payments

Cancel FPS inbound transaction [beta]

Call this endpoint to cancel the suspended transaction which was kept on hold based on client's antifraud provider analysis and return the transaction.

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

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

Request

  • Base URL
    https://sandbox.pismolabs.io/fps
  • URL
    https://sandbox.pismolabs.io/fps/v1/payments/fps/cancel/{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'CANCELLED'
  • CANCELLED - Something went wrong and the transaction was cancelled. Refer to reason for details,

Example response

{
  "end_to_end_id": "1374f841568e4ff4b3a63b023c170ec",
  "status": "CANCELLED"
}

Changes

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