- Home
- API References
- JSON API reference
- Orders
- Getting order details
Getting order details
Getting order details
Example Request
Copied!
curl https://api.worldpay.com/v1/orders/[your-order-code]
-H "Authorization:your-service-key"
-H "Content-type: application/json"
-X GET
curl https://api.worldpay.com/v1/orders/[your-order-code] -H "Authorization:your-service-key" -H "Content-type: application/json" -X GET
Example Response
Copied!
{
"token": "your-token",
"orderDescription": "your-order-description",
"netAmount": 500,
"authorizedAmount":99
"commission": 10,
"chargedbackAmount": 500,
"currencyCode":"GBP",
"currencyCodeExponent": 2,
"settlementCurrency": "GBP",
"is3DSOrder":true/false,
"authorizeOnly":true/false,
"settlementCurrencyExponent": 2,
"creationDate": "2014-05-07T09:26:27.658+0000",,
"telephoneNumber": "02079460761"
"modificationDate": "2014-05-26T07:16:45.658+0000",
"orderCode": "worldpay-order-code",
"amount": 500,
"currencyCode": "GBP",
"paymentStatus": "SUCCESS",
"paymentStatusReason": "reason",
"paymentResponse": {
"name": "name",
"expiryMonth": 2,
"expiryYear": 2015,
"issueNumber": 2,
"startMonth": 8,
"startYear": 2013,
"cardType": "VISA",
"maskedCardNumber": " ** 1111",
"billingAddress": {
"address1": "address1",
"address2": "address2",
"address3": "address3",
"postalCode": "postCode",
"city": "Reading",
"state": "Berkshire",
"countryCode": "GB"
}
},
"customerOrderCode": "my-order-number",
"customerIdentifiers": {
"key1": "value1",
"key2": "value2",
"key3": "value3",
"key4": "value4",
"key5": "value5"
},
"environment": "TEST",
"history": [
{
"modificationDate": "2014-05-07T09:26:27.658+0000",
"state": "SUCCESS",
"amount": 500,
"currencyCode": "GBP",
"currencyCodeExponent": 2
},
{
"modificationDate": "2014-05-11T11:56:45.658+0000",
"state": "SETTLED",
"amount": 500,
"currencyCode": "GBP",
"currencyCodeExponent": 2,
"netAmount": 490,
"commission": 10,
"settlementCurrency": "GBP",
"settlementCurrencyExponent": 2
}
],
"disputes":[
{
"id":"documentId",
"documentName":"document1.txt",
"creationDate":"2015-05-06T14:14:03.684+0000"
},
{
"id":"documentId",
"documentName":"document2.pdf",
"creationDate":"2015-05-06T14:14:03.684+0000"
}
]
}
{ "token": "your-token", "orderDescription": "your-order-description", "netAmount": 500, "authorizedAmount":99 "commission": 10, "chargedbackAmount": 500, "currencyCode":"GBP", "currencyCodeExponent": 2, "settlementCurrency": "GBP", "is3DSOrder":true/false, "authorizeOnly":true/false, "settlementCurrencyExponent": 2, "creationDate": "2014-05-07T09:26:27.658+0000",, "telephoneNumber": "02079460761" "modificationDate": "2014-05-26T07:16:45.658+0000", "orderCode": "worldpay-order-code", "amount": 500, "currencyCode": "GBP", "paymentStatus": "SUCCESS", "paymentStatusReason": "reason", "paymentResponse": { "name": "name", "expiryMonth": 2, "expiryYear": 2015, "issueNumber": 2, "startMonth": 8, "startYear": 2013, "cardType": "VISA", "maskedCardNumber": " ** 1111", "billingAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postCode", "city": "Reading", "state": "Berkshire", "countryCode": "GB" } }, "customerOrderCode": "my-order-number", "customerIdentifiers": { "key1": "value1", "key2": "value2", "key3": "value3", "key4": "value4", "key5": "value5" }, "environment": "TEST", "history": [ { "modificationDate": "2014-05-07T09:26:27.658+0000", "state": "SUCCESS", "amount": 500, "currencyCode": "GBP", "currencyCodeExponent": 2 }, { "modificationDate": "2014-05-11T11:56:45.658+0000", "state": "SETTLED", "amount": 500, "currencyCode": "GBP", "currencyCodeExponent": 2, "netAmount": 490, "commission": 10, "settlementCurrency": "GBP", "settlementCurrencyExponent": 2 } ], "disputes":[ { "id":"documentId", "documentName":"document1.txt", "creationDate":"2015-05-06T14:14:03.684+0000" }, { "id":"documentId", "documentName":"document2.pdf", "creationDate":"2015-05-06T14:14:03.684+0000" } ] }
Order details can be obtained by sending a GET request.