Skip to main content
Breaking changes are announced here before they take effect. See Versioning and deprecation.
Sandbox handover
  • Customer Contacts can now be updated. Send a stable externalContactId on each Contact; see Updating Contacts.
  • When your Integration and PayPathIQ staff both change a Customer or Contact, the newest update wins; see The latest update wins.
  • Every problem type now links to an error reference page.
  • Every 422 validation_error now lists field problems in errors, with a JSON pointer and a field error code.
  • Leaving a safety assertion type out of a supplied collection no longer clears it. Only "state": "cleared" clears an assertion.
  • The OpenAPI document now lists 409 receivable_state_conflict for Receivable and Payment observation PUT, and 409 payment_policy_blocked for Payment observation PUT. It no longer lists pause_source_conflict or a 409 for close, which the API never returned, or 500 internal_error; unexpected failures return 503 projection_unavailable.
  • Documented rate limits, scopes, and how to get a sandbox key.