v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Listar cupons

get/coupons

Query parameters

offsetinteger

Número da página que deseja consultar. Deve ser um valor igual ou maior que zero, representando o deslocamento da página desejada.

limitinteger

Tamanho da página desejada. Este valor determina a quantidade de resultados a serem retornados em uma única consulta.

reference_idstring

Identificador único do cupom na sua aplicação importada para o sistema PagBank (Max 65 caracteres).

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

Response

200

Example response

{
  "result_set": {
    "total": 1
  },
  "coupons": [
    {
      "id": "COUP_B3FF3127-63AC-4049-9E8B-4FFD6A0733E7",
      "name": "SandboxCoupon",
      "description": "Sandbox Coupom",
      "discount": {
        "value": "10",
        "type": "AMOUNT"
      },
      "status": "ACTIVE",
      "duration": {
        "type": "ONCE"
      },
      "redemption_limit": 10,
      "exp_at": "2022-12-20",
      "created_at": "2022-10-25T15:24:04.389-03:00",
      "updated_at": "2022-10-25T15:24:04.389-03:00",
      "links": [
        {
          "rel": "SELF",
          "href": "http://sandbox.api.assinaturas.pagseguro.com/coupons/COUP_B3FF3127-63AC-4049-9E8B-4FFD6A0733E7",
          "media": "application/json",
          "type": "GET"
        }
      ]
    }
  ]
}