Follow the question structure recommended by Dev Bot before submitting your integration questions.
Create a new sale
POST
https://evo-integracao-api.w12app.com.br/api/v2/sales
๐ API Reference/Sales
Create a New Sale
Description
๐ The permission in EVO that grants access to this endpoint is Sales - Edit.
NOTE. Available for use with branch access key and also with General ADM access key.
Additional Instructions
๐ง Attention! The totalInstallmentsof thecardDataobject is valid only for payment type 1 (Credit Card).Include in the request header the field culturewith the valuept-BR. This parameter informs the API that responses should be returned in Brazilian Portuguese, ensuring that texts such as messages, descriptions, and statuses come in pt-BR.
curl --location --request POST 'https://evo-integracao-api.w12app.com.br/api/v2/sales' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Basic Og==' \
--header 'culture: pt-BR' \ ๐๐๐
--data-raw '{
"idBranch": 0,
"idBranchToken": "string",
"idMembership": 0,
...
}'๐จ Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idBranch | int32 | No | Identifier of the branch where the sale was made. If the system is multi-branch, fill in with the ID of the specific unit. Otherwise, it will be the value generated by the token. |
idBranchToken | string | No | Branch token, used to identify the unit when the system is multi-branch. |
idMembership | int32 | No | Identifier of the membership contract acquired (if applicable). |
membershipValue | double | No | Final value of the contract. |
idService | int32 | No | Identifier of the service or trial class acquired. |
serviceValue | double | No | Final value of the service. |
idProduct | int32 | No | ID of the product related to the sale. |
productValue | double | No | Value of the product related to the sale. |
productAmount | int32 | No | Quantity of the product related to the sale. |
memberData | object | Yes | Data of the member (if the customer is already a member). Contains the field idMember. |
cardData | object | No | Credit card data, if the transaction is made via card. |
idProspect | int32 | No | Identifier of the prospect acquiring the service. |
idProspectToken | string | No | Token of the prospect, used to validate the transaction and ensure that the prospect is converted into a member after the purchase. |
idMemberToken | string | No | Token of the member (if it is a registered customer). |
voucher | string | No | Discount voucher code, if the customer uses one to obtain a discount. |
idVoucherToken | int32 | No | Token of the discount voucher (if applicable). |
idCardMember | int32 | No | Identifier of the member card (if applicable). |
idMemberCardToken | string | No | Token of the member card (if applicable). |
membershipStart | string | No | Start date of the contract / membership. |
totalInstallments | int32 | Yes | Number of installments for payment in installments. For full payment, it will be 0 or 1. |
payment | int32 | Yes | Payment type: 5 for installment (with zero value for trial classes) and 6 for full payment. |
sessionId | string | No | Session identifier, used to track the transaction during the sale process. |
๐ ๒ Structure of the memberData Object
| Parameter | Type | Required | Description |
|---|---|---|---|
idMember | int32 | Yes | Unique identifier of the member. |
document | string | No | Identification document of the member, such as CPF or CNPJ. |
zipCode | string | No | Postal code (CEP) of the member's address. |
address | string | No | Address of the member. |
number | string | No | Number of the member's address. |
complement | string | No | Address complement of the member, such as apartment or block. |
neighborhood | string | No | Neighborhood of the member. |
city | string | No | City of the member. |
idState | int32 | No | Identifier of the state where the member resides. |
๐งฉ Structure of the cardData Object
| Parameter | Type | Required | Description |
|---|---|---|---|
token | string | No | Unique identifier for the card. |
temporaryToken | string | No | Temporary token associated with the card, if applicable. |
branchToken | string | No | Branch token to identify a unit when the system is multi-branch. |
totalInstallments | int32 | No | Total number of installments in the payment, applicable in installment transactions. |
truncatedCardNumber | string | No | Truncated card number, showing only the last 4 real numbers for security. (****1234) |
brand | string | No | Brand of the card (e.g., Visa, MasterCard, etc.). |
cardHolderName | string | No | Name of the cardholder. |
cardExpirationYear | int32 | No | Expiration year of the card. |
cardExpirationMonth | int32 | No | Expiration month of the card. |
๐ท payment Enum
| Code | Payment Type | Description |
|---|---|---|
| null | LinkCheckout | If the value of payment is null, it is treated as LinkCheckout. |
| 1 | Credit Card | Payment made with a credit card. (It is necessary to generate the card token using Evo Pay) |
| 2 | Boleto | Payment made via bank slip. |
| 3 | Sale Credits | Payment made with sales credits. |
| 4 | Transfer | Payment made by bank transfer. |
| 5 | ZeroValue | Used for transactions with zero value, such as trial classes. |
| 6 | LinkCheckout | Payment made via checkout link (generated externally). |
| 7 | Pix | Payment made via Pix. |
| 13 | Transferรชncia | Payment made via bank transfer. |
| 14 | Cash | Payment made via cash. |
| 15 | GiftCard | Payment made via gift card. |
Request
Query Params
Body Params
application/json-patch+json
Request Code Samples
Responses
Modified atย 2026-07-15 16:28:38