Skip to main content

Release 14.05.2024

· 3 min read

Changelog​

Changes expected in the next release​

In the order creation endpoint, a new optional parameter webhookUrl will be added to the paymentSettings object. This parameter allows specifying an individual webhook for order status changes for each order. webhookUrl is of type string and is validated as a URL, so it must begin with https://.

If webhookUrl is specified when creating an order, notifications about the order status change will be sent to this URL and will not be sent to the general webhook URL set for the shop.

The new parameter is highlighted in the code below:

{
  "shopId": 1234,
  "order": {
    "orderNumber": "56573FDFVFDBWF",
    "cost": {
      "amount": "56.99",
      "currency": "PHP"
    }
  },
  "customer": {
    "customerId": "56656",
    "firstName": "John",
    "lastName": "Doe",
    "middleName": "James",
    "phone": "79221110500",
    "email": "john.doe@mymail.com"
  },
  "paymentSettings": {
    "instrumentType": "wallet",
    "providerCode": "connectpay",
    "acquirerCode": "gcash",
    "entryMode": null,
    "autoCapture": true,
    "timeLimit": "2024-02-03T10:51:49.086Z",
    "redirectUrls": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure"
    },
    "webhookUrl": "string"
  },
  "paymentPageDesign": {
    "alias": "default",
    "format": "redirect"
  }
}

The changes mentioned in the previous changelog (30.04.2024) regarding the webhook with breaking changes will not be made in this release but will be implemented in the next release on 28.05.2024. For now, the webhook remains unchanged.

danger

The webhook for orders will change in the next release (28.05.2024) without backward compatibility.

Lines highlighted will be removed from the webhook in the next release.

{
  "id": 77,
  "number": "7_1706275173",
  "status": "in_progress",
  "cost": {
    "amount": "56.99",
    "currency": "USD"
  },
  "timeLimit": {
    "date": "2024-01-27 07:45:51.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "orderCreatedAt": {
    "date": "2024-01-26 13:19:33.222170",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "orderPaidAt": {
    "date": "2024-01-26 13:19:33.222170",
    "timezone_type": 3,
    "timezone": "UTC"
  },
  "captureNeeded": false,
  "payments": [
    {
      "id": "79",
      "type": "payment",
      "parentPaymentId": "83",
      "cost": {
        "amount": "56.99",
        "currency": "USD"
      },
      "acquirerCode": "fyst",
      "paymentMethod": "card",
      "paymentDetails": {
        "type": "card",
        "authCode": "auth94753457343",
        "rrn": "rrn583743856734",
        "maskedCardNumber": "123456******1234"
      }
    }
  ],
  "customer": {
    "id": 13,
    "name": "John",
    "middleName": "James",
    "surname": "Doe",
    "phone": "79221110500",
    "email": "john.doe@mymail.com"
  },
  "data": {
    "shopId": 123,
    "orderNumber": "56573FDFVFDBWF",
    "orderStatus": "in_progress",
    "cost": {
      "amount": "56.99",
      "currency": "USD"
    },
    "timeLimit": "2023-08-29T15:34:56+03:00",
    "orderCreatedAt": "2023-08-29T15:34:56+03:00",
    "orderPaidAt": "2023-08-29T15:34:56+03:00",
    "autoCapture": true,
    "payments": [
      {
        "paymentId": "79",
        "paymentType": "payment",
        "parentPayment": "83",
        "cost": {
          "amount": "56.99",
          "currency": "USD"
        },
        "acquirer": {
          "code": "fyst"
        },
        "instrumentType": "card",
        "paymentDetails": {
          "authCode": "auth94753457343",
          "maskedCardNumber": "123456******1234",
          "rrn": "rrn583743856734"
        }
      }
    ],
    "customer": {
      "customerId": "56656",
      "firstName": "John",
      "lastName": "Doe",
      "middleName": "James",
      "phone": "79221110500",
      "email": "john.doe@mymail.com"
    }
  }
}