Update Portal

---

v2 PUT console.bayar.cash/api/v2/portals/{portal_id} v3 PUT api.console.bayar.cash/v3/portals/{portal_id}

---

Update an existing portal. FPX is always enabled. The payment channels provided must already be subscribed by the merchant. The updated portal object is returned.

Name	Description	Type	Condition
name	Portal name. Must be unique for the merchant	string	Required
merchant_transaction_notification_email	Email address to receive transaction notifications	string	Required
url	Portal website URL (named website_url on v3)	string	Optional
secondary_merchant_transaction_notification_email	Secondary notification email - only available on v3	string	Optional
payment_channels	Array of payment channel IDs to enable. Refer payment channel page	array	Optional
bank_accounts	Required when Manual Bank Transfer (2) is enabled. Array of { account_no, bank_id, payment_gateway_id }	array	Optional
enabled_sms_on_successful_transaction	Enable SMS notification on a successful transaction	boolean	Optional
split_payment_enabled	Enable split payment - only available on v3	boolean	Optional
split_payment_merchants	Array of { merchant_email, type (fix_amount/percentage), value } - only available on v3	array	Optional
cashier_id	Required when DuitNow QR (6) is enabled - only available on v3	integer	Optional
enable_incoming_transaction_webhook	Enable incoming transaction webhook - only available on v2	boolean	Optional

---

Example of sending PUT request with cURL.

curl -X PUT https://api.console.bayar.cash/v3/portals/prt_PGMo1q \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <Personal_Access_Token>' \
  --data-raw '{
        "name": "Payment Link",
        "website_url": "https://bcl.my/",
        "merchant_transaction_notification_email": "[e-mail]",
        "payment_channels": [3, 4]
      }'

Example of JSON structured response.

{
    "id": "prt_PGMo1q",
    "created_at": "2024-10-19 12:47:07",
    "portal_key": "8baf5e234dd88c2d1375d5f386d78d8f",
    "portal_name": "Payment Link",
    "url": "https://bcl.my/",
    "transaction_notification_email": "[e-mail]",
    "secondary_transaction_notification_email": null,
    "custom_payment_button_text": null,
    "payment_channels": [
        {
            "id": 1,
            "code": "FPX",
            "name": "FPX"
        },
        {
            "id": 3,
            "code": "FpxDirectDebit",
            "name": "Direct Debit"
        },
        {
            "id": 4,
            "code": "FpxLineOfCredit",
            "name": "FPX Line of Credit"
        }
    ]
}