# API Request Structure Definition

# 1. Communication Protocol

:::highlight yellow 💡
All API calls must comply with the following rules:
:::

|Type|Description|
| :---: | :---: |
|TLS Version|To ensure transaction security, use HTTPS with TLS version 1.2 or above. See TLS Upgrade Notes for details.
|Method|POST||
|Content-Type|application/json|
|Character Encoding|UTF-8|
|Signature Algorithm|SHA512|
|Signature Requirement|See [APIs Signature](https://doc.vamospago.com/apis-signature-9218255m0.md) for detailed instructions.
|
|Processed Logic|Evaluate in the following order: protocol-level response → business-level response → transaction status.|

# 2. Message Structure

<Tabs>
  <Tab title="HTTP Request">
   ```JS
POST /gateway/base/biz HTTP/1.1
method: pay
signType: SHA512
serviceName: api.pay
mchId: 1416010331032883200
timestamp: 1631671670
sign: 9d7bb11c4faf54523b24bd65fa9e104e0b926e7e7932b5c99ba4b1d017f5aed8b5190bedb6b149f745ff768a2faaee78485207943004d2575380d3e3cc00c718
Content-Type: application/json
 
{
    "amount": "5.00",
    "callbackUrl": "http://127.0.0.1:8082/callback",
    "redirectUrl": "http://www.baidu.com",
    "currency": "BRL",
    "dynamic": "1",
    "email": "muazpe@gmail.com",
    "firstname": "Murilo Azeredo Pereira",
    "lastname": "your lasttname",
    "mchOrderId": "1232434323233463411fv34",
    "phone": "+5511967164793",
    "docNumber": "14868845802",
    "docType": "CPF",
    "productinfo": "your pro simple desc"
}
```
  </Tab>
  <Tab title="HTTP Response">
```JS
HTTP/1.1 200 OK
Date: Thu, 14 Aug 2025 11:24:38 GMT
Content-Type: application/json;charset=UTF-8
 
{
    "resultCode": "000000",
    "errorCode": "000000",
    "errorMsg": null,
    "data": [
        {
            "qrCodeString": "00020126880014br.gov.bcb.pix2566pix.orusprime.com.br/qr/v3/at/3c89cf4b-f82a-4f48-8d2f-079c4df6cacf5204000053039865802BR5918ORBION_GAMING_LTDA6004BODO62070503***6304D29B",
            "orderId": "202508141955953705696706560",
            "currency": "BRL",
            "checkoutUrl": "https://xx.com/gateway/base/pay/adedebfa1287f741369540e2798dbbcc1cf3840c78eb30525ed1f51a979b53a0f4daa1251ac1e8f893076128c8d1dc6909ecce9376fea35cc0e242989e84c8cd"
        }
    ],
    "success": true
}
```
  </Tab>
</Tabs>

:::warning[]
resultCode only indicates whether the request was processed successfully; it does not reflect the business document status (e.g., payment or refund result).
To determine the actual transaction result, refer to the Webhook callback message or the status field in the query API response.

* For order status descriptions, see [Order Status](https://doc.vamospago.com/order-status-9218258m0.md)
* For error code details, see [APIs error code](https://doc.vamospago.com/apis-error-code-list-9218259m0.md)
:::

# 3. APIs Gateway URL
:::highlight green 📌
We only provide production environments — all functionalities can be verified directly in production.
:::
|Region|API URL|
| --- | --- |
| **North America/South America**|[https://apis.vamospago.com/gateway/base/biz](https://apis.vamospago.com/gateway/base/biz) |
| **Asia/Mid East/Europe/Africa**|[https://api.vamospago.com/gateway/base/biz](https://api.vamospago.com/gateway/base/biz) |

# 4 OMS Management Dashboard URL
|Region|Dashboard URL|
| --- | --- |
| **North America/South America**|[https://latin.vamospago.com/login](https://latin.m2square.xyz/login) |
| **Asia/Mid East/Europe/Africa**|[https://asia.vamospago.com/login](https://asia.vamospago.com/login) |

# 5 Interface Parameter Rules
|Required|	Description|
| --- | --- |
|M|Mandatory|
|O|Optional|
|C|Conditional (Mandatory under specific conditions)|