fundingInstructions

List funding instructions

Changed on

Important: You can return a list of funding instructions from only the previous two years. If you want to view a funding instruction from more than two years ago and you have its instructionId, use our Retrieve Funding Instruction method.

Use this method to return a paginated list of funding instructions within a specific date range.

Note: If you want to view the details of a specific funding instruction and you have its instructionId, use our Retrieve Funding Instruction method.

Our gateway returns the following information for each instruction in the list:

  • 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.

For each funding instruction, we also return the instructionId, which you can use to perform follow-on actions.

get/funding-instructions

Request

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

Query parameters

beforestring

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstring

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitinteger

Limit the maximum number of results that we return for each page.

dateFromstring date required

Filter by funding instructions sent after a specific date. Send a value in YYYY-MM-DD format.

dateTostring date required

Filter by funding instructions sent before a specific date. Send a value in YYYY-MM-DD format.

Response

Successful request. Returns a list of funding instructions.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean

Indicates whether there is another page of results available.

Changes