Querying a charge

Querying the status of a charge#

You can query the details and current status of a transaction using the transaction_id generated by PicPay or the reference_id generated by the partner.

Endpoint#

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

Request example#

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

Or using reference_id:

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

Query parameters#

Parameter	Type	Required	Description
`transaction_id`	`string`	Yes*	Transaction identifier generated by PicPay at the time of the charge
`reference_id`	`string`	Yes*	Unique transaction identifier generated by the partner

*At least one of the two must be provided.

Successful response#

{
    "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": []
        }
    ]
}

Response fields#

Field	Description
`id`	Internal payment ID
`reference_id`	External ID provided by the seller
`status`	Current payment status
`created_at`	Creation date
`paid_at`	Payment date (`null` if not paid)
`value`	Payment amount (or captured amount if partial capture)
`refunded_value`	Total amount already refunded
`transactions[].id`	Transaction ID
`transactions[].value`	Transaction amount
`transactions[].status`	Individual transaction status
`transactions[].captured_value`	Captured amount (deferred capture)
`transactions[].captured_at`	Capture date
`transactions[].refunds[]`	List of refunds performed

Possible statuses#

Status	Type	Description
`CREATED`	Initial	Transaction created, in initial processing
`PENDING`	Intermediate	Being processed (challenge, analysis)
`AUTHORIZED`	Intermediate	Authorized, awaiting deferred capture
`PAID`	Final	Paid and captured
`COMPLETED`	Final	Financially settled
`REFUSED`	Declined	Declined (balance, card, risk or security)
`CANCELLED`	Final	Canceled before capture (deferred capture)
`EXPIRED`	Final	Deferred capture not performed within 6 days
`REFUNDED`	Final	Fully refunded
`PARTIALLY_REFUNDED`	Final	Partially refunded
`TIMEOUT_REFUNDED`	Final	Asynchronous refund triggered after charge timeout
`ERROR`	Final	Error during transaction processing