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.


GET /api/getOrdersBySettlement/{settlementNumber}

Request Headers

AuthorizationYesBearer token provided by Authentication Endpoint
AcceptYesIt must be set to application/JSON.
Content-TypeYesIt must be set to application/JSON.
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"

URL Parameters

ParameterValue TypeRequiredDescription
settlementNumberStringYesThe 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.

orderIdintegerThe unique identifier of the order
orderNumberstringThe unique order number
transactionNoStringRefers to a unique identifier assigned to an order in Paylink system.
orderDatedateRefers to the date a customer placed an order in an e-commerce platform.
orderAmountfloatRefers to the total amount charged for an order.
orderStatusStringRefers to the payment status for an order
paylinkFeesfloatThe fees charged by Paylink, if applicable
paylinkVatfloatThe VAT charged by Paylink, if applicable
notestringA note associated with the order
clientNamestringThe name of the client who placed the order
clientMobilestringThe phone number of the client who placed the order
isReconciledbooleanIndicates whether the order has been reconciled
settlementNumberstringThe settlement number, if applicable
settlementBankstringThe bank account number for the settlement, if applicable
settlementAmountfloatThe amount settled, if applicable
settlementIbanstringThe IBAN for the settlement, if applicable

Error Responses

  • Status Code: 401 Unauthorized
  • Status Code: 404 Not Found