fundingInstructions

Update funding instruction

Changed on

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.
put/funding-instructions/{instructionId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/funding-instructions/{instructionId}
  • Auth
    HTTP bearer

Path parameters

instructionIdinteger required

Unique identifier that we assigned to the funding instruction.

Request body

instructionIdinteger

Unique identifier that we assigned to the funding instruction.

createdDatestring datetime

Date that we created the funding instruction. The date format follows the ISO 8601 standard.

lastModifiedDatestring datetime

Date of the most recent change to the funding instruction. The date format follows the ISO 8601 standard.

status'accepted' | 'pending' | 'completed'

Status of the funding instruction. Our gateway returns one of the following values:

  • accepted - We have received the funding instruction but have not yet reviewed it.
  • pending - We have received the funding instruction and we are reviewing it.
  • completed - We have reviewed and processed the funding instruction.
metadataobject

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

Response

Successful request. We updated the funding instruction.

object required

Changes