Search charge

GET 
/paymentlink/:payment_link_id

Search charge

Request

Path Parameters

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

Header Parameters

Authorization stringrequired
Authentication Token.
Example: Bearer <token>

Responses

200

Charge found.

application/json

Schema

Schema

uuid stringrequired

Billing identifier (internal).

paymentLinkId stringrequired

Billing identifier (external/origin_id).

createdAt stringrequired

Date the charge was created.

deletedAt string

Billing inactivation date.

details

object

required

Billing details.

channel stringrequired

Billing source channel.

orderNumber stringnullable

Payment order identifier.

captureSolution stringrequired

Collection capture solution.

termId stringnullable

Terminal identifier.

charge

object

required

Specific billing details.

name stringnullable

Charge name.

status stringrequired

Possible values: [active, expired, deleted]

Charge status.

amount integernullable

Charge amount.

deliveryAmount integerrequired

Charge delivery amount.

productAmount integerrequired

Charge product amount.

totalSales integerrequired

Number of billing payments

expiration stringnullable

Billing expiration date.

qrcode stringnullable

qrcode generated for payment.

links

required

Charge links.

checkout stringnullable

Charge checkout link.

share stringrequired

Charge share link.

redirectURL stringnullable

URL redirect

payment

required

Billing payment details.

methods string[]required

Charge payments methods

arrangements string[]required

Charge payment arrangements.

cardMaxInstallments integernullable

Maximum number of installments on the card.

pixKey stringnullable

Pix key.

pixTxid stringnullable

Identifier 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

Charge not found

application/json

Schema

Schema

Example (from schema)

{}

Example

{}

Loading...