Customers

Get customer payments

Changed on

List all payments from a specific customer.

get/customers/{id}/payments

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/customers/{id}/payments
  • Auth: HTTP bearer

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

pageSizeinteger
cursorstring

Response

Payments retrieved successfully

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "PMT-00001",
      "customer": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-CUSTOMER-ACME",
        "name": "Acme Manufacturing Corp",
        "friendlyId": "A123456",
        "status": "ACTIVE",
        "phoneNumber": "+1-555-123-4567",
        "website": "https://acme-manufacturing.com",
        "createdAt": "2025-01-15T10:00:00Z",
        "updatedAt": "2025-01-15T14:30:00Z"
      },
      "currency": "USD"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • warning

      added the new BLOCKED enum value to the /// response property for the response status

    • warning

      added the new CLOSED enum value to the /// response property for the response status

    • warning

      added the new CONTACTED enum value to the /// response property for the response status

    • warning

      added the new NEW enum value to the /// response property for the response status

    • warning

      added the new NURTURING enum value to the /// response property for the response status

    • warning

      added the new PENDING enum value to the /// response property for the response status

    • warning

      added the new QUALIFIED enum value to the /// response property for the response status

    • warning

      added the new QUOTED enum value to the /// response property for the response status

    • info

      removed the CHURNED enum value from the /// response property for the response status

    • info

      removed the PROSPECT enum value from the /// response property for the response status