riverty logo

Docs

Get Available Payment Methods

See the detailed API documentation for more information.

Why "Get Available Payment Methods" is Important

Riverty suggests using the Get Available Payment Methods before every Authorize call. Get Available Payment Methods serves two main purposes:

  1. To check the Merchant contract terms before showing payment methods during the consumer checkout, stopping payment methods not found in the merchant's contract from being shown
  2. To calculate the monthly payment amount shown to the consumer during checkout for Fixed Installments, along with any interest associated with Fixed Installments

Please note: The Get Available Payment Methods call is required to show the Fixed Installments payment method.

An Example

Astrid adds her desired items to her cart in the webshop, confirms her shopping cart, and then clicks "Go to Checkout." The webshop sends this data to Riverty's PAYMENT-METHODS endpoint and Riverty responds with a list of payment options for Astrid:

Campaign Invoice, Direct Debit, and Pay-in-3 have not been returned. This is because the Merchant has decided not to run a Campaign during this season, Direct Debit is provided via the Merchant's PSP, and Astrid is purchasing from a German Merchant, so Pay-in-3 is not available.

Response Contents

  • Payment Methods – the details of the payment methods that Riverty is willing to accept for this order. There will be one or more blocks, each consisting of:
  • Type – as per Payment Methods.
  • Title – the title of this payment method, as displayed to the customer.
  • Tag – the tagline (short description) of this payment method, as displayed to the customer.
  • Logo – the URL of the Riverty logo, as displayed to the customer.
  • Account – if the type is Account, this block contains additional information about flexible monthly payments.
  • Campaigns – if the type is Invoice and campaign invoices are currently available, this block contains additional information about the campaign.
  • Direct Debit – if the type is Invoice and direct debit is configured, this block will read “true”. You will need to collect the customer’s bank account information and pass it to Riverty in the Capture call.
  • Installment – if the type is Installment, this block contains additional information about the fixed term payments.
    
        {
 "conversationLanguage": "EN",
 "order": {
  "country": "DE",
  "totalGrossAmount": "185",
  "totalNetAmount": "155.41",
  "currency": "EUR"
 }
}
    

    
        {
 "checkoutId": "d312d21a-ca45-41db-8444-c6010b6f4237",
 "outcome": "Accepted",
 "paymentMethods": [
  {
   "type": "Invoice",
   "title": "Invoice - 14 days",
   "tag": "Buy now, Pay in 14 days",
   "logo": "https://cdn.riverty.design/logo/riverty-checkout-logo.svg",
   "legalInfo": {
    "requiresCustomerConsent": false,
    "termsAndConditionsUrl": "https://documents-pt.riverty.io/terms_conditions/payment_methods/invoice/de_en/default",
    "privacyStatementUrl": "https://documents-pt.riverty.io/privacy-statement/checkout/de_en",
    "bgb507Url": "https://documents-pt.riverty.io/terms_conditions/payment_methods/fix_instalments/de_de/bgb507",
    "text": "The <a href=\"https://documents-pt.riverty.io/terms_conditions/payment_methods/invoice/de_en/default\">General Terms and Conditions</a> for the Riverty payment method apply. The Privacy Policy of Riverty can be found <a href=\"https://documents-pt.riverty.io/privacy-statement/checkout/de_en\">here</a>."
   }
  },
  {
   "type": "Consolidatedinvoice",
   "title": "Consolidated Invoice",
   "tag": "Gather all your purchases in one monthly Invoice",
   "logo": "https://cdn.riverty.design/logo/riverty-checkout-logo.svg",
   "legalInfo": {
    "requiresCustomerConsent": false,
    "termsAndConditionsUrl": "https://documents-dev.riverty.dev/terms_conditions/payment_methods/consolidated_invoice/de_en/default",
    "privacyStatementUrl": "https://documents-dev.riverty.dev/privacy-statement/checkout/de_en",
    "text": "The <a href=\"https://documents-dev.riverty.dev/terms_conditions/payment_methods/consolidated_invoice/de_en/default\">General Terms and Conditions</a> for the Riverty payment method apply. The Privacy Policy of Riverty can be found <a href=\"https://documents-dev.riverty.dev/privacy-statement/checkout/se_en\">here</a>."
   }
  },
  {
   "type": "Installment",
   "title": "Instalments",
   "tag": "From 35.52€ per month",
   "logo": "https://cdn.riverty.design/logo/riverty-checkout-logo.svg",
   "installment": {
    "basketAmount": 185,
    "numberOfInstallments": 6,
    "installmentAmount": 35.52,
    "firstInstallmentAmount": 45.02,
    "lastInstallmentAmount": 35.46,
    "interestRate": 19.5,
    "effectiveInterestRate": 21.34,
    "effectiveAnnualPercentageRate": 97.61,
    "totalInterestAmount": 10.67,
    "startupFee": 9.5,
    "monthlyFee": 2.9,
    "totalAmount": 222.56,
    "installmentProfileNumber": 2,
    "readMore": "https://documents-dev.riverty.dev/terms_conditions/payment_methods/secci_fix_instalments/fi_en/f02610d6-d60c-4a9f-82fa-409d1ed6b9bf?source=readMore"
   },
   "legalInfo": {
    "requiresCustomerConsent": false,
    "termsAndConditionsUrl": "https://documents-dev.riverty.dev/terms_conditions/payment_methods/fix_instalments/de_en/56319/200.00_1_12_24.13_5.00_5.12_5.45_6.00_7.00_295.46",
    "secciUrl": "https://documents-dev.riverty.dev/terms_conditions/payment_methods/secci_fix_instalments/de_en/8d0e0785-918d-4af2-a120-7cad07acde25",
    "privacyStatementUrl": "https://documents-dev.riverty.dev/privacy-statement/checkout/de_en",
    "text": "The <a href=\"https://documents-dev.riverty.dev/terms_conditions/payment_methods/fix_instalments/de_en/56319/200.00_1_12_24.13_5.00_5.12_5.45_6.00_7.00_295.46\">General Terms and Conditions</a> for the Riverty payment method apply. The Privacy Policy of Riverty can be found <a href=\"https://documents-dev.riverty.dev/privacy-statement/checkout/de_en\">here</a>."
   }
  }
 ]
}