Resource list

Authentication API

Sandbox URL: https://authsandbox.braspag.com.br

Production URL: https://auth.braspag.com.br

MethodEndpointDescription
/oauth2/tokenCreates an access token.

Notification Configuration

Sandbox URL: https://splitonboardingapisandbox.braspag.com.br

Production URL: https://splitonboardingapi.braspag.com.br

MethodEndpointDescription
/api/merchant-notificationConfigures a webhook to receive notifications
/api/merchant-notificationUpdates the notification webhook
/api/merchant-notification/MerchantIdQueries the notification URL

Onboarding API

Sandbox URL: https://splitonboardingapisandbox.braspag.com.br

Production URL: https://splitonboardingapi.braspag.com.br

MethodEndpointDescription
/api/merchantsRegisters a seller linked to a master in Split de Pagamento.
/api/merchants/merchant-idQueries seller data and status.
/api/agreements/batchUpdates the same set of fees for all sellers in a batch.
/api/v2/agreements/batchEnables Pix payment method in batch for already registered sellers.
/api/v2/agreements/batch/requestIdQueries whether the batch Pix update was successfully applied to each seller.
/api/merchants/MerchantId/bank-account/request-updateUpdates bank account details for a specific seller.

Split de Pagamento via Gateway de Pagamento

Transactional API

Sandbox URL: https://apisandbox.braspag.com.br

Production URL: https://api.braspag.com.br

MethodEndpointDescription
/v2/sales
  • Creates payments (for each payment method)
  • Creates recurring payments
  • Saves cards during authorization
  • Creates payments with Antifraude
/v2/sales/PaymentId/captureCaptures full credit transaction by PaymentId.
/v2/sales/PaymentId/capture?amount=amountCaptures partial credit transaction by PaymentId.
/v2/sales/PaymentId/void
  • Cancels a full transaction
  • Requests full or partial Pix refund.
/v2/sales/PaymentId/void?amount=amountCancels a transaction partially.
/v2/RecurrentPayment/RecurrentPaymentId/PaymentUpdates recurring payment details.
/v2/RecurrentPayment/RecurrentPaymentId/NextPaymentDateUpdates the next recurring payment date.
/v2/RecurrentPayment/RecurrentPaymentId/AmountUpdates the recurring payment amount.
/v2/RecurrentPayment/RecurrentPaymentId/RecurrencyDayUpdates the recurring payment day.
/v2/RecurrentPayment/RecurrentPaymentId/IntervalUpdates the recurring payment interval.
/v2/RecurrentPayment/RecurrentPaymentId/EndDateUpdates the recurring payment end date.
/v2/RecurrentPayment/RecurrentPaymentId/CustomerUpdates shopper details in a recurring payment.
/v2/RecurrentPayment/RecurrentPaymentId/DeactivateDisables a recurring order.
/v2/RecurrentPayment/RecurrentPaymentId/ReactivateRe-enables a recurring order.

Transaction Query API

Sandbox URL: https://apiquerysandbox.braspag.com.br

Production URL: https://apiquery.braspag.com.br

MethodEndpointDescription
/v2/sales/PaymentIdQueries a transaction by PaymentId.

Split de Pagamento via Cielo E-commerce API

Transactional API

Sandbox URL: https://apisandbox.cieloecommerce.cielo.com.br/1/sales

Production URL: https://api.cieloecommerce.cielo.com.br/1/sales

MethodEndpointDescription
/1/sales
  • Creates payments (for each payment method)
    - Creates recurring payments
    - Saves cards during authorization
    - Creates payments with Antifraude
/1/sales/PaymentId/captureCaptures full or partial credit transaction by PaymentId.
/1/sales/PaymentId/voidCancels a full transaction.
/1/sales/PaymentId/void?amount=amountCancels a transaction partially.
/1/RecurrentPayment/RecurrentPaymentId/PaymentUpdates recurring payment details.
/1/RecurrentPayment/RecurrentPaymentId/NextPaymentDateUpdates the next recurring payment date.
/1/RecurrentPayment/RecurrentPaymentId/AmountUpdates the recurring payment amount.
/1/RecurrentPayment/RecurrentPaymentId/RecurrencyDayUpdates the recurring payment day.
/1/RecurrentPayment/RecurrentPaymentId/IntervalUpdates the recurring payment interval.
/1/RecurrentPayment/RecurrentPaymentId/EndDateUpdates the recurring payment end date.
/1/RecurrentPayment/RecurrentPaymentId/CustomerUpdates shopper details in a recurring payment.
/1/RecurrentPayment/RecurrentPaymentId/DeactivateDisables a recurring order.
/1/RecurrentPayment/RecurrentPaymentId/ReactivateRe-enables a recurring order.

Transaction Query API

Sandbox URL: https://apiquerysandbox.cieloecommerce.cielo.com.br/

Production URL: https://apiquery.cieloecommerce.cielo.com.br/

MethodEndpointDescription
/1/sales/PaymentIdQueries a transaction by PaymentId.

Post-transaction Split

Sandbox URL: https://splitsandbox.braspag.com.br/

Production URL: https://split.braspag.com.br/

MethodEndpointDescription
/api/transactions/PaymentId/splitSplits a payment that has already been authorized.
/api/transactions/PaymentId/split?masterRateDiscountType=Sale`Configures rates between master and seller for an authorized transaction.

Split de Pagamento on POS Terminal

Production URL: https://split.braspag.com.br/

MethodEndpointDescription
/api/transactionsSplits a payment created by Cielo LIO
/api/transactions/{Id}Queries a transaction in the physical environment
/api/v1/pending-creation-transactionsQueries transactions pending creation.
/transactions/{PaymentId}/void?amount={amount}Voids a partial amount of the transaction.
/transactions/{PaymentId}/voidVoids the total amount of a transaction.
/transactions/{TransactionId}/voids/{voidId}Queries the status of a partial or total void request.

Receivables Anticipation

Production URL: https://splitsandbox.braspag.com.br/anticipation-api

MethodEndpointDescription
/merchants/merchantId/receivable-anticipationsRequests receivables anticipation for the master or the seller.
/merchants/merchantId/receivable-anticipations/simulationSimulates anticipation registration for the master.
/merchants/MerchantId/receivable-anticipations/AnticipationIdQueries an anticipation by its ID and the merchant ID.

Electronic Statement

Sandbox URL: https://splitsandbox.braspag.com.br/schedule-api

Production URL: https://split.braspag.com.br/schedule-api

MethodEndpointDescription
/v2/electronic-statementReturns the electronic statement.

Reconciliation in Split de Pagamento

Sandbox URL: https://splitsandbox.braspag.com.br/schedule-api

Production URL: https://split.braspag.com.br/schedule-api

MethodEndpointDescription
/v1/receivablesQueries URs according to available filters.

Dispute Handling - Chargeback

Production URL: https://split.braspag.com.br/chargeback/dispute

MethodEndpointDescription
/disputeQueries a dispute and returns the defense lifecycle.
/DisputeId/acceptAccepts a chargeback.
/DisputeId/refuseRefuses and starts the defense of a chargeback.