2023-07-27

• Changes to request and response for Order operations: This version includes significant updates to the request and response mechanisms for creating, retrieving, and listing orders. Please refer to the updated API documentation for new structures and fields.
• Removal of Get Links operation: To streamline our API and improve efficiency, we have removed the 'get links' operation previously used to retrieve payout links of an order. This change reduces the required API calls to place and retrieve a payout link order from three to two.
• New Payment Method: As part of our ongoing effort to enhance user experience, we are now enabling payment with account balance on the Runa API. This new feature adds to our existing payment methods, providing more flexibility and convenience for our users.
• Product Selection Flexibility: We have modified our product selection feature to allow item-specific product selection. Previously, product selection applied to the entire order, but now it can be specified per item. This change provides you with greater flexibility and control over your orders.

We are excited about these updates and look forward to hearing your feedback. As always, please refer to the updated API documentation for detailed information and guidance on how to implement these changes in your applications.

Impacted endpoints

• POST /v2/order
• GET /v2/order/{id}
• GET /v2/order
• GET /v2/order/{id}/links

Changes

• Added new fields to the create order API request
  • Payment method can be defined:
    • payment_method.type which can be set to CARD or ACCOUNT_BALANCE
    • payment_method.card_id
    • payment_method.currency which supports EUR, GBP, USD, and CAD
  • Distribution method can be defined in item level:
    • items.distribution_method.type which can be set to EMAIL or PAYOUT_LINK
    • items.distribution_method.email_address
  • Products can be defined on item level, now every payout link in the order can contain different product selections:
    • items.products.type which can be set to SINGLE or MULTIPLE
    • items.products.value
    • items.products.values
• Removed fields from the create order API request
  • products
  • idempotency_key
  • items.country
• Added new headers to the create order API
  • x-api-version
  • x-idempotency-key
• Added new fields from the create order API response
  • status which is either COMPLETED, PROCESSING or FAILED
• Removed all order details fields from the create order API response
• Added new get order API response models
  • For a complete order the response will contain all the order details.
    • status
    • completed_at
    • redemption_url
    • payment_method.type which can be set to CARD or ACCOUNT_BALANCE
    • payment_method.card_id
    • payment_method.currency which supports EUR, GBP, USD, and CAD
    • items.distribution_method.type which can be set to EMAIL or PAYOUT_LINK
    • items.distribution_method.email_address
    • items.products.type which can be set to SINGLE or MULTIPLE
    • items.products.value
    • items.products.values
  • For an incomplete order the response will contain
    • status
    • id
    • message
• Added new headers to the get order API
  • x-api-version
• Removed fields from get order API response
  • is_complete
  • countries
  • initial_values object
  • final_values object
  • product_count
  • items.order_id
  • items.discount_multiplier
  • items.delivery_email
  • items.current_token
  • tokens object
• The above changes in the get order API response are also reflected in the list order API. The API is still paginated and contains query parameters to control the cursor:
  • limit
  • before
  • after
• Added new headers to the list order API
  • x-api-version
• Removed the GET /v2/order/{id}/links endpoint
  • This API is replaced by adding the redemption_url to the items in the response of GET /v2/order/{id}
• Added new headers to the list products API
  • x-api-version