Changelog​

Modified Endpoints​

Payouts​

Retrieve required payout fields

• The request‑body property payoutSettings.shopId is now required (previously nullable).

Modified Endpoints​

Orders​

Create order

• paymentSettings.instrumentType now accepts the new enum value cash.
• For bank‑transfer payments, paymentSettings.transferType now supports the new enum value codi.

Retrieve order details

• payments[].instrumentType now accepts cash.
• payments[].paymentDetails now includes a new schema for cash payments.
• For bank‑transfer payments, payments[].transferType now supports codi.

Retrieve payment methods

• Query parameter instrumentTypes now supports cash.
• Response properties instrumentType, transferType, and transferTypes[] now include cash and codi.

Payouts​

Create payout request

• The request‑body property instrumentType now accepts cash.

Retrieve required payout fields

• instrumentType now accepts cash.
• payoutSettings.transferType now accepts codi.

Retrieve payout methods

• Query parameter instrumentTypes now supports cash.
• Query parameter transferTypes now supports codi.
• Response properties instrumentType, transferType, and transferTypes[] now include cash and codi.

Retrieve payout status

• payoutDetails.recipient.transferType now supports codi.
• payoutTransactions[].instrumentType now supports cash.

Modified Endpoints​

Orders​

Create order

• The request body now supports the customer.saveCard property, allowing customers to save their card for future use.
• The payer.cardData object now includes a savedCardId property for referencing previously saved cards.
• paymentSettings.redirectUrls now supports a pending URL for handling pending payment states.
• The transferType property now accepts a new enum value: clabe.

Retrieve order details

• The payments array in the response now includes a chargebacks property (replacing the previous chargeback property).
• The paymentDetails object for card payments now includes a savedCardId property.
• For bank transfers, the transferType property now supports the new clabe value.
• The paymentType property now supports the new enum value: saved_card_payment.

Retrieve payment methods

• The transferType and transferTypes properties in the response now support the clabe value.

Payouts​

Create payout request

• The request body now supports a redirectUrls property for handling payout redirections.

Retrieve required payout fields

• The payoutSettings.transferType property now supports the new clabe value.

Retrieve payout methods

• The transferTypes query parameter now supports the clabe value.

Retrieve payout status

• The transferType in payoutDetails.recipient object for bank transfers now supports the clabe transfer type.

Chargebacks​

Retrieve chargebacks

• The structure of the chargebackDetails property within the response has been significantly revised. chargebackDetails is now an array (previously an object).

Changelog​

Orders​

Extended customer Object:

• In the Create Order endpoint, the customer object now includes a new optional birthDate parameter. This field allows you to specify the customer’s date of birth for enhanced identification or compliance requirements.

Extended addressData Object:

• In the Create Order endpoint, the addressData object inside customer.details now includes a new optional address parameter. This field is intended to capture the address information, including house numbers, required for certain billing processes.

New bank_transfer TransferType:

For instrumentType == bank_transfer, we have introduced additional TransferTypes that can be used for European online banking solutions:

TransferType	Description	Region
mybank	European payment solution for online banking transfers	Europe
tink	European payment solution for online banking transfers	Europe

Changelog​

Payouts​

Removed Deprecated Endpoint:

• The previously supported endpoint /payouts/fields/{providerCode}/{instrumentType}/ has been completely removed from the system.

New street Parameter:

• In both the Retrieve Required Payout Fields response and the Create Payout Request request, a new street parameter has been added within addressData.
• This field is intended to capture only the name of the street for use in providers that require more granular address information during payout processing.

Orders​

New authorized Payment Status:

• The Retrieve Order Details response and the Order Status Callback now include a new possible status value, authorized, under data -> payments -> paymentStatus -> status.

Crypto Wallets​

New accountCurrency Object:

• In the body of the Create Crypto Wallet for a Customer endpoint, a new object called accountCurrency has been introduced.
• This is used to specify the merchant’s account currency (fiat or crypto). Some providers require an additional account currency parameter for settlement or balance denomination alongside the actual crypto wallet currency.

Extended Response Fields:

• In the Retrieve Customer's Crypto Wallets endpoint, data -> cryptoWallets now includes two new fields: accountCurrency and accountCurrencyTokenStandard.
• These fields allow you to view the configured merchant account currency and any relevant token standards (e.g., "ERC-20") in the wallet details.

Renamed Fields in Wallet Response:

