> This page is for Internet banking (beta).

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://en.docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server.

# List or search PIX Out payment intents

GET https://client.api.corpx.com/v1/accounts/{accountId}/pix/payments

Lists all outbound PIX payment intents for a given account.
Optionally, search for a specific payment by paymentId, identifier, or endToEndId (only one at a time).
Returns payment history including status, recipient info, and reconciliation data.


Reference: https://en.docs.api.corpx.com/ib/referencia/pix/list-payments

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `accountId` (string, required) — Account ID.

### Query parameters

- `paymentId` (string, optional) — Search by payment ID (returns single payment).
- `identifier` (string, optional) — Search by integrator-provided identifier (returns single payment).
- `endToEndId` (string, optional) — Search by E2E ID from BACEN (returns single payment).
- `status` (enum, optional) — Filter by payment status (list mode only). Canonical PIX statuses; a refunded/returned payment is REVERSED (there is no SUCCESS/REFUNDED/CANCELLED).
  - Allowed values: `CREATED`, `PENDING`, `PENDING_APPROVAL`, `COMPLETED`, `FAILED`, `REVERSED`

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`).
- `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`.
- `X-Request-Signature` (string, required) — Detached JWS (`<protected>..<signature>`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`.

## Response

### 200

List of payments.

- `payments` (list of Payment, optional)
- `total` (integer, optional) — Total number of payments.

## Errors

### 400 Bad Request Error

Invalid request sent by client.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 500 Internal Server Error

Unexpected server error.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### Payment

PIX Out payment intent. Created when a PIX Out transfer is initiated via the API. Updated asynchronously when the transfer is confirmed or fails.

- `paymentId` (string, required) — Unique payment identifier.
- `accountId` (string, required) — Account that initiated the payment.
- `status` (enum, required) — Payment status: - `CREATED` — Payment initiated, awaiting partner confirmation - `PENDING` — Being processed by the bank - `PENDING_APPROVAL` — Held by the partner for internal approval (multi-step authorisation, 2FA, anti-fraud). No BACEN end-to-end ID yet; funds have **not** moved. The status will transition to `PENDING` → `COMPLETED`/`FAILED` once the partner releases or rejects the request. - `COMPLETED` — Transfer confirmed - `FAILED` — Transfer failed (see `errorReason`) - `REVERSED` — Reverted after settlement (refund) - `UNKNOWN` — Partner returned a status outside the canonical vocabulary (defensive fallback; should never happen — contact support if seen)
  - Allowed values: `CREATED`, `PENDING`, `PENDING_APPROVAL`, `COMPLETED`, `FAILED`, `REVERSED`, `UNKNOWN`
- `amount` (double, required) — Payment amount in BRL.
- `currency` (enum, required)
  - Allowed values: `BRL`
- `createdAt` (datetime, required) — Payment creation timestamp.
- `reconciled` (boolean, required) — Whether the payment has been reconciled with its transaction.
- `updatedAt` (datetime, optional) — Last update timestamp.
- `endToEndId` (string, optional) — PIX E2E identifier (assigned after processing).
- `identifier` (string, optional) — Client-provided identifier for tracking.
- `description` (string, optional) — Payment description/message.
- `keyType` (string, optional) — PIX key type used (CPF, CNPJ, EMAIL, PHONE, EVP).
- `key` (string, optional) — PIX key value used for the transfer.
- `reconciledAt` (datetime, optional) — Reconciliation timestamp.
- `transactionId` (string, optional) — Linked transaction ID in the statement.
- `errorReason` (string, optional) — Error description (present when status is FAILED).
- `payee` (Party, optional) — Payer or payee party information.
- `refund` (PaymentRefund, optional) — Refund info (present when recipient refunded the payment).
- `transaction` (TransactionDetail, optional) — Enriched transaction details. Present in QR code and payment lookups when the record is reconciled with a transaction.

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### Party

Payer or payee party information.

- `name` (string, optional) — Full name.
- `document` (string, optional) — CPF/CNPJ.
- `bankCode` (string, optional) — Bank code (COMPE/ISPB).
- `branch` (string, optional) — Branch number.
- `account` (string, optional) — Account number.
- `pixKey` (string, optional) — PIX key (when available).

### PaymentRefund

Refund info (present when recipient refunded the payment).

- `endToEnd` (string, optional) — Refund E2E identifier.
- `amount` (double, optional) — Refunded amount in BRL.
- `refundedAt` (datetime, optional)

### TransactionDetail

Enriched transaction details. Present in QR code and payment lookups when the record is reconciled with a transaction.

- `transactionId` (string, required) — Internal transaction ID.
- `transactionType` (enum, required) — Transaction type.
  - Allowed values: `PIX_IN`, `PIX_OUT`, `QR_CODE_PAYMENT`, `PIX_REFUND`, `INTERNAL`, `FEE`
- `status` (enum, required) — Canonical transaction status. A refunded/returned transaction is `REVERSED` (the refund details — D-code, amount, date — are not in this payload; see the transaction timeline).
  - Allowed values: `INITIATED`, `PENDING_APPROVAL`, `PROCESSING`, `COMPLETED`, `FAILED`, `REVERSED`
- `amount` (double, required) — Transaction amount in BRL.
- `currency` (enum, required)
  - Allowed values: `BRL`
- `direction` (enum, required) — IN = receipt, OUT = send.
  - Allowed values: `IN`, `OUT`
