riverty logo

Docs

Path

POST /api/v3/hosted-checkout/request

Request Body

application/json

authorizeRequest
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.
merchantUrl
string
URL to redirect the customer to after the payment process
webhookUrl
string
WebhookUrl used for callback when order has final state

Responses

Successful Request, InvoiceSuccessful Request, Direct DebitUnsuccessful Call, Validation Error

Response Example

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

Request Example

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