Pix2DePix API

https://pix2depix.apidog.io

Admin

The Pix2DePix RESTful HTTP API connects Brazil's PIX payment system with DePix, enabling seamless...

Tokens:1,075

Snippets:2

Trust Score:4

Update:1 year ago

Show doc for...

Tokens:

Raw

### Pix2DePix API Endpoints

Source: https://pix2depix.apidog.io/index

Provides access to core functionalities of the Pix2Depix API, including checking service status, initiating deposits, and querying deposit statuses.

```APIDOC
PingGET:
  Description: Checks the operational status of the Pix2Depix API.
  Method: GET
  Endpoint: /ping
  Parameters:
    None
  Returns:
    - 200 OK: If the API is operational.
    - Other status codes: Indicate an error or unavailability.

Deposit (PIX ➔ DePix)POST:
  Description: Initiates a deposit transaction from the PIX payment system to DePix assets.
  Method: POST
  Endpoint: /deposit-pix-depix
  Parameters:
    - (Request Body): Contains details of the PIX deposit, including amount, recipient information, and transaction identifiers.
  Returns:
    - 201 Created: If the deposit request is successfully initiated.
    - 400 Bad Request: If the request payload is invalid.
    - 500 Internal Server Error: If an error occurs during processing.

Deposit StatusGET:
  Description: Retrieves the current status of a previously initiated deposit transaction.
  Method: GET
  Endpoint: /deposit-status
  Parameters:
    - transactionId (query parameter): The unique identifier of the deposit transaction to query.
  Returns:
    - 200 OK: With the status details of the transaction.
    - 404 Not Found: If the transaction ID is not found.
    - 400 Bad Request: If the transactionId parameter is missing or invalid.
```

--------------------------------

### Pix2DePix API Base URL

Source: https://pix2depix.apidog.io/index

The base URL for all API requests to the Pix2Depix service. This should be prepended to all endpoint paths.

```HTTP
https://depix.eulen.app/api/
```

Tokens:

Raw