- `createdAt` (datetime, required)
- `method` (enum, optional) — How the transfer was made.
  - Allowed values: `DICT`, `STATIC_QR_CODE`, `DYNAMIC_QR_CODE`, `INTERNAL`, `TED`, `BOLETO`, `REFUND`
- `updatedAt` (datetime, optional)
- `endToEndId` (string, optional) — BACEN end-to-end identifier.
- `identifier` (string, optional) — Client-provided identifier.
- `description` (string, optional) — Transaction description/message.
- `balanceAfter` (double, optional) — Account balance after this transaction.
- `payer` (Party, optional) — Payer or payee party information.
- `payee` (Party, optional) — Payer or payee party information.
- `fee` (TransactionDetailFee, optional) — Fee charged for this transaction (if any).
- `errorReason` (string, optional) — Error description (present when status is FAILED).
- `qrcodeId` (string, optional) — Linked QR code txid (if transaction originated from a QR code).
- `qrcodeIdentifier` (string, optional) — Linked QR code client identifier.
- `originalEndToEnd` (string, optional) — For refund transactions, the E2E of the original PIX.
- `refundEndToEndIds` (list of string, optional) — List of refund E2E IDs linked to this transaction.
- `dispute` (TransactionDetailDispute, optional) — MED/dispute info (if this transaction has an active dispute).
- `policyViolations` (list of TransactionDetailPolicyViolationsItems, optional) — Policy violations detected for this transaction.

### TransactionDetailFee

Fee charged for this transaction (if any).

- `feeId` (string, optional) — Fee record ID.
- `amount` (double, optional) — Fee amount in BRL.
- `serviceType` (string, optional) — Fee category (PIX_IN, PIX_OUT, INTERNAL, etc.).

### TransactionDetailDispute

MED/dispute info (if this transaction has an active dispute).

- `medId` (string, optional)
- `status` (enum, optional)
  - Allowed values: `OPEN`, `ANSWERED`, `CLOSED`, `ACCEPTED`, `REJECTED`
- `reasonCode` (string, optional)
- `claimant` (string, optional)
- `claimMessage` (string, optional)
- `deadline` (datetime, optional)
- `answer` (enum, optional)
  - Allowed values: `AGREE`, `DISAGREE`
- `openedAt` (datetime, optional)

### TransactionDetailPolicyViolationsItems

- `rule` (string, optional)
- `action` (string, optional)
- `message` (string, optional)

## Examples

**Response**

```json
{
  "payments": [
    {
      "paymentId": "acdd9225-2fdc-4019-b347-5d7247a6a078",
      "accountId": "6ff57bc1-e4a9-403b-be62-42378b8aafd7",
      "status": "COMPLETED",
      "amount": 0.01,
      "currency": "BRL",
      "createdAt": "2026-02-05T13:14:50.518Z",
      "reconciled": true,
      "endToEndId": "E3674167520260205101448462399988",
      "method": "DICT",
      "recipient": {
        "document": "123***01",
        "name": "MARIA DA SILVA",
        "pixKey": "12345678900"
      }
    }
  ],
  "total": 1
}
```

**SDK Code**

```python Payments list
import requests

url = "https://client.api.corpx.com/v1/accounts/accountId/pix/payments"

headers = {
    "X-Content-SHA256": "X-Content-SHA256",
    "X-Request-Signature": "X-Request-Signature",
    "X-Request-Timestamp": "X-Request-Timestamp",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Payments list
const url = 'https://client.api.corpx.com/v1/accounts/accountId/pix/payments';
const options = {
  method: 'GET',
  headers: {
    'X-Content-SHA256': 'X-Content-SHA256',
    'X-Request-Signature': 'X-Request-Signature',
    'X-Request-Timestamp': 'X-Request-Timestamp',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Payments list
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client.api.corpx.com/v1/accounts/accountId/pix/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Content-SHA256", "X-Content-SHA256")
	req.Header.Add("X-Request-Signature", "X-Request-Signature")
	req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Payments list
require 'uri'
require 'net/http'

url = URI("https://client.api.corpx.com/v1/accounts/accountId/pix/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Content-SHA256"] = 'X-Content-SHA256'
request["X-Request-Signature"] = 'X-Request-Signature'
request["X-Request-Timestamp"] = 'X-Request-Timestamp'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Payments list
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://client.api.corpx.com/v1/accounts/accountId/pix/payments")
  .header("X-Content-SHA256", "X-Content-SHA256")
  .header("X-Request-Signature", "X-Request-Signature")
  .header("X-Request-Timestamp", "X-Request-Timestamp")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Payments list
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://client.api.corpx.com/v1/accounts/accountId/pix/payments', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Content-SHA256' => 'X-Content-SHA256',
    'X-Request-Signature' => 'X-Request-Signature',
    'X-Request-Timestamp' => 'X-Request-Timestamp',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Payments list
using RestSharp;

var client = new RestClient("https://client.api.corpx.com/v1/accounts/accountId/pix/payments");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Content-SHA256", "X-Content-SHA256");
request.AddHeader("X-Request-Signature", "X-Request-Signature");
request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Payments list
import Foundation

let headers = [
  "X-Content-SHA256": "X-Content-SHA256",
  "X-Request-Signature": "X-Request-Signature",
  "X-Request-Timestamp": "X-Request-Timestamp",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/accounts/accountId/pix/payments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```