API Documentation

Overview

Approved crypto partners may execute designated escrow transaction actions on behalf of authorized customers within Escrowly’s stablecoin-based infrastructure. Once explicit authorization is granted, partners can perform lifecycle actions including: agree, ship, receive, reject, ship_return, receive_return, and reject_return. All actions are recorded on-chain or within immutable transaction logs for audit and compliance integrity.

This is achieved by including the As-Customer header with the email address of the party you are acting on behalf of.

Example Request

The following example demonstrates how to perform an action using the As-Customer header:

1curl
2"https://api.escrowly.com/v1/transaction/9292" \
3 -X PATCH \
4 -u email-address:api-key \
5 -H 'As-Customer: [email protected]' \
6 -d '{"action": "receive"}'

(Code samples for Python, Ruby, PHP, and C# are available in the full API documentation. Access to the complete API reference, webhook specifications, and advanced integration guides requires a verified Escrowly account.)

Rate Limiting

To preserve network integrity and ensure fair usage across Escrowly’s stablecoin escrow infrastructure, rate limits are enforced on all API endpoints. The remaining request quota is returned in the RateLimit-Remaining HTTP header. For higher throughput requirements, contact Escrowly support for enterprise allocation.

Error Codes

If a request fails, the API returns a standardized HTTP status code along with a structured error response. Common responses include: