> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paybyrd.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

> Product updates and improvements to the Paybyrd API and documentation.

**August 2026**

Updated

### Merchant dashboard V2

Paybyrd is releasing a new version of the merchant dashboard on **August 27, 2026**, available at [`https://backoffice.paybyrd.com`](https://backoffice.paybyrd.com). No action required — just log in with your existing credentials as usual. The previous version remains accessible at [`https://legacy.paybyrd.com`](https://legacy.paybyrd.com) for a limited period.

The new version adds a Business Intelligence section with payment and revenue analytics, an Activity Log for auditing user actions across the organization, a Terminal Management view, and passwordless login via email link.

**August 2026**

Added

### Product images in Checkout

Each `shoppingCart` item now accepts an optional `imageUrl` field. Paybyrd Checkout renders the image alongside the item details.

The URL must use HTTPS and end in `.png`, `.jpg`, `.jpeg`, `.webp`, or `.svg`. Requests with an invalid protocol or unsupported file type return a `400 Bad Request` error.

See the [Create Order API reference](https://docs.paybyrd.com/api-reference/orders/create-order.md) and the [Checkout guide](https://docs.paybyrd.com/embed/checkout.md#product-images) for details.

**August 2026**

Added

### Rate limiting

The Paybyrd API now applies rate limits to the Payment and Orders endpoints, tracked per client IP over a rolling 5-minute window. Requests that exceed the limit receive a `429 Too Many Requests` response.

See the [Rate limiting](https://docs.paybyrd.com/api-reference/api-intro.md#rate-limiting) section of the API intro for the specific thresholds.

**August 2026**

Updated

### FinanceHub: Settlements API

Paybyrd's settlement reporting is now served through **FinanceHub**. Use `GET /api/v1/SettlementFiles` via the `https://financehub.paybyrd.com` server URL to retrieve a list of settlement CSV files for a given date range. Filter by `createdFrom` and `createdTo`. Scope results to a specific merchant or store with `merchantId` and `storeId`.

Download URLs in the response are valid for 7 days from the time of the request. Error responses now use the `problemDetails` format.

Two legacy endpoints using the `settlements.paybyrd.com` server URL are now deprecated:

* **Settlement files** — `GET /api/v1/SettlementFiles`. See [Settlement files (legacy)](https://docs.paybyrd.com/manage-payments/settlements/legacy-settlement-files.md).
* **Refunds before clearing** — `GET /api/v1/authorization-files`. See [Refunds before clearing files (legacy)](https://docs.paybyrd.com/manage-payments/settlements/refunds-before-clearing.md).

> [!TIP]
>
> Paybyrd continues to support the legacy endpoints for an indefinite period. However, we recommend using the new endpoints; see the [Settlement files](https://docs.paybyrd.com/manage-payments/settlements/settlement-files.md) guide and the [Settlements API reference](https://docs.paybyrd.com/api-reference) for details.

**May 2026**

Added

### Multicaixa Express: QR code and deeplink response fields

Multicaixa Express payments now return a `multicaixaExpress` object in the payment response, containing QR code and deeplink data to support the full checkout experience across desktop and mobile.

When `brand` is `MULTICAIXAEXPRESS`, the response includes:

| Field | Type | Description |
| - | - | - |
| `deeplink` | string (uri) | Direct deeplink to open the Multicaixa Express app. |
| `deeplinkRedirect` | string (uri) | Redirect URL for browser and mobile flows to the app. |
| `qrCodeUrl` | string (uri) | URL of the QR code image. |
| `expiresAt` | string (ISO 8601) | Payment expiration timestamp. |

```json theme={null}
{
  "multicaixaExpress": {
    "deeplink": "mcxwallet://purchase?qrref=...",
    "deeplinkRedirect": "https://api.sandbox.proxypay.co.ao/deeplink/...",
    "qrCodeUrl": "https://api.sandbox.proxypay.co.ao/qrcode/...",
    "expiresAt": "2026-05-22T19:14:04Z"
  }
}
```

On desktop, Paybyrd Checkout uses `qrCodeUrl` to display a QR code for the buyer to scan. On mobile, tapping **Pay** uses `deeplinkRedirect` to open the Multicaixa Express app directly.

See the [Multicaixa Express](https://docs.paybyrd.com/accept-payments/bank-transfers/multicaixa-express.md) guide for full details.

**April 2026**

Added

### New field: `softDescriptor` for card payments

Card payments now support a `softDescriptor` field, which controls the text that appears on the cardholder's bank statement for that transaction.

* Maximum length: **22 characters**
* Requests exceeding this limit return a `400 Bad Request` error

```bash theme={null}
curl --request POST \
 --url https://gateway.paybyrd.com/api/v2/payment \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --header 'x-api-key: {your_api_key}' \
 --data '{
   "softDescriptor": "MYSTORE*ORDER123",
   ...
 }'
```

See the [card payments](https://docs.paybyrd.com/accept-payments/card/card-payments.md) guide and the [Create Payment](https://docs.paybyrd.com/api-reference/payments/create-payment.md) API reference for full details.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.