• In the Retrieve Customer's Crypto Wallets endpoint, the existing walletAddress field is now called wallet, and cryptoCurrency is renamed to currency.

Changelog​

Orders and Payouts​

Validation for orderNumber and payoutNumber:

• New length constraints: orderNumber and payoutNumber now must be at least 3 characters and no more than 255 characters.
  • This impacts the Create Order endpoint (see the orderNumber field).
  • This impacts the Create Payout Request endpoint (see the payoutNumber field).

affiliatedId Object in customer

• Both Create Order and Create Payout Request now support a new optional metaData object within the customer object. This includes the optional affiliatedId field for passing arbitrary values used for custom routing. Changes have been introduced to this endpoint, but its full functionality will be available in upcoming releases.

Orders​

Customer Object Updates:

• In the Create Order endpoint, the firstName and lastName fields inside the customer object are now optional and may be null. This allows you to create orders without strictly requiring the customer’s name information.

Payment Page Language Parameter:

• A new optional language field is available under paymentPageDesign in the Create Order request:
  • Accepts an ISO 639-1 code (for example, "en" for English).
  • Unsupported languages will default to English.
  • If omitted, the payment page language will continue to be determined by the payer’s IP address.
  • Note: The parameter is accepted now, but actual language switching functionality will be activated in a future release.

Order Cancel and Refund Request Updates:

• The request body for the Cancel Order (in development) endpoint has been updated. The endpoint’s functionality remains under development and will be fully available in a future release.
• The request body for the Refund Order (in development) endpoint has also been updated. Similar to cancellation, its functionality is still in progress and not yet fully operational.

New payer Object in Create Order:

• In the Create Order endpoint, a payer object has been added. When instrumentType = card and dataEntryMode = h2h, you can send card data directly. This removes the need for the payer to manually enter card information on the payment page. Changes have been introduced to this endpoint, but its full functionality will be available in upcoming releases.

Payouts​

Payout Endpoints Enhancements:

• In the Create Payout Request and Retrieve Required Payout Fields endpoints, new object cryptoWalletData has been added to the recipient and sender arrays.

Changelog​

Orders and Payouts​

• This change allows for multiple transferType selections within a single payment method.
  When instrumentType is bank_transfer, please rely on transferTypes. transferType remains for backward compatibility but will be removed in future releases:

  • If only one transfer type is added for payment method for the shop, it will appear in transferType and in transferTypes.
  • If multiple transfer types are added for payment method for the shop, transferType will be null and you should use transferTypes.

• Added new TransferType values: imps, upi_p2p, upi_fast_vip. For more details, see Payment and Payout Methods.

Orders​

• Introduced two new endpoints for supporting cryptocurrency payment orders. For usage guidelines, refer to API: Request examples:

  • Create Crypto Wallet for a Customer
  • Retrieve Customer's Crypto Wallets

• Extended paymentType to include the new value order_by_webhook in the Retrieve Order Details endpoint and the Callback. This value is required for crypto acceptance operations such as Create Crypto Wallet for a Customer.

Changelog​

General​

• Added the statusReason field in the following responses:

  • Retrieve Order Details and Callback (for order status).
  • Retrieve Payout Status and Callback Payout (for payout status).

  This field provides a short explanation for the current status (e.g., need_action, failed, or cancelled).
  It may contain system-generated messages or payment provider error details.
  This field remains empty for statuses like completed or in_progress.

• Extended transferType options to include pesalink for bank transfers. This broadens the range of available methods.

Changelog​

General​

• Renamed parameter in the Retrieve Customer Information endpoint from customerIds[] to customerIds.

Payouts​

• Added the serialNumber field to voucher payouts in the responses from Retrieve Payout Status and Callback Payout. This is accomplished by introducing a new schema in payoutDetails (data -> payments -> paymentDetails) specifically for voucher support.
• Added the new fields serialNumber and pin for voucher support in orders in the Retrieve Order Details endpoint and Callback, via a new schema in paymentDetails.
• Expanded the paymentSystem enum within the paymentDetails object to include maestro:
  • In the Retrieve Order Details endpoint and Callback.
  • Also added maestro in the payoutDetails object for Retrieve Payout Status and Callback Payout.
• Extended transferType options to include additional methods, such as wise and n26, broadening the range of available payout methods.

Changelog​

API Updates​

To support new integrations, we have introduced a new field documentNumber in the response for the Retrieve Required Payout Fields endpoint (recipient/sender -> documentData -> documentNumber).