AutoPay API Reference

Welcome to the AutoPay technical reference. Our API is built on RESTful principles, uses JSON for data exchange, and standard HTTP response codes.

Environments and base URL

All requests must be sent to the following base URLs, depending on the environment you are using:

Environment	Base URL	Description
Sandbox	`https://api-test.placetopay.com`	Used for development and testing. It does not process real money.
Production	`https://api.placetopay.com`	Real transactional environment.

Headers

All API requests must include the following HTTP headers to ensure the content is interpreted correctly:

    Content-Type: application/json
    Accept: application/json
    User-Agent: YourApp/1.0 (Recommended to identify your traffic)

Standard response structure

Regardless of the endpoint, all API responses follow a common structure. You will always receive a status object indicating the technical result of the operation.

    {
        "status": {
            "status": "OK",
            "reason": "00",
            "message": "The request has been processed successfully",
            "date": "2023-06-21T09:56:06-05:00"
        },
        ...,
    }

status: Indicates the success (OK) or failure (FAILED) of the technical request.
reason: Internal code for programmatic error handling.
message: Readable description of the result.
* : Contains the requested information (e.g., session details, transaction list).

Available services

Explore the available endpoints to manage the autopay lifecycle:

Sessions: The entry point. Allows creating a new autopay or editing an existing one.
Search: Query the status and details of your autopays.
Transactions: Get the history of charges made on a specific autopay.
Cancellation: Stop an autopay to prevent future charges.