6 posts tagged with "release"

Orders and Transactions Schema Updates​

Enhancement: The Get Transaction by ID endpoint (GET /api/v1/orders/{orderId}/transactions/{transactionId}) response schema has been expanded:

• The following properties are now required: primaryAmount, primaryBlockchain, secondaryAmount, serviceFeeAmount, and totalAmount.
• The primaryBlockchain property has been added, providing explicit blockchain context for each transaction.
• The primaryAmount, secondaryAmount, serviceFeeAmount, and totalAmount properties are now always present and non-nullable, ensuring consistent transaction data.

Enhancement: The Get Order by ID endpoint (GET /api/v1/orders/{orderId}) response schema has been refined:

• The transactionsCount property has been removed from the required fields.
• The transactions array items now allow the hash property to be nullable, improving compatibility with transactions that may not have a blockchain hash immediately available.

Error Response Format Changes​

Change: The following endpoints now return an array of error objects (instead of a single object) in their 400 (Bad Request) responses:

• Create payment (POST /api/v1/order/payment)
• Create deposit (POST /api/v1/order/deposit)
• Create refund (POST /api/v1/order/refund)
• Create withdrawal (POST /api/v1/order/withdrawal)
• Send crypto (POST /api/v1/order/send)
• The code property is no longer required or present at the top level of the error response; instead, each error object within the array may contain a code.

Changelog​

Webhooks Support Added​

You can now configure webhooks in the Client Portal to receive real-time notifications when important events occur in your system.

📘 Full setup instructions: Webhooks Setup Guide

You can now subscribe to the following webhook type:

• Order status callback: Triggered whenever a deposit order transitions to the completed status.

The response from the Get integrations endpoint now includes additional parameters:

• webhook: A new object describing the webhook configuration for the integration, including supported event types and statuses.

Changelog​

New Endpoints​

• Feature: Introduced the Get Crypto Assets endpoint (GET /api/v1/assets) to retrieve a list of supported crypto assets along with their blockchain details, display names, and token standards.

• Feature: Added the Get Exchange Rates endpoint (GET /api/v1/exchange-rates) to retrieve crypto-to-fiat conversion rates. This allows you to specify a fiat currency and amount, and then see the resulting crypto amounts for each supported asset.

• Feature: Introduced the Get Transaction by ID endpoint (GET /api/v1/orders/{orderId}/transactions/{transactionId}) to retrieve detailed information about a specific transaction within an order.

• Feature: Added the Send Crypto endpoint (POST /api/v1/order/send) that lets you send a specified crypto asset from one blockchain address to another.

Improvements to Existing Endpoints​

• Enhancement: Changed the response codes for creating payment, deposit, refund, and withdrawal orders to 201 instead of 200:

  • Create payment (POST /api/v1/order/payment) now returns 201.
  • Create deposit (POST /api/v1/order/deposit) now returns 201.
  • Create refund (POST /api/v1/order/refund) now returns 201.
  • Create withdrawal (POST /api/v1/order/withdrawal) now returns 201.

• Enhancement: Added detailed 400 (Bad Request) error responses for payment, deposit, refund, withdrawal, and send endpoints, including specific error codes such as unknownError, invalidAddress, notEnoughFunds, limitExceeded, and wrongData.

Orders and Transactions​

• Enhancement: The Get Orders (GET /api/v1/orders) and Get Order by ID (GET /api/v1/orders/{orderId}) endpoints now return more detailed schemas.

Changelog​

• Update: The test environment URL has been updated to: https://wallet--crypto-demo.d.apicworld.com/.

Changelog​

• Update: Modified response examples for the Create a Payment Order and Create a Deposit Order endpoints.

  • What's changed:

    • Clipboard Access: Added allow="clipboard-write *" to the iframe, enabling clipboard access within the iframe. This allows users to copy information directly from the iframe, improving usability for scenarios requiring clipboard interactions.

  • Previous example:

    <iframe src=https://example.com/iframe?integrationId=1ef4e7cd-0b48-657a-ab8c-65ac066ea2c5&orderId=1ef61435-1606-6f76-bd9d-2fc7624dd369 width="100%" height="800px"></iframe>
    

  • Updated example:

    <iframe src=https:\/\/example.com\/iframe?integrationId=1ef4e7cd-0b48-657a-ab8c-65ac066ea2c5&orderId=1ef61435-1606-6f76-bd9d-2fc7624dd369 width="100%" height="800px" allow="clipboard-write *" ></iframe>
    

Changelog​

• New feature: Introduced the Create Refund Order endpoint.

  • This allows you to create a refund for completed payment or deposit orders. Refunds can only be processed if there are sufficient funds in the wallet balance, including fees.
  • Refunds cannot exceed the total amount received for the original order. For example, if an order of 10 was refunded 5, the maximum that can be refunded in a second transaction is 5.

• New feature: Added the Create Withdrawal Order endpoint.

  • This allows you to withdraw funds from your balance to an external wallet. You must specify the amount, asset type, destination address, and integration ID.
  • The order is processed once sufficient funds are available and the details are valid.