get https://example.com/orders//info
Order info returns information of the order at creation, transactions and payment.
Request Parameters
Property | Type | Description |
---|---|---|
orderId required | guid | Paynova's unique identifier for the order. Conditions: > This parameter will not be returned if the operation fails. Example: "30c8d09b-28c6-4246-b4d4-a3b000e181c7" |
Response parameters
Property | Type | Description |
---|---|---|
status required | status | API operation status. Example: { "isSuccess": true, "errorNumber": 0, "statusKey": "SUCCESS", "statusMessage": "The operation was successful.", "errors": null, "exceptionDetails": null } |
orderId required | guid | Paynova's unique identifier for the order. Conditions: > This parameter will not be returned if the operation fails. Example: "30c8d09b-28c6-4246-b4d4-a3b000e181c7" |
status required | string | The status of the transaction, e.g. "Open". Note: Status does not return the status of an invoice, e.g. fully paid or in debt collection |
merchantId required | string | Your Paynova username. |
orderId required | guid | Paynova's unique identifier for the order. |
orderNumber required | createdAt | Your identifier for the order, most likely from your order management system. |
createdAt required | timestamp: YYYY-MM-DD HH:MM:SSZ | UTC timestamp of the time the payment was created. |
salesChannel conditional | string(0-50) | Your reference for the sales channel through which the customer is purchasing goods/services. |
salesLocationId conditional | string(0-50) | Your identifier for the sales location. This might be a website URL, a country, a call-center location etc. Constraints > Only applicable for card payments. Example: "Liljeholmen" |
currencyCode required | string(2-3) | The three-letter (alpha-3) ISO currency code or currency number as per ISO 4217. Example: "SEK" , "752" |
totalAmount required | decimal | The total amount of the order. If line items are provided, the value of this field must equal the total sum of all line items. Example: 100.00 |
customer conditional | customer | Information about the customer. Example: { "customerId": "", "emailAddress": "[email protected]", "name": { "companyName": "", "firstName": "CHRISTOPHER", "lastName": "WILLIAMS" } } |
billTo conditional | nameAndAddress | The billing name and address of the customer sent in the CreateOrder service. Example: "GATUADRESS 77" |
shipTo conditional | nameAndAddress | The ship-to name and address of the recipient sent in the CreateOrder service. Example: "GATUADRESS 77" |
lineitems conditional | lineitem | The line items included when the order as created. |
payments conditional | paymentsinfo | The status of the payments on the order. |
transactions conditional | transactioninfo | The transactions performed on the order. |