FAQ: How to check if Split Payment recipients are correct?

VTEX in your native language 🌎 Portuguese
, ,
1

This topic aims to foster knowledge in our community, mainly regarding the payments module and more specifically about how Receivables Split works.

Before diving into the main subject of this topic, it’s important to share our documentation on the matter:

Also worth noting: what we’ll cover here is the Receivables Split, and not the Transaction Split. Essentially, using one or the other is a Seller’s choice and is made at the time of affiliate registration via the “Use my payment method” flag:

image
image1795×908 72.2 KB

With that, we have two possible scenarios:

  • When the flag is active, a Transaction Split takes place (payment is processed by the Seller);
  • When the flag is not active, a Receivables Split takes place (payment is processed by the Marketplace).

In this topic we’ll focus specifically on how to check the recipients of the Receivables Split. The first step in doing this is to check the transaction logs for an order where the Split occurs — you’ll need to look at the recipients field:

image
image841×479 23.9 KB

Within the recipients field, you’ll be able to check the data for the marketplace and the seller, as highlighted in the image above.

How do I check where this data comes from within my VTEX platform?

For the marketplace, the id is the {{accountName}} of the account on the VTEX platform, and the name, documentType, and document fields sent in the transaction are the same ones registered on the account page:

https://{{accountName}}.myvtex.com/admin/account/

image
image1572×550 52.9 KB

As for the seller data and the commission-related fields, these should match what’s registered in Seller Management. It’s worth noting that filling in these fields is mandatory for the data to be sent correctly in the transaction:

image
image1594×870 60.2 KB

image
image1583×866 90.7 KB

Important notes:

It’s worth emphasizing that payment connections between VTEX and payment gateways are developed by the gateways themselves, acting as VTEX partners. Therefore, all payment processing steps — including the process of creating recipients for Payment Split — are handled within the gateway itself or its integration. The level of visibility VTEX has into this process is limited to what is covered by our Payment Provider Protocol, specifically the information sent and received through our APIs.

It’s important to highlight that VTEX’s only responsibility in the recipient creation process is sending the seller ID, marketplace ID, and the tax ID (CNPJ) of both parties, transmitted at the time of order capture and/or completion (Settlement) in the recipients field. Everything else in this process — whether creating or updating these recipients as configured in the payment gateway — takes place outside the VTEX environment.

If you still have any questions about this topic, feel free to ask here! :smiling_face:

Karina Mota
Field Software Engineer | VTEX

2

Hi Karina, good afternoon

I’m having trouble with the receivables (recipients) information. I managed to generate the transaction with items from both the marketplace and the seller — I can see this in the JSON in the transactions menu (since there are items with sellerId=1 and others with sellerId=leonel530) — however, the recipients field is not being sent at any point.

I just reviewed the registrations for seller management and affiliates, and everything looks correct.

One question I have is about the API that the gateway returns which accepts the split (/vtex/manifest) — do you know what the correct format is? The gateway has already made the change to accept it, returning "allowsSplit": "onCapture" and added another flag called implementsSplit, but I haven’t been able to find a concrete example of the JSON in the documentation.

This was the last format I tested:

{
  "paymentMethods": [    
    {
      "name": "Pix",
      "allowsSplit": "onCapture",
      "implementsSplit": true
    }
  ]
}