Retrieve funding instruction

Browse API reference

GET/funding-instructions/{instructionId}getInstruction

Use this method to retrieve information about a funding instruction.

To retrieve 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 instructionId, use our List Funding Instructions method to search for the funding instruction.

Our gateway returns the following information about the funding instruction:

Status of the funding instruction.
Funding information, including which merchant's funding balance we distribute and the funding account that we send the balance to.

Parameters

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

Responses

Successful request. Returns the funding instruction.

200 OK · application/json

{
  "createdDate": "2024-07-02T15:30:00Z",
  "instructionId": 64643131,
  "lastModifiedDate": "2024-07-02T15:30:00Z",
  "merchants": [
    {
      "link": {
        "href": "https://api.payroc.com/v1/processing-accounts/4525644354",
        "method": "get",
        "rel": "merchant"
      },
      "merchantId": "4525644354",
      "recipients": [
        {
          "amount": {
            "currency": "USD",
            "value": 120000
          },
          "fundingAccountId": 123,
          "link": {
            "href": "https://api.payroc.com/v1/funding-accounts/123",
            "method": "get",
            "rel": "fundingAccount"
          },
          "metadata": {
            "yourCustomField": "abc123"
          },
          "paymentMethod": "ACH",
          "status": "funded"
        }
      ]
    }
  ],
  "metadata": {
    "yourCustomField": "abc123"
  },
  "status": "completed"
}

Response schema · 18 of 23 fields

createdDatestringdatetime
Date that we created the funding instruction. The date format follows the ISO 8601 standard.
instructionIdinteger
Unique identifier that we assigned to the funding instruction.
lastModifiedDatestringdatetime
Date of the most recent change to the funding instruction. The date format follows the ISO 8601 standard.
merchantsobject[]
Array of merchants objects. Each object specifies the merchant whose funding balance we distribute and who you want to send the funds to.
- linkobject
  Object that contains HATEOAS links for the resource.
  - hrefstring
    URL of the target resource.
  - methodstring
    HTTP method that you need to use with the target resource.
  - relstring
    Indicates the relationship between the current resource and the target resource.
- 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.
  - linkobject
    Object that contains HATEOAS links for the resource.+3 more fields at deeper levels — see the full spec
  - 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
  - statusstring
    Status of the individual payment instruction. Our gateway returns one of the following values: accepted We received the payment instruction, but we haven't reviewed it. pending We are reviewing the payment instruction. released We approved the payment instruction. funded We sent the funds to the funding account by ACH. failed The ACH payment to the funding account failed. rejected We reviewed the payment instruction and rejected it. onHold We have placed the payment instruction on hold.acceptedpendingreleasedfundedfailedrejectedonHold
metadataobject
Metadata object you can use to include custom data with your request.
statusstring
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.acceptedpendingcompleted

Validation error.

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid value",
      "message": "Expected integer, got abc",
      "parameter": "instructionId"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

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

delete-a-funding-instruction update-a-funding-instruction