Sandbox

Description

The /sandbox-transaction endpoint simulates sending transaction data to a pre-configured URL or an optional URL provided via a query parameter. It generates a sample transaction and sends the data using an HTTP POST request.

---

Request

HTTP Method

GET

URL

https://api.duopen.com.br/sandbox-transaction

Headers

Name	Type	Description
token	string	Token for authentication*

*Request the authentication token to our support team.

Query Parameters

Name	Type	Required	Description
url	string	No	An optional URL to send the transaction data to. Defaults to the pre-configured sandbox URL.
event	string	Yes	The event type. Allowed values: "categorized", "deleted".

---

Responses

Successful Response (2xx)

• A dictionary with the status and the consent status data.

Example

{
  "status": "Data sent successfully",
  "data": {
    "type": "transaction/categorized",
    "document": "12345678901",
    "establishmentName": "Loja XYZ",
    "establishmentDocument": "49731778000160",
    "location": "SHOPPING XYZ",
    "amount": "100.0",
    "date": "2024-07-10T19:51:00.000-03:00",
    "inInstallments": false,
    "transactionId": "0190b81b-11d5-7b70-b7eb-598445102d7e"
  }
}

Error Responses (4xx or 5xx)

• An error message indicating the reason for failure.

Example

{
  "detail": "Invalid event parameter. Allowed: 'categorized' or 'deleted'"
}

---

How to Use

Requests with curl

You can use curl to send a GET request to this endpoint. Below are examples of how to structure your requests.

Request (without optional URL)

curl -X GET "https://sandbox-webhook.duopen.com.br/sandbox-transaction?event=categorized" \
-H "token: AUTH_TOKEN"

Request (with optional URL)

curl -X GET "https://sandbox-webhook.duopen.com.br/sandbox-transaction?event=categorized&url=https://your-optional-url.com" \
-H "token: AUTH_TOKEN"