Open Banking

Update the status of a payment request

This endpoint will update the status of a payment request. The payment request should be active or removed. You will need to enable PERM_BUSINESS_PUT_PAYMENT_REQUEST_STATUS to use this endpoint.

put/v2/paymentrequests/{paymentRequestCode}/status

Request

Base URL
https://api.fire.com/business
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firefinancialservices/apis/fire-financial-services-business-api/docs/v2/paymentrequests/:paymentRequestCode/status/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

paymentRequestCodestring required

The code of the payment request to update

Example:xyzabcde

Request body

statusstring

The status to update the payment request to

Example request

{
  "status": "ACTIVE"
}

Response

204 no content

Changes

No recorded changes to this operation across all 7 revisions of this API.