List funding activity

Browse API reference

GET/funding-activitygetFundingActivity

Use this method to return a paginated list of activity associated with your merchants' funding balances within a specific date range.

Use query parameters to filter the list of results we return, for example, to view the activity for a specific merchant's funding balance.

Our gateway returns the following information about each activity in the list:

Name of the merchant who owns the funding balance.
Amount of funds added or removed from the funding balance.
Funding account that received funds from the funding balance.

Parameters

Name	In	Type	Description
`before`	query	`string`	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.
`after`	query	`string`	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.
`limit`	query	`integer`	Limit the maximum number of results that we return for each page.
`dateFrom`Required	query	`string`	Filter by activity after a specific date. Send a value in YYYY-MM-DD format.
`dateTo`Required	query	`string`	Filter by activity before a specific date. Send a value in YYYY-MM-DD format.
`merchantId`	query	`string`	Filter results by the unique identifier that the processor assigned to the merchant.

Responses

Successful request. Returns a list of funding activity.

200 OK · application/json

{
  "count": 10,
  "data": [
    {
      "amount": 4999,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "sales",
      "id": 11,
      "merchant": "Pizza Doe",
      "type": "credit"
    },
    {
      "amount": 3999,
      "currency": "USD",
      "date": "2024-07-02T19:32:00.000Z",
      "description": "sales",
      "id": 12,
      "merchant": "Pizza Doe",
      "type": "credit"
    },
    {
      "amount": 3299,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "sales",
      "id": 13,
      "merchant": "Pizza Doe",
      "type": "credit"
    },
    {
      "amount": 50,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "Interchange Fees",
      "id": 14,
      "merchant": "Pizza Doe",
      "recipient": "Payroc",
      "type": "debit"
    },
    {
      "amount": 4999,
      "currency": "USD",
      "date": "2024-07-02T09:10:00.000Z",
      "description": "sales",
      "id": 15,
      "merchant": "Pizza Doe",
      "type": "credit"
    },
    {
      "amount": 750,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "Adjustment",
      "id": 16,
      "merchant": "Doe Hot Dogs",
      "type": "credit"
    },
    {
      "amount": 5,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "Interchange Fees",
      "id": 17,
      "merchant": "Doe Hot Dogs",
      "recipient": "Payroc",
      "type": "debit"
    },
    {
      "amount": 1000,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "Charge back",
      "id": 18,
      "merchant": "Pizza Doe",
      "recipient": "Payroc",
      "type": "debit"
    },
    {
      "amount": 5999,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "sales",
      "id": 19,
      "merchant": "Pizza Doe",
      "type": "credit"
    },
    {
      "amount": 1000,
      "currency": "USD",
      "date": "2024-07-02T17:00:00.000Z",
      "description": "payment",
      "id": 20,
      "merchant": "Pizza Doe",
      "recipient": "Pizza Doe",
      "type": "debit"
    }
  ],
  "hasMore": true,
  "limit": 10,
  "links": [
    {
      "href": "https://api.payroc.com/v1/funding-activity?before=11&limit=10&datefrom=2024-07-01&dateto=2024-07-03",
      "method": "get",
      "rel": "previous"
    },
    {
      "href": "https://api.payroc.com/v1/funding-activity?after=20&limit=10&datefrom=2024-07-01&dateto=2024-07-03",
      "method": "get",
      "rel": "next"
    }
  ]
}

Response schema · 16 fields

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.
limitinteger
Maximum number of results that we return for each page.
linksobject[]
Reference links to navigate to the previous page of results or to the next page of results.
- 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.
dataobject[]required
Array of activityRecord objects.
- amountintegerint64required
  Total amount that we removed or added to the merchant's funding balance. The value is in the currency’s lowest denomination, for example, cents.
- currencystringrequired
  Currency of the funds. We return a value of USD.
- datestringdatetimerequired
  Date that we moved the funds.
- descriptionstringrequired
  Description of the activity.
- idintegerrequired
  Unique identifier that we assigned to the activity.
- merchantstringrequired
  Doing business as (DBA) name of the merchant that owns the funding balance.
- recipientstring
  Name of the account holder who owns the funding account that received funds. Note: We return a value for recipient only if the value for type is debit.
- typestringrequired
  Indicates if we moved funds into or out of the funding balance. Our gateway returns one of the following values: credit We moved funds into the funding balance. debit We moved funds out of the funding balance.creditdebit

Validation error.

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "datefrom cannot be longer than two years ago.",
      "parameter": "datefrom"
    }
  ],
  "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

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

review-funding-activity