**Get a $50 voucher to share your developer experience with Payroc.** [Contact us](mailto:[email protected]) to register your interest.
APIPartner with us
Get startedGuidesKnowledgeTestAPI
Get startedGuidesKnowledgeTestAPI
    • Introduction
    • Authentication
    • Idempotency
    • Metadata
    • Pagination
    • Versioning
    • Errors
  • Schema

Get a $50 voucher to share your developer experience with Payroc. Contact us to register your interest.

LogoLogo
APIPartner with us
SchemaFundingFunding Instructions

List funding instructions

GET
/funding-instructions
GET
/v1/funding-instructions
1curl -G https://api.payroc.com/v1/funding-instructions \
2     -H "Authorization: Bearer <token>" \
3     -d before=2571 \
4     -d after=8516 \
5     -d limit=25 \
6     -d dateFrom=2024-07-01 \
7     -d dateTo=2024-07-03
Try it
1{
2  "data": [
3    {
4      "createdDate": "2024-07-02T15:30:00Z",
5      "instructionId": 64643131,
6      "lastModifiedDate": "2024-07-02T15:30:00Z",
7      "link": {
8        "rel": "fundingInstruction",
9        "method": "get",
10        "href": "https://api.payroc.com/v1/funding-instructions/64643131"
11      },
12      "merchants": [
13        {
14          "merchantId": "4525644354",
15          "recipients": [
16            {
17              "fundingAccountId": 123,
18              "paymentMethod": "ACH",
19              "amount": {
20                "value": 120000,
21                "currency": "USD"
22              },
23              "status": "funded",
24              "metadata": {
25                "yourCustomField": "abc123"
26              },
27              "link": {
28                "rel": "fundingAccount",
29                "method": "get",
30                "href": "https://api.payroc.com/v1/funding-accounts/123"
31              }
32            },
33            {
34              "fundingAccountId": 124,
35              "paymentMethod": "ACH",
36              "amount": {
37                "value": 50050,
38                "currency": "USD"
39              },
40              "status": "rejected",
41              "metadata": {
42                "yourCustomField": "abc123"
43              },
44              "link": {
45                "rel": "fundingAccount",
46                "method": "get",
47                "href": "https://api.payroc.com/v1/funding-accounts/124"
48              }
49            }
50          ],
51          "link": {
52            "rel": "merchant",
53            "method": "get",
54            "href": "https://api.payroc.com/v1/processing-accounts/4525644354"
55          }
56        }
57      ],
58      "metadata": {
59        "yourCustomField": "abc123"
60      },
61      "status": "completed"
62    },
63    {
64      "createdDate": "2024-07-02T15:30:00Z",
65      "instructionId": 64643132,
66      "lastModifiedDate": "2024-07-02T15:30:00Z",
67      "link": {
68        "rel": "fundingInstruction",
69        "method": "get",
70        "href": "https://api.payroc.com/v1/funding-instructions/64643132"
71      },
72      "merchants": [
73        {
74          "merchantId": "4525644354",
75          "recipients": [
76            {
77              "fundingAccountId": 123,
78              "paymentMethod": "ACH",
79              "amount": {
80                "value": 5000,
81                "currency": "USD"
82              },
83              "status": "accepted",
84              "metadata": {
85                "yourCustomField": "abc123"
86              },
87              "link": {
88                "rel": "fundingAccount",
89                "method": "get",
90                "href": "https://api.payroc.com/v1/funding-accounts/123"
91              }
92            }
93          ],
94          "link": {
95            "rel": "merchant",
96            "method": "get",
97            "href": "https://api.payroc.com/v1/processing-accounts/4525644354"
98          }
99        },
100        {
101          "merchantId": "4525644354",
102          "recipients": [
103            {
104              "fundingAccountId": 124,
105              "paymentMethod": "ACH",
106              "amount": {
107                "value": 1000,
108                "currency": "USD"
109              },
110              "status": "accepted",
111              "metadata": {
112                "yourCustomField": "abc123"
113              },
114              "link": {
115                "rel": "fundingAccount",
116                "method": "get",
117                "href": "https://api.payroc.com/v1/funding-accounts/124"
118              }
119            }
120          ],
121          "link": {
122            "rel": "merchant",
123            "method": "get",
124            "href": "https://api.payroc.com/v1/processing-accounts/4525644354"
125          }
126        }
127      ],
128      "metadata": {
129        "yourCustomField": "abc123"
130      },
131      "status": "accepted"
132    }
133  ],
134  "count": 2,
135  "hasMore": true,
136  "limit": 2,
137  "links": [
138    {
139      "rel": "previous",
140      "method": "get",
141      "href": "https://api.payroc.com/v1/funding-instructions?before=64643131&limit=2&datefrom=2024-07-01&dateto=2024-07-03"
142    },
143    {
144      "rel": "next",
145      "method": "get",
146      "href": "https://api.payroc.com/v1/funding-instructions?after=64643132&limit=2&datefrom=2024-07-01&dateto=2024-07-03"
147    }
148  ]
149}
Retrieve a list of funding instructions for a specific date range.
Was this page helpful?
Previous

Create funding instruction

Next
Create funding instruction
Retrieve a list of funding instructions for a specific date range.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query Parameters

beforestringOptional

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.

afterstringOptional

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.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
dateFromdateRequired
Retrieve activity that occured since `dateFrom`. We can return activity from only the last two years.
dateTodateRequired
Retrieve activity that occured before `dateTo`.

Response

Successful request. Returns a list of funding instructions.
datalist of objects
Array of fundingInstruction objects.
countdouble or null

Number of results we returned on this page.

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

hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.
linkslist of objects or null
Reference links to navigate to the previous page of results or to the next page of results.

Errors

Limit the maximum number of results that we return for each page.
Successful request. Returns a list of funding instructions.

Retrieve activity that occured before dateTo.

Retrieve activity that occured since dateFrom. We can return activity from only the last two years.