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

array

Collection of captures

reservationId

string

Reservation ID.

customerNumber

string

Max length: 100

Customer number.

captureNumber

string

Max length: 50

Capture number.

orderNumber

string

Max length: 50

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

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Indicates the capture creation time.

updatedAt

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Indicates the time when the capture was last updated.

directDebitBankAccount

string

Max length: 34

Direct debit bank account.

directDebitSwift

string

Max length: 11

Direct debit swift.

accountProfileNumber

integer

Account profile number.

numberOfInstallments

integer

Number of installments.

installmentAmount

number

Installment amount.

contractDate

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Contract date.

orderDate

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Order date.

installmentProfileNumber

integer

Installment profile number.

parentTransactionReference

string

Max length: 128

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

transactionReference

string

Max length: 100

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

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Due date.

invoiceDate

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Invoice date.

yourReference

string

Max length: 20

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

ourReference

string

Max length: 128

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

invoiceProfileNumber

integer

Invoice profile number.

ocr

string

Max length: 27

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

installmentCustomerInterestRate

number

Installment customer interest rate.

imageUrl

string

Max length: 2048

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

Max length: 50

Product User.

costCenter

string

Max length: 50

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

array

Capture items.

productId

required

string

Max length: 100

Merchant Product identification number.

groupId

string

Max length: 255

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 255 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

Max length: 50

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

Max length: 2048

googleProductCategoryId

integer

Google product category ID.

googleProductCategory

string

Max length: 255

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

Max length: 255

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

Max length: 2048

URL to the product.

marketPlaceSellerId

string

Max length: 32

ID of an individual seller on a marketplace. If this field is used, an entry in the element additionalData -> marketplace must also be provided.

parentTransactionReference

string

Max length: 128

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

additionalInformation

string

Max length: 4096

Extended description of the order item.

specification

N/A

Specification.

serviceStart

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Capture start time.

serviceEnd

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

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": ""
 }
]