Authentication API
Sandbox URL: https://authsandbox.braspag.com.br
Production URL: https://auth.braspag.com.br
| Method | Endpoint | Description |
|---|---|---|
post | /oauth2/token | Creates an access token. |
Notification Configuration
Sandbox URL: https://splitonboardingapisandbox.braspag.com.br
Production URL: https://splitonboardingapi.braspag.com.br
| Method | Endpoint | Description |
|---|---|---|
post | /api/merchant-notification | Configures a webhook to receive notifications |
put | /api/merchant-notification | Updates the notification webhook |
get | /api/merchant-notification/MerchantId | Queries the notification URL |
Onboarding API
Sandbox URL: https://splitonboardingapisandbox.braspag.com.br
Production URL: https://splitonboardingapi.braspag.com.br
| Method | Endpoint | Description |
|---|---|---|
post | /api/merchants | Registers a seller linked to a master in Split de Pagamento. |
get | /api/merchants/merchant-id | Queries seller data and status. |
put | /api/agreements/batch | Updates the same set of fees for all sellers in a batch. |
patch | /api/v2/agreements/batch | Enables Pix payment method in batch for already registered sellers. |
get | /api/v2/agreements/batch/requestId | Queries whether the batch Pix update was successfully applied to each seller. |
post | /api/merchants/MerchantId/bank-account/request-update | Updates 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
| Method | Endpoint | Description |
|---|---|---|
post | /v2/sales |
|
put | /v2/sales/PaymentId/capture | Captures full credit transaction by PaymentId. |
put | /v2/sales/PaymentId/capture?amount=amount | Captures partial credit transaction by PaymentId. |
put | /v2/sales/PaymentId/void |
|
put | /v2/sales/PaymentId/void?amount=amount | Cancels a transaction partially. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Payment | Updates recurring payment details. |
put | /v2/RecurrentPayment/RecurrentPaymentId/NextPaymentDate | Updates the next recurring payment date. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Amount | Updates the recurring payment amount. |
put | /v2/RecurrentPayment/RecurrentPaymentId/RecurrencyDay | Updates the recurring payment day. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Interval | Updates the recurring payment interval. |
put | /v2/RecurrentPayment/RecurrentPaymentId/EndDate | Updates the recurring payment end date. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Customer | Updates shopper details in a recurring payment. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Deactivate | Disables a recurring order. |
put | /v2/RecurrentPayment/RecurrentPaymentId/Reactivate | Re-enables a recurring order. |
Transaction Query API
Sandbox URL: https://apiquerysandbox.braspag.com.br
Production URL: https://apiquery.braspag.com.br
| Method | Endpoint | Description |
|---|---|---|
get | /v2/sales/PaymentId | Queries 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
| Method | Endpoint | Description |
|---|---|---|
post | /1/sales |
|
put | /1/sales/PaymentId/capture | Captures full or partial credit transaction by PaymentId. |
put | /1/sales/PaymentId/void | Cancels a full transaction. |
put | /1/sales/PaymentId/void?amount=amount | Cancels a transaction partially. |
put | /1/RecurrentPayment/RecurrentPaymentId/Payment | Updates recurring payment details. |
put | /1/RecurrentPayment/RecurrentPaymentId/NextPaymentDate | Updates the next recurring payment date. |
put | /1/RecurrentPayment/RecurrentPaymentId/Amount | Updates the recurring payment amount. |
put | /1/RecurrentPayment/RecurrentPaymentId/RecurrencyDay | Updates the recurring payment day. |
put | /1/RecurrentPayment/RecurrentPaymentId/Interval | Updates the recurring payment interval. |
put | /1/RecurrentPayment/RecurrentPaymentId/EndDate | Updates the recurring payment end date. |
put | /1/RecurrentPayment/RecurrentPaymentId/Customer | Updates shopper details in a recurring payment. |
put | /1/RecurrentPayment/RecurrentPaymentId/Deactivate | Disables a recurring order. |
put | /1/RecurrentPayment/RecurrentPaymentId/Reactivate | Re-enables a recurring order. |
Transaction Query API
Sandbox URL: https://apiquerysandbox.cieloecommerce.cielo.com.br/
Production URL: https://apiquery.cieloecommerce.cielo.com.br/
| Method | Endpoint | Description |
|---|---|---|
get | /1/sales/PaymentId | Queries a transaction by PaymentId. |
Post-transaction Split
Sandbox URL: https://splitsandbox.braspag.com.br/
Production URL: https://split.braspag.com.br/
| Method | Endpoint | Description |
|---|---|---|
put | /api/transactions/PaymentId/split | Splits a payment that has already been authorized. |
get | /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/
| Method | Endpoint | Description |
|---|---|---|
post | /api/transactions | Splits a payment created by Cielo LIO |
get | /api/transactions/{Id} | Queries a transaction in the physical environment |
get | /api/v1/pending-creation-transactions | Queries transactions pending creation. |
put | /transactions/{PaymentId}/void?amount={amount} | Voids a partial amount of the transaction. |
put | /transactions/{PaymentId}/void | Voids the total amount of a transaction. |
get | /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
| Method | Endpoint | Description |
|---|---|---|
post | /merchants/merchantId/receivable-anticipations | Requests receivables anticipation for the master or the seller. |
post | /merchants/merchantId/receivable-anticipations/simulation | Simulates anticipation registration for the master. |
get | /merchants/MerchantId/receivable-anticipations/AnticipationId | Queries 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
| Method | Endpoint | Description |
|---|---|---|
get | /v2/electronic-statement | Returns 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
| Method | Endpoint | Description |
|---|---|---|
get | /v1/receivables | Queries URs according to available filters. |
Dispute Handling - Chargeback
Production URL: https://split.braspag.com.br/chargeback/dispute
| Method | Endpoint | Description |
|---|---|---|
get | /dispute | Queries a dispute and returns the defense lifecycle. |
put | /DisputeId/accept | Accepts a chargeback. |
put | /DisputeId/refuse | Refuses and starts the defense of a chargeback. |