Marketplace

In order to facilitate marketplace payouts PrimeiroPay offers a range of different options.

Fixed commission

If your commission is fixed in %, you are not required to send the % on a transactional level. PrimeiroPay will configure the % in their backend.

Variable commission

If you are dealing with multiple sellers or your commission is not fixed you are required to send additional parameters to PrimeiroPay in order to initiate a split of payments.

customParameters[SellerAmount]=100
customParameters[CommissionAmount]=10

Format: N10.N2
[0-9]{1,10}(\.[0-9]{2})?

Mixed Basket

If you are dealing with local and international sellers you are required to inform the share of the basket in the transaction

customParameters[SellerAmount]=100
customParameters[CommissionAmount]=10
customParameters[CrossBorderAmount]=50

Format: N10.N2
[0-9]{1,10}(\.[0-9]{2})?

These parameters are required to be send in each step of the transaction, eg if you pre-authorize a transaction, you will need to send these additional in the pre-auth request and in each subsequent request such as Capture following this documentation:

https://developers.primeiropay.com/getting-started/hosted-checkout/copy-and-pay-1

Full sample Request in case connection is via server-to-server:

curl https://test.oppwa.com/v1/payments \
 -d "entityId=8a8294184e736012014e78a17a5615ac" \
 -d "amount=92.00" \
 -d "currency=BRL" \
 -d "paymentBrand=VISA" \
 -d "paymentType=DB" \
 -d "card.number=4200000000000000" \
 -d "card.holder=Jane Jones" \
 -d "card.expiryMonth=05" \
 -d "card.expiryYear=2034" \
 -d "card.cvv=123" \
 -d "customParameters[SellerAmount]=100" \
 -d "customParameters[CommissionAmount]=10" \
 -d "customParameters[CrossBorderAmount]=50" \
 -H "Authorization: Bearer OGE4Mjk0MTg0ZTczNjAxMjAxNGU3OGExN2E2YTE1YjB8ZjJGRUtacXRCUA=="

Reporting

PrimeiroPay provides a marketplace report illustrating the split of payments.

A sample report can be downloaded here.

Gross Credit: Total face value of the authorized transaction. This is the amount in local currency that was authorized on the card of your shopper

Net Credit: Total amount that is being sent abroad in case the basket contains an international transaction. If the basket does not contain an international transaction the value will be zero

Seller Net Credit: Total amount of this transaction that is available for settlement to the local seller.

Seller Net Debit: In case of refunds or chargebacks this amount will be debited from the available balance for settlements to Sellers.

Please note that the CommissionAmount is currently not displayed in the report but it will count towards the available balance for payouts.

PrimeiroPay performs Payouts via API requests sent by the merchant.

Please refer to the respective Payout Guide.