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.


GET /api/getOrder/{orderNumber}

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
orderNumberStringYesThe 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

orderIdIntegerThe unique identifier of the order
orderNumberStringThe unique order number
orderDateDateThe date and time the order was placed, in Unix timestamp
orderAmountFloatThe total amount of the order, in the currency
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 payment, if applicable

Error Responses

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