Busca de cobrança via API

GET 
/paymentlink/:payment_link_id

Busca de cobrança via API

Request

Path Parameters

payment_link_id stringrequired
Example: 3c567a2c-f800-351d-9b43-256d45949e89

Header Parameters

Authorization stringrequired
Token de autenticação.
Example: Bearer <token>

Responses

200

Cobrança encontrada.

application/json

Schema

Schema

uuid stringrequired

Identificador da cobrança (interno).

paymentLinkId stringrequired

Identificador da cobrança (externo/origin_id).

createdAt stringrequired

Data de criação da cobrança.

deletedAt string

Data de inativação da cobrança.

details

object

required

Detalhes referentes a cobrança.

channel stringrequired

Canal de origem da cobrança.

orderNumber stringnullable

Identificador da ordem de pagamento.

captureSolution stringrequired

Solução de captura da cobrança.

termId stringnullable

Identificador do terminal.

charge

object

required

Detalhes específicos da cobrança.

name stringnullable

Nome de cadastro da cobrança.

status stringrequired

Possible values: [active, expired, deleted]

Status da cobrança.

amount integernullable

Valor da cobrança.

deliveryAmount integerrequired

Valor do frete da cobrança.

productAmount integerrequired

Valor do produto da cobrança.

totalSales integerrequired

Quantidade de pagamentos da cobrança.

expiration stringnullable

Data de expiração da cobrança.

qrcode stringnullable

qrcode gerado para pagamento.

links

required

Links da cobrança.

checkout stringnullable

Link de checkout da cobrança.

share stringrequired

Link de compartilhamento da cobrança.

redirectURL stringnullable

URL de redirecionamento

payment

required

Dados de pagamento da cobrança.

methods string[]required

Métodos de pagamento da cobrança.

arrangements string[]required

Arranjos de pagamento da cobrança.

cardMaxInstallments integernullable

Número máximo de parcelas no cartão.

pixKey stringnullable

Chave pix.

pixTxid stringnullable

Identificador pix.

Example (from schema)

{
  "uuid": "6c2e8b61-7afd-3de1-95b6-7206d6a30bb4",
  "paymentLinkId": "3c567a2c-f800-351d-9b43-256d45949e89",
  "createdAt": "2025-01-21 13:44:47",
  "deletedAt": "2025-01-21 13:44:47",
  "details": {
    "channel": "API",
    "orderNumber": "298643",
    "captureSolution": "BIZ_A_FECHADO",
    "termId": "4873",
    "charge": {
      "name": "Nome cobrança",
      "status": "active",
      "amount": 1550,
      "deliveryAmount": 150,
      "productAmount": 50,
      "totalSales": 20,
      "expiration": "2025-01-27 13:44:47",
      "qrcode": "00020126830014BR.GOV.BCB.PIX...",
      "links": {
        "checkout": "https://link.checkout.com/p/1688060808649dc38881cdc",
        "share": "https://link.share.com/p/1688060808649dc38881cdc",
        "redirectURL": "https://translate.google.com.br/?sl=auto&tl=pt&op=translate"
      }
    },
    "payment": {
      "methods": [
        "BRCODE",
        "CREDIT_CARD"
      ],
      "arrangements": [
        "PIX",
        "PICPAY"
      ],
      "cardMaxInstallments": 5,
      "pixKey": "ad152f22-1773-3b74-ac27-c2e9a56061c0",
      "pixTxid": "08883586-56d9-3c48-bd06-3b4c724a6209"
    }
  }
}

Example

{
  "uuid": "5f475570-d740-3165-be4f-096eede849cb",
  "paymentLinkId": "84f789cb-0d58-321b-b1e5-0586ffa2b861",
  "createdAt": "2025-01-24 19:12:07",
  "deletedAt": null,
  "details": {
    "channel": "app_pj",
    "orderNumber": "Magni non.",
    "captureSolution": "BIZ_A_FECHADO",
    "termId": "98",
    "charge": {
      "name": "Nome aleatorio 31",
      "status": "active",
      "amount": 49,
      "deliveryAmount": 0,
      "productAmount": null,
      "totalSales": 0,
      "expiration": null,
      "qrcode": "http://www.west.com/quo-quasi-explicabo-ipsam-culpa-id-quas.html",
      "links": {
        "checkout": "http://lang.com/ea-ut-nobis-harum-in-qui-similique.html",
        "share": "https://picpay.local/share/84f789cb-0d58-321b-b1e5-0586ffa2b861"
      }
    },
    "payment": {
      "methods": [
        "BRCODE",
        "CREDIT_CARD"
      ],
      "arrangements": [
        "PIX"
      ],
      "cardMaxInstallments": 9,
      "pixKey": "d65b1848-d656-3288-b74b-8e6a79662dc4",
      "pixTxid": "2254681b-f473-3eb2-8560-98d4b64e5fea"
    }
  }
}

404

Cobrança não encontrada

application/json

Schema

Schema

Example (from schema)

{}

Example

{}

Loading...