Create order

POST

/v2/orders

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201Created

application/json

Order

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/orders' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
    "paymentMethod": "pix",
    "totalAmount": 0,
    "items": [
        {
            "description": "string",
            "quantity": 0,
            "amount": 0
        }
    ],
    "customer": {
        "name": "string",
        "email": "user@example.com",
        "document": "string",
        "document_type": "string",
        "type": "string",
        "phones": {
            "property1": "string",
            "property2": "string"
        },
        "address": {
            "property1": "string",
            "property2": "string"
        }
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "success_url": "http://example.com",
    "cancel_url": "http://example.com"
}'

Response Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "code": "string",
    "status": "string",
    "paymentMethod": "string",
    "totalAmount": 0,
    "customer": {
        "name": "string",
        "email": "user@example.com",
        "document": "string",
        "document_type": "string",
        "type": "string",
        "phones": {
            "property1": "string",
            "property2": "string"
        },
        "address": {
            "property1": "string",
            "property2": "string"
        }
    },
    "items": [
        {
            "description": "string",
            "quantity": 0,
            "amount": 0
        }
    ],
    "last_transaction": {
        "property1": "string",
        "property2": "string"
    },
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modificado em 2025-11-15 15:11:05