Contracts#

Before submitting collection cases, you must sign a collection agreement with CasaPay. The Contracts endpoint lets you check your agreement status.

The Contract object#

Attribute	Type	Description
`signed`	boolean	Whether the contract is signed
`requires_resigning`	boolean	Whether the contract needs to be re-signed
`invalidation_reason`	enum	`none`, `new_version`, `admin_invalidated`, `name_changed`
`terms_url`	string	URL to the signed contract PDF
`solution_url`	string	URL to sign or re-sign the contract
`signed_at`	timestamp	When the contract was signed
`version`	string	Contract version

{
  "signed": true,
  "requires_resigning": false,
  "invalidation_reason": "none",
  "terms_url": "https://files.casapay.com/contracts/signed_v2.pdf",
  "solution_url": null,
  "signed_at": 1704067200,
  "version": "v2.0"
}

Get Contract Status#

GET /v1/collection_contract

curl https://api.casapay.com/v1/collection_contract \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Unsigned Contract Response#

{
  "signed": false,
  "requires_resigning": false,
  "invalidation_reason": "none",
  "terms_url": null,
  "solution_url": "https://dashboard.casapay.com/contracts/sign",
  "signed_at": null,
  "version": "v2.0"
}

Re-signing Required Response#

{
  "signed": true,
  "requires_resigning": true,
  "invalidation_reason": "new_version",
  "terms_url": "https://files.casapay.com/contracts/signed_v1.pdf",
  "solution_url": "https://dashboard.casapay.com/contracts/resign",
  "signed_at": 1696118400,
  "version": "v2.0"
}