PaystationdocsPaystation

Find a pending pix or boleto the buyer can resume ​

POST /v1/reusable-payment/search

Find a pending pix or boleto the buyer can resume

POST/v1/reusable-payment/search

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>.

Corpo da requisição

  • documentstringobrigatório
  • offer_idstring (uuid)obrigatório
  • methodstringobrigatório

    Valores: pixboleto

Resposta

200OK

  • objectstringobrigatório

    Valores: charge

  • statusstringobrigatório

    Valores: processingpendingpaidrefund_pendingrefundedchargedbackdeclined

  • amountintegerpode ser nullobrigatório

    Integer cents.

  • payment_methodstringobrigatório

    Valores: cardpixboleto

  • acquirerstringpode ser nullobrigatório
  • paymentobjectobrigatório

    Pix: `qr_code`, `expiration_at`. Boleto: `boleto_url`, `boleto_barcode`, `expiration_date`. Card: empty.

    Mostrar campos de payment
    • qr_codestring
    • expiration_atstring
    • boleto_urlstring
    • boleto_barcodestring
    • expiration_datestring
  • created_atstringpode ser nullobrigatório
  • customerobjectobrigatório
    Mostrar campos de customer
    • email_maskedstringpode ser nullobrigatório

204Nothing to resume.

Erros

401Missing or invalid key.
422The body is invalid (`invalid_param`).
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.