Transactions

GETapi/v1/transaction/:transaction_id

Show a transaction

This endpoint allows you to search for a specific transaction by id.

Request

GET

api/v1/transaction/:transaction_id

curl --location 'https://sandbox.virtualpay.com.br/api/v1/transaction/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {key}'

Response

{
    "transaction": [
        {
            "amount": "1.34",
            "commission": "0.01",
            "date_created": "YYYY-mm-dd HH:mm:ss",
            "description": "teste",
            "document": "XXXXXXXXXXX",
            "email": "vpay@email.com",
            "e2e_id": "XXXXXXXX",
            "finished": "",
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name": "vpay",
            "operation": "cashin",
            "payment_link": "https://virtualpay.com.br/checkout/payment/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "phone": "XXXXXXXXXXX",
            "platform": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "qr_code": "QRCode as text that can be used to generate a QRCode image or to copy as a text",
            "qr_code_image": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQEAAAAAD1RLVTAAAABGdBTUEAALGPC...",
            "reference": "reference",
            "extra": "extra",
            "status": "paid",
            "events": [
                {
                    "date_created": "YYYY-mm-dd HH:mm:ss",
                    "status": "paid"
                },
                {
                    "date_created": "YYYY-mm-dd HH:mm:ss",
                    "status": "pending"
                }
            ]
        }
    ]
}

Learn how to create cashin or cashout transactions.

GETapi/v1/transactions

List transactions

This endpoint allows you to search for list of transactions.
The pagination return 100 transactions per page.

Optional attributes

Name
identifier
Type
string
Description
The id of transaction.
ID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Name
reference
Type
string
Description
Transaction identifier, generated by client. Unique per Transaction
max: 50
Name
status
Type
string
Description
The status of transactions.
type: pending | paid | denied | canceled | refund | in_process | in_analysis | expired
Name
name_document
Type
string
Description
The name or document to whom it was sent.
Name
phone
Type
string
Description
The phone to whom it was sent.
Name
initial_date
Type
string
Description
The transaction creation date
type: YYYY-MM-DD
Name
final_date
Type
string
Description
The transaction creation date
type: YYYY-MM-DD
Name
platform
Type
string
Description
The platform id
ID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Name
pix_key
Type
string
Description
The registered PIX key
type: CPF | PHONE | EMAIL | EVP | (CNPJ According to company rules)

Pagination

The pagination will consist of:

current_page: The current page.
last_page: The last page.
next_page_url: The next page url or false.
current_page: The current page.
total: Total of transactions.

Request

GET

api/v1/transactions

curl --location 'https://sandbox.virtualpay.com.br/api/v1/transactions?name_document=00000000000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {key}'

Response

{
    "transactions": [
        {
            "amount": "1.34",
            "commission": "0.01",
            "date_created": "YYYY-mm-dd HH:mm:ss",
            "description": "teste",
            "document": "XXXXXXXXXXX",
            "email": "vpay@email.com",
            "e2e_id": "XXXXXXXX",
            "finished": "",
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name": "vpay",
            "operation": "cashin",
            "payment_link": "https://virtualpay.com.br/checkout/payment/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "phone": "XXXXXXXXXXX",
            "platform": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "qr_code": "QRCode as text that can be used to generate a QRCode image or to copy as a text",
            "qr_code_image": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQEAAAAAD1RLVTAAAABGdBTUEAALGPC...",
            "reference": "reference",
            "extra": "extra",
            "status": "paid",
            "events": [
                {
                    "date_created": "YYYY-mm-dd HH:mm:ss",
                    "status": "paid"
                },
                {
                    "date_created": "YYYY-mm-dd HH:mm:ss",
                    "status": "pending"
                }
            ]
        },
        {
            "amount": "1.34",
            "commission": "0.01",
            "date_created": "YYYY-mm-dd HH:mm:ss",
            "description": "teste",
            "document": "XXXXXXXXXXX",
            "email": "vpay@email.com",
            "finished": "",
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name": "vpay",
            "operation": "cashout",
            "phone": "XXXXXXXXXXX",
            "pix_key": "XXXXXXXXXXX",
            "platform": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "reference": "reference",
            "extra": "extra",
            "status": "pending",
            "events": [
                {
                    "date_created": "YYYY-mm-dd HH:mm:ss",
                    "status": "pending"
                }
            ]
        }
        ...
    ],
    "last_page": 2,
    "next_page_url": "https://sandbox.virtualpay.com.br/v1/transactions?page=2&name_document=00000000000",
    "current_page": 1,
    "total": 136
}

Learn how to create cashin or cashout transactions.