1 of 4

Status

This page contains two methods for checking the status of a transaction. You can use pooling or webhook.

Check Payment Status

To check the status of payments (deposits) you can use the endpoints below

Check Transfer Status

To check the status of transfers (withdrawal) you can use the endpoints below

Webhook

Monitor via webhook to receive notifications and have the status of your payments and transfers updated in real time.

Webhook

With webhooks you can enter a URL of your application that is available to the Internet, to receive notifications regarding status changes of payments and transfers from Pagstar.

Fields with * are required. The others are considered optional.

Set notification URL

PATCH https://api.pagstar.com/api/v2/identity/partner/notification-url

Headers

Request Body

{
    "message": "Conta atualizada com sucesso",
    "data": {
        "notification_url": "https://futurama.com/api/webhook/pagstar",
        "notify_type": 2
    }
}

{
    "message": "O campo notification url deve começar com um dos seguintes valores: https://"
}

Events

All events are sent via a HTTP/HTTPS POST request with the JSON format in the payload.

We recommend for security reasons to only accept notifications from IP 3.128.119.90

Your endpoint must return a success status code in the response, where (2xx) is a valid format, so we will consider it as delivered. Otherwise, we will retry to deliver the notification 2 more times, after which we will no longer attempt to deliver the notification for this event.

A notification that has already been sent can be sent via the panel, or if the settlement bank sends us the approval event again.

The example below is an example of an event payload that we sent.

Payments

Webhook containing information update of a payment transaction

Example of approved payment, using the old format

{
  "status": "approved",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "pay",
  "value": 100,
  "end2end": "Não se aplica",
  "user_id": "0",
  "admin_id": 477
}

Example of a canceled payment, using the old format

{
  "status": "canceled",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "pay",
  "value": 100,
  "end2end": "Não se aplica",
  "user_id": "0",
  "admin_id": 477
}

Example of approved payment, using the new format

{
  "status": "approved",
  "type": "pay",
  "value": 100,
  "external_reference": "f86148ba-930a-4422-a8c8-420a8adf8021",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

Example of a canceled payment, using the new format

{
  "status": "canceled",
  "type": "pay",
  "value": 100,
  "external_reference": "f86148ba-930a-4422-a8c8-420a8adf8021",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

The properties end2end is not used for payments and user_id is only used for payments with the Pagstar digital wallet.

Payments are only cancelled after 1 hour of expiration time.

Transfers

Webhook containing information update of a transfer transaction

Example of approved transfer, using the old format

{
  "status": "approved",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "transfer",
  "value": 100,
  "end2end": "PT202302271112223ABC",
  "user_id": "0",
  "admin_id": 477
}

Example of canceled transfer, using the old format

{
  "status": "canceled",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "transfer",
  "value": 100,
  "end2end": "PT202302271112223ABC",
  "user_id": "0",
  "admin_id": 477
}

Example of approved transfer, using the new format

{
  "status": "approved",
  "type": "transfer",
  "value": 100,
  "external_reference": "PT202302271112223ABC",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

Example of canceled transfer, using the new format

{
  "status": "canceled",
  "type": "transfer",
  "value": 100,
  "external_reference": "PT202302271112223ABC",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

The user_id property is only used for payments with Pagstar's digital wallet.

Payment Pooling

The Status API contains the endpoints to get more details of a payment and also a quick status check.

Fields with * are required. The others are considered optional.

Check Status

To check the status of payments (deposits) you can use the endpoints below

Check transaction status

HEAD https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference/check

Check transaction status with HTTP status-only

Path Parameters

Headers

Get Transaction status

GET https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference

Returns transaction info

Path Parameters

Headers

Transfer Pooling

The Status API contains the endpoints to get more details of a transfer and also a quick status check.

Fields with * are required. The others are considered optional.

Check Status

To check the status of payments (deposits) you can use the endpoints below

Get Transaction status

GET https://api.pagstar.com/api/v2/wallet/partner/transfers/:external_reference/check

Returns transaction info

Path Parameters

Headers

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "processing",
        "status_description": null,
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": null
    }
}

{
    "message": "Transferência não encontrada",
    "data": []
}

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "canceled",
        "status_description": "Liquidação da transação interrompida devido a timeout no SPI.",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": ""
    }
}

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": true,
        "status": "approved",
        "status_description": "Success",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": "E0825353920230521050444SXCR"
    }
}

Webhook

With webhooks you can enter a URL of your application that is available to the Internet, to receive notifications regarding status changes of payments and transfers from Pagstar.

Fields with * are required. The others are considered optional.

Set notification URL

PATCH https://api.pagstar.com/api/v2/identity/partner/notification-url

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
    "message": "Conta atualizada com sucesso",
    "data": {
        "notification_url": "https://futurama.com/api/webhook/pagstar",
        "notify_type": 2
    }
}

{
    "message": "O campo notification url deve começar com um dos seguintes valores: https://"
}

Events

All events are sent via a HTTP/HTTPS POST request with the JSON format in the payload.

