Update funding instruction | Payroc

Important: You can update a funding instruction only if its status is accepted. To view the status of a funding instruction, use our Retrieve Funding Instruction method.

Use this method to update the details of a funding instruction.

To update a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the Create Funding Instruction method.

Note: If you don’t have the fundingInstructionId, use our List Funding Instructions method to search for the funding instruction.

You can modify the following information for the funding instruction:

Merchant ID (MID) of the merchant whose funding balance you want to distribute.
Funding account that you want to send funds to.
Amount that you want to send to the funding account.

> **Important:** You can update a funding instruction only if its status is `accepted`. To view the status of a funding instruction, use our [Retrieve Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/retrieve) method. Use this method to update the details of a funding instruction. To update a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the [Create Funding Instruction](https://docs.payroc.com/api/schema/funding/funding-instructions/create) method. **Note:** If you don't have the fundingInstructionId, use our [List Funding Instructions](https://docs.payroc.com/api/schema/funding/funding-instructions/list) method to search for the funding instruction. You can modify the following information for the funding instruction: - Merchant ID (MID) of the merchant whose funding balance you want to distribute. - Funding account that you want to send funds to. - Amount that you want to send to the funding account.

Path Parameters

instructionIdstringRequired

Request

This endpoint expects an object.

merchantslist of objectsOptional

Array of merchants objects. Each object specifies the merchant whose funding balance we distribute and who you want to send the funds to.

metadatamap from strings to stringsOptional

Metadata object you can use to include custom data with your request.

Response

Successful request. We updated the funding instruction.

Errors