Get Reconciled Orders 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.

Endpoint

GET /api/getOrder/{orderNumber}

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token provided by Authentication Endpoint
Accept	Yes	It must be set to application/JSON.
Content-Type	Yes	It must be set to application/JSON.

{
  "Authorization": "Bearer [id_token]",
  "Accept": "application/json",
  "Content-Type": "application/json"
}

URL Parameters

Parameter	Value Type	Required	Description
orderNumber	String	Yes	The unique identifier of the order to retrieve details.

Success Response

Status Code: 200 OK
Content-Type: application/json
Body: A JSON object that contains details about the specified order. For more information, click here

Name	Type	Description
orderId	Integer	The unique identifier of the order
orderNumber	String	The unique order number
orderDate	Date	The date and time the order was placed, in Unix timestamp
orderAmount	Float	The total amount of the order, in the currency
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 payment, if applicable

Error Responses

Status Code: 401 Unauthorized
Status Code: 404 Not Found