Update funding account

Browse API reference

PUT/funding-accounts/{fundingAccountId}updateFundingAccount

Important: You can't update the details of a funding account that is associated with a processing account.

Use this method to update the details of a funding account that is associated with a funding recipient.

To update a funding account, you need its fundingAccountId. Our gateway returned the fundingAccountId when you created the funding account.

Note: If you don’t have the fundingAccountId, use our List Funding Accounts method to search for the funding account.

You can update the following details about the funding account:

Account type.
Account holder's name.
ACH information for the account.

Parameters

Name	In	Type	Description
`fundingAccountId`Required	path	`integer`	Unique identifier of the funding account.

Request body

application/json

Field Edit request inputs →

metadataobject
Metadata object you can use to include custom data with your request.
nameOnAccountstringrequired
Name of the account holder.
paymentMethodsobject[]required
Array of PaymentMethodAch objects.
- ACH payment methodobject
  - typestring
    Payment method that we use to send funds to the account.ach
  - valueobject
    Object that contains information about the funding account.+2 more fields at deeper levels — see the full spec
typestringrequired
Type of funding account.checkingsavingsgeneralLedger
usestringrequired
Indicates if we send funds or withdraw funds from the account. credit Send funds to the account. debit Withdraw funds from the account. creditAndDebit Send funds and withdraw funds from the account. Note: If the funding account is associated with a funding recipient, we accept only a value of credit.creditdebitcreditAndDebit

Responses

Successful request. We updated the funding account.

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

Validation errors

400 Bad Request · application/problem+json

{
  "detail": "Entity has been rejected due to failing KYC checks",
  "status": 400,
  "title": "Failed KYC Checks",
  "type": "https://docs.payroc.com/api/errors#kyc-check-failed"
}

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

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

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

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-account