Consultando uma cobrança

Consultando o status de uma cobrança#

É possível consultar os detalhes e o status atual de uma transação usando o transaction_id gerado pelo PicPay ou o reference_id gerado pelo parceiro.

Endpoint#

GET https://ecommerce-api.svc.picpay.com/v1/payments

Exemplo de requisição#

curl --location 'https://ecommerce-api.svc.picpay.com/v1/payments?transaction_id=e646263b-2b4d-4b2c-93d8-2568fbffb744' \
--header 'Authorization: Bearer {{access_token}}'

Ou usando o reference_id:

curl --location 'https://ecommerce-api.svc.picpay.com/v1/payments?reference_id=04c923a4-34d6-43e8-89db-1b563f887b53' \
--header 'Authorization: Bearer {{access_token}}'

Parâmetros de query#

Parâmetro	Tipo	Obrigatório	Descrição
`transaction_id`	`string`	Sim*	Identificador da transação gerado pelo PicPay no momento da cobrança
`reference_id`	`string`	Sim*	Identificador único da transação gerado pelo parceiro

*Ao menos um dos dois deve ser informado.

Resposta de sucesso#

{
    "id": "6a5f8c9a3709b847022d1526",
    "reference_id": "04c923a4-34d6-43e8-89db-1b563f887b53",
    "status": "PAID",
    "created_at": "2021-02-22T19:29:16-03:00",
    "paid_at": "2021-02-22T19:29:16-03:00",
    "value": 3.0,
    "refunded_value": 0.0,
    "transactions": [
        {
            "id": "e646263b-2b4d-4b2c-93d8-2568fbffb744",
            "value": 3.0,
            "status": "PAID",
            "created_at": "2021-02-22T19:29:16-03:00",
            "captured_value": null,
            "captured_at": null,
            "refunds": []
        }
    ]
}

Campos da resposta#

Campo	Descrição
`id`	ID interno do pagamento
`reference_id`	ID externo informado pelo seller
`status`	Status atual do pagamento
`created_at`	Data de criação
`paid_at`	Data do pagamento (`null` se não pago)
`value`	Valor do pagamento (ou valor capturado se captura parcial)
`refunded_value`	Valor total já estornado
`transactions[].id`	ID da transação
`transactions[].value`	Valor da transação
`transactions[].status`	Status individual da transação
`transactions[].captured_value`	Valor capturado (captura tardia)
`transactions[].captured_at`	Data da captura
`transactions[].refunds[]`	Lista de estornos realizados

Status possíveis#

Status	Tipo	Descrição
`CREATED`	Inicial	Transação criada, em processamento inicial
`PENDING`	Intermediário	Em processamento (challenge, análise)
`AUTHORIZED`	Intermediário	Autorizada, aguardando captura tardia
`PAID`	Final	Paga e capturada
`COMPLETED`	Final	Liquidada financeiramente
`REFUSED`	Negada	Recusada (saldo, cartão, risco ou segurança)
`CANCELLED`	Final	Cancelada antes da captura (captura tardia)
`EXPIRED`	Final	Captura tardia não realizada no prazo de 6 dias
`REFUNDED`	Final	Totalmente estornada
`PARTIALLY_REFUNDED`	Final	Parcialmente estornada
`TIMEOUT_REFUNDED`	Final	Estorno assíncrono acionado após timeout da cobrança
`ERROR`	Final	Erro no processamento da transação