.sw-reveal,.sw-reveal[data-reveal=rise]>*,.sw-scene .sw-bar,.sw-scene .sw-spark-area,.sw-scene .sw-spark-dot{opacity:1!important;transform:none!important;filter:none!important}.sw-scene .sw-spark-line{stroke-dashoffset:0!important}html:has(main>[data-theme=dark]:first-child) .sw-header[data-boot]{background:#0e0f11}

Infraestrutura de pagamentos

Entrar Criar conta grátis

Receber

Proteger e dividir

Entregar e medir

Por modelo de negócio

Sem site ou em rede

Gerente de conta exclusivo

Toda empresa tem um gerente de conta, para um suporte individual e humanizado.

Conhecer o gerente de conta

Construir

Operar

Para quem vende

Para quem comprou

Ouvidoria

Não resolveu no atendimento? A Ouvidoria revê o caso, com protocolo.

Abrir na Ouvidoria

Português Dashboard

Issue (or return the open) Pix to settle a negative balance

POST/v1/balance/debt-settlements

Authenticate with the header SelectKey: a sk_test_ key works in the sandbox, a sk_live_ key in production.

Responses

200OK

idstringrequired
Public id of the settlement.
pixobjectrequirednullable
The Pix to pay — only while pending.
+1 field in pix
- qrCodeEmvstringrequirednullable
  Pix copy-and-paste code.
amountintegerrequired
Amount of the Pix, in cents.
objectstringrequired
Always debt_settlement.
Values:debt_settlement
paidAtstringrequirednullable
When it was paid; null until then.
statusstringrequired
pending (Pix open), paid, expired (unpaid) or refunded.
Values:pendingpaidexpiredrefunded
currencystringrequired
Always BRL.
Values:BRL
createdAtstringrequired
When the resource was created (ISO 8601, UTC).
expiresAtstringrequirednullable
When the Pix expires.
paidAmountintegerrequirednullable
What was paid, in cents; null until paid. What exceeds the debt becomes available balance.
owedAtIssuanceintegerrequired
What was owed when the Pix was issued, in cents.
refundedAmountintegerrequired
What was refunded of it, in cents.

401Unauthorized (missing or invalid credential)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

403Forbidden (no permission)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

404Not found

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

409Conflict (idempotency or state)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

422Unprocessable entity (business rule)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

500Internal server error

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

PreviousList debt settlements (the record of each negative-balance payoff)NextList payout wallets

Request

curl -X POST "https://api.selectwin.io/v1/balance/debt-settlements" \
  -H "SelectKey: $SELECTWIN_API_KEY"

Response

{
  "id": "string",
  "pix": {
    "qrCodeEmv": "string"
  },
  "amount": 5000,
  "object": "debt_settlement",
  "paidAt": "string",
  "status": "pending",
  "currency": "BRL",
  "createdAt": "string",
  "expiresAt": "string",
  "paidAmount": 5000,
  "owedAtIssuance": 0,
  "refundedAmount": 5000
}