PaystationdocsPaystation

List your published offers, newest first ​

GET /v1/offers

List your published offers, newest first

GET/v1/offers

Autenticação

  • Chave secretask_…, só no seu servidor

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

Parâmetros

  • limitstring · query

    1 to 100; defaults to 20.

  • starting_afterstring · query (uuid)

    The last `id` of the previous page.

Resposta

200OK

  • dataarray of objectobrigatório
    Mostrar campos de data
    • 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.

  • has_morebooleanobrigatório

Erros

401Missing or invalid key, or a public key (`secret_key_required`).
422A query parameter is invalid (`invalid_param`, `unknown_parameter`).
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.