Conduct online sales via API

The sales API allows you to register transactions involving prospects (potential customers) and members (registered customers), covering the acquisition of services, membership contracts, and trial classes. It was developed to provide flexibility and accuracy in commercial control, integrating processes such as applying discounts, defining payment methods (lump sum or installment), using vouchers, and linking to the branch responsible for the sale.

Each type of sale has a specific flow, determined by the customer's status (prospect or member) and the type of product acquired (service or contract). This guide presents the main use cases, with practical examples and payload structures, to facilitate correct integration with the API.

Proper use of the mandatory and optional fields ensures that the information is processed correctly by the system, optimizing the registration of sales and the conversion of prospects into active members.

Use Cases

Case 1: Prospect + Service

Description
A prospect (potential customer) makes a purchase of a specific service. The system registers the prospect and the service acquired.

Mandatory Fields:

idProspect: Identification of the prospect.

idService: Identification of the acquired service.

payment: Type of payment (1 for lump sum, 5 for installment).

idMember: 0 (indicates that they are not a member yet).

Example:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 481,
  "payment": 5
}

Flow:

Prospect identified by idProspect.

Service associated by idService.

Payment registered in payment.

If installment, use totalInstallments.

The serviceValue field can be adjusted.

Case 2: Member + Service

Description:
A registered member makes a purchase of a service. The system associates the service with the member.

Mandatory Fields:

idMember: Identification of the member.

idService: Identification of the acquired service.

payment: Type of payment.

Example:

{
  "memberData": {
    "idMember": 12345
  },
  "idService": 481,
  "payment": 6
}

Flow:

Member identified by idMember.

Service identified by idService.

Payment registered.

Installment with totalInstallments, if applicable.

serviceValue adjustable.

Case 3: Contract Sale for Prospect

Description:
A prospect acquires a membership contract. The system registers the sale for the prospect.

Mandatory Fields:

idProspect: Identification of the prospect.

idMembership: ID of the acquired contract.

payment: Type of payment.

idMember: 0 (not a member yet).

Example:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idMembership": 789,
  "payment": 6
}

Flow:

Prospect identified by idProspect.

Contract identified by idMembership.

Payment type informed.

Installment with totalInstallments, if necessary.

Adjustable value (serviceValue), possible use of voucher.

After purchase, prospect becomes a member (idMember assigned).

Case 4: Contract Sale for Member

Description:
A member acquires a membership contract. The system associates the sale with the member.

Mandatory Fields:

idMember: Identification of the member.

idMembership: ID of the contract.

payment: Type of payment.

Example:

{
  "memberData": {
    "idMember": 12345
  },
  "idMembership": 789,
  "payment": 6
}

Case 5: Trial Class for Prospect

Description:
The prospect wishes to enroll in a trial class, where the value is set to zero to promote the service and generate interest. The transaction is registered with a payment value of zero, but it is treated as a valid transaction in the system, with the payment set to 5 (indicating that it is a service, even without a payment value).

Mandatory Fields:

idProspect: Identification of the prospect.

idService: ID of the trial class.

payment: 5 (indicates free service).

idMember: 0.

Optional Fields:

idBranch: If there are multiple branches.

Example:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 101,
  "payment": 5
}

Flow:

Prospect enrolls (field idProspect).

Trial class identified by idService.

Payment marked as 5 (zero).

Sale registered with idMember: 0.

Additional Resources

1. Adding Installments

If the sale is in installments, fill in the totalInstallments field with the number of installments.
For example, for 12 installments:

"totalInstallments": 12

If it is a lump sum payment, the field can be:

"totalInstallments": 0

"totalInstallments": 1

2. Adding Discount Voucher

If the customer uses a voucher to obtain a discount, enter the voucher code in the voucher field.
The system will automatically apply the discount to the contract or service value.

"voucher": "MEUDESCONTO123"

3. Changing the Service Value (Only for services)

The serviceValue field can be adjusted if there is any discount, modification, or other change in the service value.
If not provided, the system will use the registered default value.

"serviceValue": 199.90

4. Choosing the Branch of the Sale (Multi-Branch Token)

If the system operates with multiple branches, use the idBranch field to indicate the branch responsible for the sale.
If the authentication token is multi-branch:

If idBranch is provided, the sale will be registered in the corresponding branch.

If idBranch is not provided, the system will use the idBranch value from the token itself.

"idBranch": 12

I want to integrate with EVO PAY

Conduct online sales via API

Use Cases#

Case 1: Prospect + Service#

Case 2: Member + Service#

Case 3: Contract Sale for Prospect#

Case 4: Contract Sale for Member#

Case 5: Trial Class for Prospect#

Additional Resources#

1. Adding Installments#

2. Adding Discount Voucher#

3. Changing the Service Value (Only for services)#

4. Choosing the Branch of the Sale (Multi-Branch Token)#

Use Cases

Case 1: Prospect + Service

Case 2: Member + Service

Case 3: Contract Sale for Prospect

Case 4: Contract Sale for Member

Case 5: Trial Class for Prospect

Additional Resources

1. Adding Installments

2. Adding Discount Voucher

3. Changing the Service Value (Only for services)

4. Choosing the Branch of the Sale (Multi-Branch Token)