Get Orders By Settlement
Allows developers to retrieve a list of orders based on a settlement number provided as input. This endpoint can be integrated into an e-commerce platform to enable merchants to view all orders settled under a particular settlement number. The response from this endpoint will contain information about each order, such as the order number, customer details, shipping information, and order total.
Request Type:
GET
Endpoint
Production Server:
https://restapi.paylink.sa/api/getOrdersBySettlement/{settlementNumber}
Testing Server:
https://restpilot.paylink.sa/api/getOrdersBySettlement/{settlementNumber}
Request Headers:
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | An access token obtained through the authentication process |
| accept | Yes | The expected response format. application/json |
URL Parameters
| Parameter | Value Type | Required | Description |
|---|---|---|---|
| settlementNumber | string | Yes | The settlement number to retrieve orders for |
Response Body:
The response will be an array of JSON objects that includes all relevant information for the orders retrieved within the specified date range. For more details, click here.
| Name | Type | Description |
|---|---|---|
| orderId | integer | The unique identifier of the order |
| orderNumber | string | The unique order number |
| transactionNo | String | Refers to a unique identifier assigned to an order in Paylink system. |
| orderDate | date | Refers to the date a customer placed an order in an e-commerce platform. |
| orderAmount | float | Refers to the total amount charged for an order. |
| orderStatus | String | Refers to the payment status for an order |
| paylinkFees | float | The fees charged by Paylink, if applicable |
| paylinkVat | float | The VAT charged by Paylink, if applicable |
| note | string | A note associated with the order |
| clientName | string | The name of the client who placed the order |
| clientMobile | string | The phone number of the client who placed the order |
| isReconciled | boolean | Indicates whether the order has been reconciled |
| settlementNumber | string | The settlement number, if applicable |
| settlementBank | string | The bank account number for the settlement, if applicable |
| settlementAmount | float | The amount settled, if applicable |
| settlementIban | string | The IBAN for the settlement, if applicable |
Error Responses
- Status Code: 401 Unauthorized
- Status Code: 404 Not Found
Updated 10 months ago