riverty logo

Docs

Path

POST /api/v3/checkout/authorize

Request Body

application/json

checkoutId
string
Unique identifier of checkout process in UUID format. Required only in the Two-Step Authorize use-case.
merchantId
string > 50 Characters
Merchant ID within the Riverty system, part of the credentials used for Riverty Netherlands and Belgium. If you were not provided these credentials by your Account Manager, leave empty.
payment
required
object
Payment information
customer
object
Checkout customer. Can be remitter or receiver of the order.
deliveryCustomer
object
Checkout customer. Can be remitter or receiver of the order.
order
object
Order object
parentTransactionReference
string > 128 Characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
additionalData
object
Additional data
yourReference
string > 20 Characters
Can be used by purchasing company if they would like to provide internal reference
ourReference
string
Can be used by selling company if they would like to provide specific reference for purchasing company. This field is limited to 20 characters, longer values will be truncated to fit within the specified limit.
einvoiceInformation
object
e-invoice references information
nonce
string
Unique string provided by Riverty if the merchant is using Hosted Fields. Contact your Key Account Manager for more details.

Responses

Successful RequestSuccessful Request, SCAUnsuccessful Request, Failed Risk Check

Response Example

    
        {
 "outcome": "Accepted",
 "customerNumber": "AP000100888",
 "reservationId": "f0d7e939-6e43-4fe6-93e5-79b6aba984cf",
 "checkoutId": "e907c794-de5a-436e-9676-904ee0c55360",
 "expirationDate": "2023-10-22"
}
    

Request Example

    
        {
 "payment": {
  "type": "Invoice"
 },
 "customer": {
  "identificationNumber": "800119-3989",
  "firstName": "Astrid",
  "lastName": "Svensson",
  "salutation": "Mrs",
  "email": "astrid.svensson@example.com",
  "birthDate": "1999-01-02",
  "mobilePhone": "12345678900",
  "customerCategory": "Person",
  "address": {
   "street": "Gütersloher Straße",
   "streetNumber": "123",
   "postalCode": "33415",
   "postalPlace": "Berlin",
   "countryCode": "DE"
  },
  "conversationLanguage": "EN"
 },
 "order": {
  "number": "riverty1",
  "totalGrossAmount": 185,
  "totalNetAmount": 155.41,
  "currency": "EUR",
  "items": [
   {
    "productId": "4534-BLK-M",
    "description": "Leather jacket, Black, size M",
    "grossUnitPrice": 100,
    "netUnitPrice": 84,
    "quantity": 1,
    "vatPercent": 19,
    "vatAmount": 16,
    "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
   },
   {
    "productId": "5745-GRY-M",
    "description": "Socks, Grey, Size M",
    "grossUnitPrice": 10,
    "netUnitPrice": 8.4,
    "quantity": 5,
    "vatPercent": 19,
    "vatAmount": 1.6,
    "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
   },
   {
    "productId": "3323-BRN-M",
    "description": "Woolen hat, brown, Size M",
    "grossUnitPrice": 30,
    "netUnitPrice": 25.21,
    "quantity": 1,
    "vatPercent": 19,
    "vatAmount": 4.79,
    "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
   },
   {
    "productId": "SHIP",
    "description": "Shipping",
    "type": "ShippingFee",
    "grossUnitPrice": 5,
    "netUnitPrice": 4.2,
    "quantity": 1,
    "vatPercent": 19,
    "vatAmount": 0.8
   }
  ]
 }
}