Sandbox Access

An API access token obtained from cielo24 API is a prerequisite to access the cielo24 sandbox API. With this token, you can create a new account on the sandbox API. Optional arguments may be passed either as HTTP headers or query string parameters. Required arguments must be passed as query string parameters.

HTTP Method

POST /api/account/create

Query String Parameters — Required (always)

Name

Details

v

Description

The version of the API to use

Allowed Values

1

Example

v=1

api_token

Description

The API token used for this session

Allowed Values

Hex String

Example | api_token=7ca5dc5c7cce449fb0fff719307e8f5f

new_username

Description | The new username associated with this account to be used on Sandbox

Allowed Values

String

Example

new_username=john_doe

new_password

Description

The new password associated with this account to be used on Sandbox

Allowed Values

String

Example | new_password=example_password

Request Body Parameters — Optional

Name

Details

sub_account

Description

Username of a sub account

Allowed Values

Integer

Example

sub_account=my_sub_account

parent_account

Description

Username of a parent account

Allowed Values

Integer

Example

parent_account=my_parent_account

first_name

Description

First name of the new account

Allowed Values

String

Example

first_name=john

last_name

Description

Last name of the new account

Allowed Values

String

Example

last_name=doe

email

Description

Email of the new account

Allowed Values

String

Example

email=john_doe@email.com

Responses

HTTP Code

Details

204

Description

Success

Contents

none

400

Description

An error occurred

Contents

Error description (see Error Format for details)

Example Requests

POST /api/account/create HTTP/1.1
Host: sandbox.cielo24.com
Body: v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f&new_username=john_doe&new_password=example_password

Example Response

HTTP/1.1 204 OK