We recommend for security reasons to only accept notifications from IP 3.128.119.90

A notification that has already been sent can be sent via the panel, or if the settlement bank sends us the approval event again.

The example below is an example of an event payload that we sent.

Payments

Webhook containing information update of a payment transaction

Example of approved payment, using the old format

{
  "status": "approved",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "pay",
  "value": 100,
  "end2end": "Não se aplica",
  "user_id": "0",
  "admin_id": 477
}

Example of a canceled payment, using the old format

{
  "status": "canceled",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "pay",
  "value": 100,
  "end2end": "Não se aplica",
  "user_id": "0",
  "admin_id": 477
}

Example of approved payment, using the new format

{
  "status": "approved",
  "type": "pay",
  "value": 100,
  "external_reference": "f86148ba-930a-4422-a8c8-420a8adf8021",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

Example of a canceled payment, using the new format

{
  "status": "canceled",
  "type": "pay",
  "value": 100,
  "external_reference": "f86148ba-930a-4422-a8c8-420a8adf8021",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

The properties end2end is not used for payments and user_id is only used for payments with the Pagstar digital wallet.

Payments are only cancelled after 1 hour of expiration time.

Transfers

Webhook containing information update of a transfer transaction

Example of approved transfer, using the old format

{
  "status": "approved",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "transfer",
  "value": 100,
  "end2end": "PT202302271112223ABC",
  "user_id": "0",
  "admin_id": 477
}

Example of canceled transfer, using the old format

{
  "status": "canceled",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "type": "transfer",
  "value": 100,
  "end2end": "PT202302271112223ABC",
  "user_id": "0",
  "admin_id": 477
}

Example of approved transfer, using the new format

{
  "status": "approved",
  "type": "transfer",
  "value": 100,
  "external_reference": "PT202302271112223ABC",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

Example of canceled transfer, using the new format

{
  "status": "canceled",
  "type": "transfer",
  "value": 100,
  "external_reference": "PT202302271112223ABC",
  "transaction_id": "60a43f10-1703-4f9f-bc86-53ad357e8e32",
  "created_at": "2023-07-28T01:15:55.000000Z",
  "updated_at": "2023-07-28T01:15:55.000000Z"
}

The user_id property is only used for payments with Pagstar's digital wallet.

Payment Pooling

The Status API contains the endpoints to get more details of a payment and also a quick status check.

Fields with * are required. The others are considered optional.

Check Status

To check the status of payments (deposits) you can use the endpoints below

Check transaction status

HEAD https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference/check

Check transaction status with HTTP status-only

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

Get Transaction status

GET https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference

Returns transaction info

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

{
    "message": "Success.",
    "data": {
        "id": 168258,
        "external_reference": "47023acc-0727-476a-a011-9d759e7f58c9",
        "value": 10,
        "callback": null,
        "type": "payment",
        "user_id": 347,
        "status": 1,
        "deeplink": null,
        "pix_deposit": {
            "qr_code_url": "https://chart.googleapis.com/chart?chs=150x150&cht=qr&chl=IxoYKcQw.PAGSTARMOCK2022.Je2KjEG3XgdW.yogJySWhNLjVsdilBn4hqUd9",
            "pix_key": "IxoYKcQw.PAGSTARMOCK2022.Je2KjEG3XgdW.yogJySWhNLjVsdilBn4hqUd9",
            "favoured": "Pagstar Servicos de Pagamento",
            "external_reference": "47023acc-0727-476a-a011-9d759e7f58c9",
            "checkout": "https://dev-checkout.pagstar.com/payment/pix/47023acc-0727-476a-a011-9d759e7f58c9"
        },
        "partner": {
            "name": "Futurama",
            "document": "87539319"
        },
        "tenant": {
            "id": "992bbc18-0b59-4e5f-9bb5-4fca4b3b749a",
            "name": "EGS"
        },
        "created_at": "2022-08-26T00:28:09.000000Z"
    }
}

{
    "message": "Não foi possível encontrar esta transação",
    "data": []
}

Transfer Pooling

The Status API contains the endpoints to get more details of a transfer and also a quick status check.

Fields with * are required. The others are considered optional.

Check Status

To check the status of payments (deposits) you can use the endpoints below

Get Transaction status

GET https://api.pagstar.com/api/v2/wallet/partner/transfers/:external_reference/check

Returns transaction info

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "processing",
        "status_description": null,
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": null
    }
}

{
    "message": "Transferência não encontrada",
    "data": []
}

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": false,
        "status": "canceled",
        "status_description": "Liquidação da transação interrompida devido a timeout no SPI.",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": ""
    }
}

{
    "message": "Transação retornada com sucesso",
    "data": {
        "success": true,
        "status": "approved",
        "status_description": "Success",
        "value": 1,
        "target_name": "Usuario Teste Pagstar",
        "target_document": "*.510.358-**",
        "end2end": "E0825353920230521050444SXCR"
    }
}