API Basics
- API structure: Our APIs are organized around REST, have object oriented URLs, accept form-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication, and methods.
- Static IPs: At Cross River you need to allowlist your static, public IP address before you can access our products. Your IP is allowlisted as part of the partner onboarding process.
- Idempotency: Cross River's COS system supports idempotency to retry requests without the risk of performing the request multiple times. This is especially useful in situations where there is a network outage, and you aren’t sure if a previous request has been processed successfully.
- Pagination: Pagination is a process that divides a large dataset into smaller chunks. All endpoints that return a list of resources support pagination.
- API versioning: All API endpoints contain a numbered version in the URL. Whenever breaking changes are made to the API, a new major version will be created.