---
updatedAt: 2025-09-09T21:12:18.000Z
agentTools:
  projectIndex: https://developer.paylink.sa/llms.txt
---

# Get Paid Transactions By Order Number

Allows developers to retrieve details about a specific order in an e-commerce platform, with the Order Number as the input parameter. This endpoint can be integrated into an invoicing system to allow merchants to view detailed information about an individual order, such as customer details, payment status, and order total. The response from this endpoint will contain a JSON object that includes all the relevant order information.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Paylink Merchant API is a library used by merchants to interact with Paylink internal system.",
    "version": "1.2",
    "title": "Paylink Merchant API",
    "termsOfService": "https://paylink.sa/terms",
    "contact": {
      "name": "Paylink",
      "url": "https://paylink.sa",
      "email": "info@paylink.sa"
    },
    "license": {
      "name": "All copyright reserved for Paylink",
      "url": "https://paylink.sa/terms"
    }
  },
  "tags": [
    {
      "name": "merchant-enhanced-api-controller",
      "description": "Merchant Enhanced Api Controller"
    }
  ],
  "paths": {
    "/api/getOrder/{orderNumber}": {
      "get": {
        "tags": [
          "merchant-enhanced-api-controller"
        ],
        "summary": "Get Orders By Order Number",
        "description": "Allows developers to retrieve details about a specific order in an e-commerce platform, with the Order Number as the input parameter. This endpoint can be integrated into an invoicing system to allow merchants to view detailed information about an individual order, such as customer details, payment status, and order total. The response from this endpoint will contain a JSON object that includes all the relevant order information.",
        "operationId": "getOrdersByNumberUsingGET",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Access Token",
            "required": true,
            "example": "Bearer [access_token]",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderNumber",
            "in": "path",
            "description": "orderNumber",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully get the invoice",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReconciledOrder"
                }
              }
            }
          },
          "401": {
            "description": "You are not authorized to view the resource"
          },
          "403": {
            "description": "Accessing the resource you were trying to reach is forbidden"
          },
          "404": {
            "description": "The resource you were trying to reach is not found"
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "//restpilot.paylink.sa"
    }
  ],
  "components": {
    "schemas": {
      "ReconciledOrder": {
        "type": "object",
        "properties": {
          "clientMobile": {
            "type": "string",
            "example": "0501345678",
            "description": "The phone number of the client who placed the order"
          },
          "clientName": {
            "type": "string",
            "example": "Zaid",
            "description": "The name of the client who placed the order."
          },
          "isReconciled": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the order has been reconciled."
          },
          "note": {
            "type": "string",
            "example": "Any order note.",
            "description": "A note associated with the order."
          },
          "orderAmount": {
            "type": "number",
            "format": "double",
            "example": 100,
            "description": "Refers to the total amount charged for an order."
          },
          "orderDate": {
            "type": "string",
            "format": "date-time",
            "example": "2023-03-31",
            "description": "Refers to the date a customer placed an order in an e-commerce platform."
          },
          "orderId": {
            "type": "integer",
            "format": "int64",
            "example": 13342,
            "description": "The unique identifier of the order."
          },
          "orderNumber": {
            "type": "string",
            "example": "RCM123123",
            "description": "Refers to a unique identifier assigned to an order in a merchant e-commerce platform."
          },
          "orderStatus": {
            "type": "string",
            "example": "Paid",
            "description": "Refers to the payment status for an order"
          },
          "paylinkFees": {
            "type": "number",
            "format": "double",
            "example": 1.75,
            "description": "The fees charged by Paylink, if applicable."
          },
          "paylinkVat": {
            "type": "number",
            "format": "double",
            "example": 0.2625,
            "description": "The VAT charged by Paylink, if applicable"
          },
          "settlementAmount": {
            "type": "number",
            "format": "double",
            "example": 1300,
            "description": "The amount settled, if applicable."
          },
          "settlementBank": {
            "type": "string",
            "example": "ANB",
            "description": "The bank account number for the settlement, if applicable."
          },
          "settlementIban": {
            "type": "string",
            "example": "SA1234567890123456789012",
            "description": "The IBAN for the settlement, if applicable."
          },
          "settlementNumber": {
            "type": "string",
            "example": "TRNS1230912380",
            "description": "The settlement number, if applicable."
          },
          "transactionNo": {
            "type": "string",
            "example": 1684209464443,
            "description": "Refers to a unique identifier assigned to an order in Paylink system."
          }
        },
        "title": "ReconciledOrder",
        "description": "Refers to an order that has been matched and verified against a payment settlement, ensuring that the payment has been processed and received."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```