Update funding instruction

Browse API reference

PUT/funding-instructions/{instructionId}updateInstructions

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.

Parameters

Name	In	Type	Description
`instructionId`Required	path	`integer`	Unique identifier that we assigned to the funding instruction.

Request body

application/json

Field Edit request inputs →

merchantsobject[]
Array of merchants objects. Each object specifies the merchant whose funding balance we distribute and who you want to send the funds to.
- merchantIdstringrequired
  Unique identifier that the processor assigned to the merchant.
- recipientsobject[]required
  Array of recipients objects. Each object contains information about the funding account and the amount of funds we send to the funding account.≥ 1 items
  - amountobjectrequired
    Object that contains information about the funds that we send to the funding account.+2 more fields at deeper levels — see the full spec
  - fundingAccountIdintegerrequired
    Unique identifier that we assigned to the funding account.
  - metadataobject
    Metadata object you can use to include custom data with your request.
  - paymentMethodstringrequired
    Payment method that we use to send funds to the funding account.ACH
metadataobject
Metadata object you can use to include custom data with your request.

Responses

Successful request. We updated the funding instruction.

No response body — a 204 means the action took effect.

Validation error.

400 Bad Request · application/problem+json

{
  "detail": "One or more funding accounts are restricted and can't receive funding instructions",
  "errors": [
    {
      "message": "Funding account on hold",
      "parameter": "fundingAccountId"
    }
  ],
  "status": 400,
  "title": "Funding accounts restricted",
  "type": "https://docs.payroc.com/api/errors#funding-accounts-restricted"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Conflict.

409 Conflict · application/problem+json

{
  "detail": "You cannot modify this resource in its current state",
  "status": 409,
  "title": "Cannot be modified",
  "type": "https://docs.payroc.com/api/errors#cannot-be-modified"
}

Response schema · 13 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
instancestring
Resource path to the existing resource
linkobject
Object that contains HATEOAS links for the resource.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

update-a-funding-instruction