Skip to main content

Update Creditor V3

POST 
/v3/creditors/update

Initiates the update of an existing creditor. Accepted only when the creditor's status is Created, Active, SupportingDocumentsRequired or UpdateRequired. A creditor in Requested has not yet been created by the Funds Controller, and Removed and Failed are terminal statuses that cannot be updated. A 202 response means the update has been accepted for processing, not that it has been applied — the outcome arrives asynchronously as the global.rtgs.creditorStatusUpdatedV3 webhook. CorrelationId is the idempotency key — a request whose payload, including this identifier, has already been received is accepted but not processed again, so a retry of a failed update must use a new one. The Creditor payload must conform to the schema returned by GET /v3/creditors/schemas/update.

Request​

Responses​

Accepted