UPupflow
Payments

List Payments

List payments with optional filtering.

get/payments

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

sortBy'updatedAt' | 'validatedAt' | 'createdAt'

Sort payments by a specific column.

sortOrder'DESC' | 'ASC'

Sort order.

updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}
validatedAt.gtstring date-time

Minimum value to filter by (exclusive)

validatedAt.gtestring date-time

Minimum value to filter by (inclusive)

validatedAt.ltstring date-time

Maximum value to filter by (exclusive)

validatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "validatedAt.gt": "2015-05-05T12:30:00Z",
  "validatedAt.gte": "2015-05-05T12:30:00Z",
  "validatedAt.lt": "2015-05-05T12:30:00Z",
  "validatedAt.lte": "2015-05-05T12:30:00Z"
}
amountLinkedinteger

Return payments where allocated amount is equal to this value (in cents).

amountLinked.gtinteger

Return payments where allocated amount is greater than this value (in cents).

amountLinked.gteinteger

Return payments where allocated amount is greater than or equal to this value (in cents).

amountLinked.ltinteger
Example:100000

Return payments where allocated amount is lower than this value (in cents).

amountLinked.lteinteger
Example:100000

Return payments where allocated amount is lower than or equal to this value (in cents).

amountinteger
Example:300000

Return payments where amount is equal to this value (in cents).

amount.gtinteger
Example:300000

Return payments where amount is greater than this value (in cents).

amount.gteinteger
Example:300000

Return payments where amount is greater than or equal to this value (in cents).

amount.ltinteger
Example:300000

Return payments where amount is lower than this value (in cents).

amount.lteinteger
Example:300000

Return payments where amount is lower than or equal to this value (in cents).

customer.idstring
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter payments by Customer ID.

customer.externalIdstring
Example:134

Filter payments by external Customer ID.

modifiedAt.gtstring date-time

Minimum value to filter by (exclusive)

modifiedAt.gtestring date-time

Minimum value to filter by (inclusive)

modifiedAt.ltstring date-time

Maximum value to filter by (exclusive)

modifiedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "modifiedAt.gt": "2015-05-05T12:30:00Z",
  "modifiedAt.gte": "2015-05-05T12:30:00Z",
  "modifiedAt.lt": "2015-05-05T12:30:00Z",
  "modifiedAt.lte": "2015-05-05T12:30:00Z"
}

Response

Paginated list of payments.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "refNumber": "PYMT123",
      "currency": "EUR",
      "amount": 1700,
      "validatedAt": "2015-05-05T12:30:00Z",
      "externalId": "92842AB37",
      "customFields": [
        {
          "id": "00a70b35-2be3-4c43-aefb-397190134655",
          "externalId": "AEGaaZD"
        }
      ],
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "amountLinked": 1700,
      "modifiedAt": "2015-05-05T12:30:00Z",
      "linkedInvoices": [
        {
          "linkedAmount": 3000,
          "invoice": {
            "id": "00a70b35-2be3-4c43-aefb-397190134655",
            "currency": "EUR",
            "amountOutstanding": 1500,
            "customId": "FAC123",
            "grossAmount": 2200,
            "netAmount": 2000,
            "name": "Facture couvrant les prestations de service de Decembre",
            "issuedAt": "2015-05-05T12:30:00Z",
            "dueDate": "2015-05-05T12:30:00Z",
            "paidDate": "2015-05-05T12:30:00Z",
            "externalId": "92842AB37"
          }
        }
      ],
      "customer": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "1a2c3b",
        "companyName": "Upflow SAS",
        "accountingRef": "UPFL-SAS"
      },
      "createdAt": "2015-05-05T12:30:00Z",
      "updatedAt": "2015-05-05T12:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.