> For the complete documentation index, see [llms.txt](https://apidoc.tokenpay.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.tokenpay.me/pt-br/pedido/criacao-de-pedido.md).

# Criação de pedido

{% hint style="info" %}
DICA (TIP)

Após a criação do pedido, a interface retornará o link de pagamento e o usuário entrará na caixa registradora através do link para pagar. Se o comerciante tiver configurado um aplicativo de marca branca, o código front-end também precisará estar conectado ao JS-SDK. [Ver SDK](https://www.npmjs.com/package/@ttpay/payment_modal)
{% endhint %}

#### Endereço da interface (Interface address)

```
POST https://api.tokenpay.me/v1/transaction/prepayment
```

#### Parâmetros da interface (Interface parameters)

| Nome            | Localização | Tipo    | Obrigatório | Descrição                                                                                                                                                                                                                                        |
| --------------- | ----------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `app_id`        | header      | string  | Sim         | ID do aplicativo, valor de exemplo: `8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd`                                                                                                                                                                           |
| `mch_id`        | body        | string  | Sim         | ID do comerciante, valor de exemplo: `12345678`                                                                                                                                                                                                  |
| `description`   | body        | string  | Não         | Descrição do pedido, valor de exemplo: `recharge`                                                                                                                                                                                                |
| `out_trade_no`  | body        | string  | Sim         | Número do pedido do comerciante, o comerciante gera seu próprio número de pedido exclusivo                                                                                                                                                       |
| `expire_second` | body        | integer | Sim         | Tempo de expiração (segundos), valor de exemplo: `3600`                                                                                                                                                                                          |
| `amount`        | body        | number  | Sim         | Valor do pedido, valor de exemplo: `15000000`                                                                                                                                                                                                    |
| `chain`         | body        | string  | Sim         | Cadeia pública pertencente, valor de exemplo: `TRON`                                                                                                                                                                                             |
| `currency`      | body        | string  | Sim         | Moeda, valor de exemplo: `TRX`. [Ver moedas suportadas](/pt-br/moeda/informacoes-da-moeda.md)                                                                                                                                                    |
| `to_address`    | body        | string  | Não         | Carteira de cobrança (Nota: a carteira de pagamento é necessária para o aplicativo `monitor order`)                                                                                                                                              |
| `attach`        | body        | string  | Não         | Parâmetros personalizados (como identificadores exclusivos, como IDs de usuário) são retornados inalterados nas APIs de consulta e notificações de pagamento. Na prática, este campo só é retornado quando o status do pagamento está concluído. |
| `locale`        | body        | string  | Não         | Idioma: `zh_cn` Chinês, `en` Inglês. O uso da caixa registradora exibirá o idioma padrão com base nesta configuração.                                                                                                                            |
| `notify_url`    | body        | string  | Não         | URL de retorno de chamada (Callback URL), valor de exemplo: `https://xxx/xxx`. [Sugere-se o uso de https](/pt-br/descricao/informacoes-de-seguranca.md)                                                                                          |
| `return_url`    | body        | string  | Não         | Endereço de retorno, quando o pagamento for concluído ou falhar, clique no botão de retorno no endereço. Pode ser um link https ou a rota do aplicativo.                                                                                         |
| `order_type`    | body        | string  | Sim         | Método de pagamento, valor de exemplo: `platform_order` arrecadação da plataforma                                                                                                                                                                |

**Exemplo de parâmetros (Parameters example)**

```json
{
  "app_id": "d549a3ac0e4641f998c6675fc539ba21",
  "mch_id": "12345678",
  "description": "recharge",
  "out_trade_no": "fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb",
  "expire_second": 600,
  "amount": 9,
  "chain": "TRON",
  "currency": "USDT",
  "to_address": "TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w",
  "attach": "anim dolore",
  "locale": "zh_cn",
  "notify_url": "https://xxx/xxx",
  "return_url": "https://xxxx/xxx?id=xxxx",
  "order_type": "platform_order"
}
```

{% hint style="info" %}
DICA (TIP)

O `app_id` pode ser obtido através do painel do comerciante [criando um aplicativo](https://ttpay.io/console/pages/app-list/pay-app).
{% endhint %}

#### Retorno da interface (Interface return)

| Nome          | Tipo    | Descrição                                                     | Descrição                                                                                                                                                                                                                                                                               |
| ------------- | ------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `code`        | integer | [Código de status](/pt-br/codigo-de-erro/codigo-de-status.md) |                                                                                                                                                                                                                                                                                         |
| `msg`         | string  | Descrição do status                                           |                                                                                                                                                                                                                                                                                         |
| `request_id`  | string  | ID da requisição                                              |                                                                                                                                                                                                                                                                                         |
| `data`        | object  | Objeto de dados                                               |                                                                                                                                                                                                                                                                                         |
| `prepay_id`   | string  | ID de pré-pagamento                                           | ID da sessão de transação de pré-pagamento. É usado para chamadas de interface subsequentes, e seu valor é válido pelo tempo do parâmetro `expire_second` definido quando o pedido é criado. Alternativamente, você pode acessar a `payment_url` diretamente para concluir o pagamento. |
| `payment_url` | string  | URL da caixa registradora de pagamento                        | `payment_url` serve para abrir a página intermediária da caixa registradora de pagamento, você pode concluir o pagamento visitando esta url. A `payment_url` é válida pelo tempo do parâmetro `expire_second` definido quando o pedido é criado.                                        |

#### Exemplo de retorno (Return example)

```json
{
    "code": 0,
    "msg": "ok",
    "request_id": "9b9e08ab-48e5-4efa-83e7-97e5e3fe3d0c",
    "data": {
        "prepay_id": "15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2",
        "payment_url": "/pay/order?prepay_id=15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2"
    }
}
```

#### Exemplo de código (Example code)

{% tabs %}
{% tab title="Shell" %}

```sh
curl --location --request POST 'https://api.tokenpay.me/v1/transaction/prepayment' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
   "fmt"
   "strings"
   "net/http"
   "io/ioutil"
)

func main() {

   url := "https://api.tokenpay.me/v1/transaction/prepayment"
   method := "POST"

   payload := strings.NewReader(`<body data here>`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("Authorization", "<Authorization>")
   req.Header.Add("User-Agent", "tokenpay API (https://tokenpay.me)")
   req.Header.Add("Content-Type", "application/json")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := ioutil.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.tokenpay.me/v1/transaction/prepayment',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: tokenpay API (https://tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

<br>
{% endtab %}

{% tab title="Python" %}

```python
import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.me")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'tokenpay API (https://tokenpay.me)',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/transaction/prepayment", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```java
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "<body data here>");
Request request = new Request.Builder()
   .url("https://api.tokenpay.me/v1/transaction/prepayment")
   .method("POST", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}
