Changelog - Paybyrd

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).
Refunds before clearing — GET /api/v1/authorization-files. See Refunds before clearing files (legacy).

Paybyrd continues to support the legacy endpoints for an indefinite period. However, we recommend using the new endpoints; see the Settlement files guide and the Settlements API reference for details.

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.

{
  "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 guide for full details.

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

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 guide and the Create Payment API reference for full details.

​FinanceHub: Settlements API

​Multicaixa Express: QR code and deeplink response fields

​New field: softDescriptor for card payments

FinanceHub: Settlements API

Multicaixa Express: QR code and deeplink response fields

New field: `softDescriptor` for card payments