Skip to Main Content
Riverty Docs
  • Get Started
  • Login
riverty logo Docs

Hosted Checkout

More information can be found in our Documentation.

Path

POST /api/v3/hosted-checkout/request

Request Body

application/json

webhookUrl
string
WebhookUrl used for callback when order has final state
array
Payment selection object used for request payment selection page
object
Authorize payment request. In case of One-Step Authorize, customer and order objects must be filled in addition to payment info. In case of Two-Step Authorize, only the checkoutId field must be filled.

Responses

  • 401 Authorization has been denied for this request.
  • 413 Request body too large.
  • 429 Too many requests.
  • 500 Internal server error.
Successful Request, InvoiceSuccessful Request, Consolidated InvoiceSuccessful Request, Direct DebitSuccessful Request, Pay in 3Successful Request, Fixed InstallmentsUnsuccessful Call, Validation Error

Request Example

    
        {
 "merchantUrl": "https://example.com",
 "authorizeRequest": {
  "order": {
   "items": [
    {
     "groupId": "0011",
     "quantity": 5,
     "productId": "0001",
     "vatAmount": 2,
     "vatPercent": 20,
     "description": "item 1 description",
     "netUnitPrice": 10,
     "grossUnitPrice": 12
    },
    {
     "groupId": "0022",
     "quantity": 2,
     "productId": "0002",
     "vatAmount": 20,
     "vatPercent": 20,
     "description": "item 2 description",
     "netUnitPrice": 100,
     "grossUnitPrice": 120
    }
   ],
   "number": "RIVERTY01",
   "totalNetAmount": 250,
   "totalGrossAmount": 300
  },
  "payment": {
   "type": "Invoice"
  },
  "customer": {
   "email": "astrid.svensson@example.com",
   "address": {
    "street": "Gütersloher Straße",
    "postalCode": "33415",
    "countryCode": "DE",
    "postalPlace": "Berlin",
    "streetNumber": "123"
   },
   "lastName": "Svensson",
   "firstName": "Astrid",
   "customerCategory": "Person",
   "conversationLanguage": "DE"
  }
 }
}
    

Response Example

    
        {
 "redirectUrl": "https://hosted-checkout.bnpl.riverty.io/pay/nl/098?token=123"
}