ClientCasa
API

Payments

Record manual payments and view payment history. Payments are immutable; to reverse a payment, record a refund with negative amount.

GET
/api/v1/payments

Authorization

x-api-key<token>

In: header

Query Parameters

page?integer
Default1
Range1 <= value
pageSize?integer
Default25
Range1 <= value <= 100
clientId?string

UUID v4

Formatuuid
invoiceId?string

UUID v4

Formatuuid
status?string
Value in"pending" | "processing" | "succeeded" | "failed"
kind?string
Value in"payment" | "refund" | "chargeback" | "dispute_fee" | "adjustment"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/payments"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "clientId": "550e8400-e29b-41d4-a716-446655440000",
      "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
      "amount": 0,
      "currency": "string",
      "receivedDate": "2019-08-24",
      "method": "stripe",
      "status": "pending",
      "kind": "payment",
      "reference": "string",
      "notes": "string",
      "netAmount": 0,
      "payoutId": "550e8400-e29b-41d4-a716-446655440000",
      "refundOfId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
POST
/api/v1/payments

Authorization

x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

Optional unique key that makes this create safely retryable. Replaying the same key returns the original response instead of creating a duplicate; reusing a key with a different request body returns 409.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.clientcasa.com/api/v1/payments" \  -H "Content-Type: application/json" \  -d '{    "clientId": "550e8400-e29b-41d4-a716-446655440000",    "amount": 0,    "receivedDate": "2019-08-24",    "method": "check"  }'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 0,
  "currency": "string",
  "receivedDate": "2019-08-24",
  "method": "stripe",
  "status": "pending",
  "kind": "payment",
  "reference": "string",
  "notes": "string",
  "netAmount": 0,
  "payoutId": "550e8400-e29b-41d4-a716-446655440000",
  "refundOfId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
GET
/api/v1/payments/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/payments/550e8400-e29b-41d4-a716-446655440000"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 0,
  "currency": "string",
  "receivedDate": "2019-08-24",
  "method": "stripe",
  "status": "pending",
  "kind": "payment",
  "reference": "string",
  "notes": "string",
  "netAmount": 0,
  "payoutId": "550e8400-e29b-41d4-a716-446655440000",
  "refundOfId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
PATCH
/api/v1/payments/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://www.clientcasa.com/api/v1/payments/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 0,
  "currency": "string",
  "receivedDate": "2019-08-24",
  "method": "stripe",
  "status": "pending",
  "kind": "payment",
  "reference": "string",
  "notes": "string",
  "netAmount": 0,
  "payoutId": "550e8400-e29b-41d4-a716-446655440000",
  "refundOfId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Document Versions

Read-only audit trail of issued document versions for smart-files, invoices, and standalone contracts.

Payouts

View Stripe payouts to your bank account. Payouts are read-only — they're created automatically by Stripe webhooks.