PaystationdocsPaystation

Retrieve one of your offers: published with a public key, any status with a secret key ​

GET /v1/offers/{id}

Retrieve one of your offers: published with a public key, any status with a secret key

GET/v1/offers/{id}

Autenticação

  • Chave públicapk_…, pode ir para o navegador
  • Chave secretask_…, só no seu servidor

Envie a chave no cabeçalho Authorization: Bearer <chave>.

Parâmetros

  • idstring · path (uuid)obrigatório

Resposta

200OK

  • idstring (uuid)obrigatório
  • offer_idstringpode ser nullobrigatório
  • titlestringpode ser nullobrigatório
  • descriptionstringpode ser nullobrigatório
  • offer_typestringobrigatório
  • priceintegerpode ser nullobrigatório

    Integer cents: R$ 99,90 is `9990`.

  • payment_methodsarray of stringobrigatório

    Valores: cardpixboleto

  • document_typesarray of stringobrigatório

    `cpf` is always accepted.

  • subscriptionobjectpode ser nullobrigatório

    Only for `offer_type: subscription`. `GET /v1/offers/{id}/checkout` answers what the charge uses.

    Mostrar campos de subscription
    • cyclesintegerpode ser nullobrigatório

      Renewals after the first payment: the plan has `cycles + 1` payments. `null` or below 1: the offer cannot be sold.

    • amountintegerpode ser nullobrigatório

      Integer cents charged per renewal.

  • statusstringpode ser nullobrigatório

    `published` is sellable. A secret key also reads its offers in other statuses (`archived`, `draft`); a public key only `published` ones.

Erros

400The request path could not be decoded (`malformed_path`).
401Missing or invalid key.
404Not found, not yours, or not a well-formed id.
429Rate limited.
500Unexpected error, or `api_unavailable`.

Todo erro vem no mesmo envelope: error.type, error.code, error.message e error.request_id, também devolvido no cabeçalho X-Request-Id.