riverty logo

Docs

Get Captures

Returns all or specific captured payments of the order

Path

GET /api/v3/orders/{orderNumber}/captures/{captureNumber}

Request Parameters

orderNumber required
string
Order number
captureNumber required
string
Capture number

Responses

Successful RequestUnsuccessful Request, Incorrect Capture Number

Response Example

    
        {
 "captures": [
  {
   "reservationId": "fb583567-c5a1-45de-a341-289c75e3f3dd",
   "customerNumber": "AP000100919",
   "captureNumber": "800090089",
   "orderNumber": "riverty1",
   "amount": 185,
   "balance": 0,
   "totalRefundedAmount": 185,
   "currency": "EUR",
   "insertedAt": "2023-09-27T10:50:32Z",
   "updatedAt": "2023-09-27T12:24:53Z",
   "orderDate": "2023-09-27T10:49:11Z",
   "captureItems": [
    {
     "productId": "4534-BLK-M",
     "groupId": "",
     "description": "Leather jacket, Black, size M",
     "netUnitPrice": 84,
     "grossUnitPrice": 100,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 16,
     "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
    },
    {
     "productId": "5745-GRY-M",
     "groupId": "",
     "description": "Socks, Grey, Size M",
     "netUnitPrice": 8.4,
     "grossUnitPrice": 10,
     "quantity": 5,
     "vatPercent": 19,
     "vatAmount": 1.6,
     "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
    },
    {
     "productId": "3323-BRN-M",
     "groupId": "",
     "description": "Woolen hat, brown, Size M",
     "netUnitPrice": 25.21,
     "grossUnitPrice": 30,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 4.79,
     "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
    },
    {
     "productId": "SHIP",
     "groupId": "",
     "description": "Shipping",
     "type": "ShippingFee",
     "netUnitPrice": 4.2,
     "grossUnitPrice": 5,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 0.8
    }
   ]
  }
 ]
}
    

Request Example

    
        null