Get Captures | Riverty Docs

Path

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

Request Parameters

orderNumber

required

string

Order number

captureNumber

required

string

Capture number

Responses

array

Collection of captures

reservationId

string

Reservation ID.

customerNumber

string

> 100 Characters

Customer number.

captureNumber

string

> 50 Characters

Capture number.

orderNumber

string

> 50 Characters

Order number.

amount

number

Shows the original invoice amount.

balance

number

Shows the remaining amount due on the invoice.

totalRefundedAmount

number

Total refunded amount.

currency

string

Enum:

EUR

NOK

SEK

DKK

CHF

Currency

insertedAt

string

Indicates the capture creation time.

updatedAt

string

Indicates the time when the capture was last updated.

directDebitBankAccount

string

> 34 Characters

Direct debit bank account.

directDebitSwift

string

> 11 Characters

Direct debit swift.

accountProfileNumber

integer

Account profile number.

numberOfInstallments

integer

Number of installments.

installmentAmount

number

Installment amount.

contractDate

string

Contract date.

orderDate

string

Order date.

installmentProfileNumber

integer

Installment profile number.

parentTransactionReference

string

> 128 Characters

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.

transactionReference

string

> 100 Characters

A unique reference for each transaction (separate for transactions within an order), generated and provided to Riverty by a third party (merchant or Payment Service Provider). It is used to identify transactions during back-end settlement between Core systems and the PSP.

dueDate

string

Due date.

invoiceDate

string

Invoice date.

yourReference

string

> 20 Characters

Reference number. Only to be used if advised by Riverty integration manager.

ourReference

string

> 20 Characters

Reference number. Only to be used if advised by Riverty integration manager.

invoiceProfileNumber

integer

Invoice profile number.

ocr

string

> 27 Characters

OCR (Optical Character Recognition) number bound to this capture.

installmentCustomerInterestRate

number

Installment customer interest rate.

imageUrl

string

> 2048 Characters

URL for the image of this product. It will be turned into a thumbnail and displayed in Riverty, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. Supported image formats are: gif, jpeg (jpg), png, webp.

productUser

string

> 50 Characters

Product User.

costCenter

string

> 50 Characters

Used for B2B to specify the costCenter e.g. Marketing or Sales Department - Displayed on the invoice.

array

Capture items.

productId

required

string

> 100 Characters

Merchant Product identification number.

groupId

string

> 50 Characters

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 50 characters will be truncated.

description

required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated.

type

string

Enum:

PhysicalArticle

DigitalArticle

GiftCard

Discount

ShippingFee

Surcharge

Info

Subscription

netUnitPrice

required

number

Net unit price.

grossUnitPrice

required

number

Gross price per item.

quantity

required

number

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string

> 50 Characters

Unit code (for example pieces, liters, kilograms, etc.).

vatCategory

string

Enum:

HighCategory

LowCategory

NullCategory

NoCategory

MiddleCategory

OtherCategory

Vat category

vatPercent

required

number

Tax percent.

vatAmount

required

number

Tax amount per item.

imageUrl

string

> 2048 Characters

googleProductCategoryId

integer

Google product category ID.

googleProductCategory

string

> 255 Characters

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.

merchantProductType

string

> 255 Characters

Categorization used by Merchant as a complement to Google Taxonomy.

lineNumber

integer

Line number. The merchant may add a line number to each order item, to sort them in a particular order.

productUrl

string

> 2048 Characters

URL to the product.

marketPlaceSellerId

string

> 32 Characters

ID of an individual seller on a marketplace.

parentTransactionReference

string

> 128 Characters

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string

> 4096 Characters

Extended description of the order item.

specification

N/A

Specification.

serviceStart

string

Capture start time.

serviceEnd

string

Capture end time.

array

Shipping details.

Successful Request

Unsuccessful Request, Incorrect Capture Number

Request Example

    
        null

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

Response Example

    
        [
 {
  "type": "BusinessError",
  "code": "400.132",
  "message": "Capture not found.",
  "customerFacingMessage": "Capture not found.",
  "actionCode": "Unavailable",
  "fieldReference": ""
 }
]