noon payments

noon payments

This connector uses the noon payments API (card and wallet payment gateway in the UAE, Saudi Arabia and Egypt): order status by order id or by your order reference, scheduled settlement and commission reports, subscriptions and saved card tokens. Capture and refund are included but installed switched off.

Setup (5 minutes)

1. In the noon payments Merchant Portal open Account Settings > Applications. Create an application (or use an existing one) with only the roles it needs: Payment Integrator or Refund Manager for order lookups, Financial Auditor for reports, Token Manager for card tokens.
2. Build the key: BusinessIdentifier.ApplicationIdentifier:ApplicationKey (business identifier from the setup e-mail, a dot, the application identifier, a colon, the application key), then encode it in Base64, e.g. printf '%s' 'mybusiness.myapp:KEY' | base64. Paste the Base64 text into NOON_PAYMENTS_AUTH_KEY. The connector sends Authorization: Key <that text>.
3. NOON_PAYMENTS_API_URL: https://api.noonpayments.com (global, live) or https://api-test.noonpayments.com (test); regional endpoints are https://api.sa.noonpayments.com and https://api.eg.noonpayments.com (test: api-test.sa, api-test.eg). Keys differ per environment.

Identifiers: order_id is the numeric order id noon returned at INITIATE (stored with the shop order, often as the payment transaction id). order_reference is your own reference sent at INITIATE (the shop order number).

Workflow

• Order status: noon_payments_get_order or noon_payments_get_order_by_reference. Read result.order.status with the totals (totalAuthorizedAmount, totalCapturedAmount, totalRefundedAmount, totalReversedAmount, totalRemainingAmount) and result.transactions (each with type, status, amount and id). resultCode 0 only means the request worked, not that the payment succeeded; judge by the order status and nextActions.
• Reconciliation: noon_payments_list_scheduled_reports with report_type ReconciliationSettlement and a day, then download the file from ReportUrl (the link expires). Do not loop over orders with get-order for reconciliation; noon throttles that.
• Subscriptions and saved cards: noon_payments_get_subscription, noon_payments_get_card_token.

Writes switched off: noon_payments_capture_order (captures an authorized order) and noon_payments_refund_order (refunds a capture; pass the CAPTURE transaction id from the order). Both move money; an admin turns them on deliberately. Before each call show the user the order, the amount and the currency and wait for a yes, and pass a transaction_reference so a retry is not executed twice.

Errors: failures come back as HTTP 4xx or 5xx with resultCode, message and classDescription (Rejected_Unauthenticated: wrong key or environment; Rejected_AccessDenied: the application lacks the role; Invalid_BadRequest: a parameter). 429 means throttling; wait before retrying and do not repeat the same failing request, noon may lock the order or ban the address.

Limitations: there is no endpoint to list or search orders; look them up by id or reference, or use the daily reports. Initiating payments, authorize, reverse, cancel and fraud review are not part of this connector.