# Checkout Page (General)
## Payin by using Pagsmile checkout page
`POST` `https://gateway-test.pagsmile.com/trade/create`
This endpoint allows you to submit a payin by using Pagsmile checkout page
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------------------------------ |
| Content-Type\* | string | application/json; chartset=UTF-8 |
| Authorization\* | string | Basic Base($app\_*id:$security\_*key) |
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| app\_id\* | string |
created app's id at dashboard
- Max. 32 chars -
|
| method | string | Add this object to show only the selected method. For instance, “method”: “PIX” will only show the PIX method. To show all the methods do not add this object in the request body. Check [here](/payin/data/payment-method.md) for all methods |
| out\_trade\_no\* | string |
ID given by the merchant in their system - Max. 64 chars -
|
| notify\_url\* | string | Where Pagsmile will send notification to |
| timestamp\* | string |
order currency - Max. 3 chars - Check here for all methods.
|
| content\* | string |
payment reason detail or item detail. This will be shown on the bank bill.
- Max. 255 chars -
|
| buyer\_id\* | string | merchant user's id |
| channel | string | only use when method = Wallet |
| trade\_type\* | string | fixed value: WEB |
| return\_url | sring | web redirect url when payment is finish |
| timeout\_express | string |
m(minutes), h(hours), d(days), c(always end in current day).
Used to control the expiration time of submitting an order (from initial to processing). (90m in default, max 15d)
|
| customer.name | string |
User's name
- Will be pre-filled on the checkout page -
|
| customer.phone | string |
User's phone
- Will be pre-filled on the checkout page -
|
| customer.email | string |
User's email
- Will be pre-filled on the checkout page -
|
| customer.identify.number | string |
User's identification number
- Will be pre-filled on the checkout page -
|
| customer.identify.type | string |
User's identification type
- Will be pre-filled on the checkout page -
|
| address.zip\_code | string |
zip code
- Will be pre-filled on the checkout page -
|
| regions | array |
regions of the payment. Required if using Global App. The format is ISO 3166-1 alpha-3 - ARG, BRA, etc. Check here -
|
{% tabs %}
{% tab title="200 submit successfully" %}
```
{
"code": "10000",
"msg": "Success",
"trade_no": "2022010110293900083",
"out_trade_no": "202201010354003",
"web_url": "http://checkout-testv2.pagsmile.com?prepay_id=123456",
"prepay_id":"123456"
}
```
{% endtab %}
{% tab title="400 duplicate out\_trade\_no" %}
```
{
"code": "40002",
"msg": "Business Failed",
"sub_code": "duplicate-out_trade_no",
"sub_msg": "out_trade_no is duplicate"
}
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
Check [here](/payin/data/payment-method.md) for supported methods.
* If not passing the parameter "method" or pass "method": "", all enabled methods will be shown to the user on the checkout page.
* If passing "method": "PIX", only PIX will be shown to the user on the checkout page.
{% endhint %}
## Example
```
curl --location --request POST 'https://gateway-test.pagsmile.com/trade/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
"charset": "UTF-8",
* "app_id": "162************38",
* "out_trade_no": "202201010354002",
* "order_currency": "BRL",
* "order_amount": "12.01",
* "subject": "item name",
* "content": "item description",
* "trade_type": "WEB",
"timeout_express": "1d",
* "timestamp": "2022-01-01 03:54:01",
* "notify_url": "http://merchant/callback/success",
* "buyer_id": "buyer_0101_0001",
"customer": {
"identify": {
"type": "CPF",
"number": "50284414727"
},
"name": "Test User Name",
"email": "test@pagsmile.com"
},
"regions": ["BRA"], //Support multiple regions. For example "regions": ["BRA","COL","MEX"]
"address": {
"zip_code": "38082365"
}
}'
```
{% hint style="danger" %}
Return*url is not required in the request parameters. However if needed, you can overwrite it by appending the return\_*url after the web\_url when redirect.
`http://checkout.pagsmile.com?prepay_id={$prepay_id}`
↓↓↓
`http://checkout.pagsmile.com?prepay_id={$prepay_id}&return_url=encodeURIComponent({$return_url})`
{% endhint %}
{% hint style="info" %}
Note: **162\*\*\*\*\*\*\*\*\*\*\*\*38** is pagsmile's test app id for sandbox, and **MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==** is authorization token associated with the test app id.
{% endhint %}
{% hint style="danger" %}
Please use your own **app\_id** and generate your own **authorization token** when testing.
{% endhint %}
The Checkout page without specifying "method"
The Checkout page with specifying "method":"PIX" (as an exmaple)
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.pagsmile.com/payin/checkout-page/general.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.