Riverty Invoice

The complete Buy Now Pay Later ecosystem for ecommerce which keeps your brand in the lead while offering an array of services to build loyal customers.

Source: https://docs.riverty.com/bnpl

Features

Integration type

Redirection

Tokenization

No

Payment flow

1-step payment flow

Capture

2-step payment flow

Authorization + Capture

3-step payment flow

Pending Authorization + Authorization + Capture

Client-side Integration Mode Compatibility

Integration Mode	Supported
Headless (SDK)
Hosted Fields
Hosted Form
Hosted Page

UI options

You can customize the UI of the payment form by using the hostedForm parameter.

// Assuming you have a payment method object
paymentMethod.getPaymentElement({
    hostedForm: {
        birthdatePlaceholder: "Birthdate",
        birthdateInputLabel: "Birthdate",
        birthdateRequiredError: "Birthdate is required",
        birthdateFormatError: "Birthdate format is incorrect",
        birthdateCannotBeEmptyError: "Birthdate cannot be empty",
        birthdateOutOfRangeError: "Under 18 years old",
        consentText: "Please read <a href='{{url}}'>the terms and conditions</a>",
        consentInputLabel: 'I agree to the terms and conditions', // only if consent required
        consentRequiredError: 'You must agree to the terms and conditions' // only if consent required
    }
})

You can pass html to the consentText parameter to customize the consent text. See the PurseHeadlessCheckoutHostedFormUIOptions reference for more information.

Payment Operations Available

Type	Capture	Refund	Void
Partial
Total
Multiple

Additional features

Information request and CIT

MIT

Server-to-server

How to test?

Information

You can make a test by using the following birthdate scenarios below

TestCases

Scenario	Condition
Session Success	Birthdate over 18 years old
Session Refused	Birthdate under 18 years old

PartialActions

Information

To make partial actions such as Capture, Void, or Refund, you should send data about the items to be captured, voided, or refunded.

Code Examples

Request

curl --location --request POST 'https://api.purse-sandbox.com/payment/v1/${ENTITY_ID}/transactions/{{TRANSACTION_ID}}/capture' --header 'x-api-key: ${API_KEY}' --header 'Authorization: Bearer ${ACCESS_TOKEN}' --header 'Content-Type: application/json' --data-raw '{"amount":150.0,"order":{"shipments":[{"item_lines":[{"type_code":"product","sku_reference":"0a4b243e-f607-45cf-878c-e6c46aed9648","name":"Lits superposés 3 niveaux LIGNE EVEREST","price":860.0,"quantity":1,"amount":860.0,"tax_lines":[{"type_code":"vat","subtype_code":"standard","rate":8.1,"amount":64.44}]},{"type_code":"shipping_fees","sku_reference":"shipping_fees","name":"shipping fees","price":79.0,"quantity":1,"amount":79.0,"tax_lines":[{"type_code":"vat","subtype_code":"standard","rate":8.1,"amount":5.92}]}]}]}}'

Response

{
  "id": "568082dc-48df-4bec-b87c-fff3dd0e69d8",
  "status": {
    "action": "CAPTURE",
    "state": "SUCCESS",
    "description": "Successful operation"
  },
  "amount": 150,
  "logs": {
    "CAPTURED_AMOUNT": "150.0",
    "REMAINING_AUTHORIZED_AMOUNT": "200.0000",
    "TOTAL_CAPTURED_AMOUNT": "150.0000"
  }
}

Data Mapping & Mandatory Fields

Below is the mapping between your Create Session request and the fields expected by this payment method.

Purse Session field	Mandatory
amount	Yes
order.redirection	Yes
order.amount	No
order.net_amount	Yes
order.reference	Yes
order.tax_amount	No
order.tax_lines_rate	No
order.currency_code	Yes
customer.reference	No
customer.company_name	No
customer.type_code	Yes
customer.gender_code	No
customer.last_name	Yes
customer.first_name	Yes
customer.birthdate	Yes
customer.ip	Yes
customer.billing_address.gender_code	No
customer.billing_address.first_name	Yes
customer.billing_address.last_name	Yes
customer.billing_address.address_lines	No
customer.billing_address.city	No
customer.billing_address.postal_code	No
customer.billing_address.country_code	No
customer.billing_address.email	Yes
customer.billing_address.phone	Yes
customer.billing_address.mobile_phone	No
customer.additional_attributes.national_identifier	No
shipments.amount	No
shipments.delivery_type_code	No
shipments.shipping_address.first_name	Yes
shipments.shipping_address.last_name	Yes
shipments.shipping_address.address_lines	No
shipments.shipping_address.city	No
shipments.shipping_address.postal_code	No
shipments.shipping_address.country_code	No
shipments.shipping_address.email	Yes
shipments.shipping_address.phone	No
shipments.shipping_address.mobile_phone	No
shipments.item_lines.type_code	No
shipments.item_lines.sku_reference	No
shipments.item_lines.name	Yes
shipments.item_lines.price	Yes
shipments.item_lines.quantity	Yes
shipments.item_lines.amount	No
shipments.item_lines.image_uri	No
shipments.item_lines.product_uri	No
shipments.item_lines.tax_lines.amount	No
shipments.item_lines.tax_lines.rate	No

Status

PSP status	State	Code	Description
SESSION_DATA_NOT_OK	SUCCESS	BAD_REQUEST	Session data doesn't meet the partner's requirements
SUCCESS	SUCCESS	SUCCEEDED	Successful operation
Pending	WAITING	WAITING_PARTNER_RESPONSE	Transaction awaiting response to authorization request
ABORTED	ERROR	ABORTED_BY_CUSTOMER	Transaction aborted
Expired	ERROR	ABORTED_BY_CUSTOMER	Transaction expired
Rejected	ERROR	FAILED	Authorize checkout Outcome
NotEvaluated	ERROR	REJECTED_BY_RISK_CHECKS	Authorize checkout Outcome
Accepted	SUCCESS	SUCCEEDED	Successful operation
ERROR	ERROR	FAILED	Failed operation
400.000	ERROR	BAD_REQUEST	Unknown error
400.001	ERROR	BAD_REQUEST	Request body missing
400.002	ERROR	BAD_REQUEST	Value is required
400.003	ERROR	BAD_REQUEST	Value out of range
400.004	ERROR	BAD_REQUEST	Value format is incorrect
400.005	ERROR	BAD_REQUEST	A string value exceeds maximum length of {value}
400.006	ERROR	BAD_REQUEST	A string value with minimum length {value} is required
400.007	ERROR	BAD_REQUEST	A decimal value has more than allowed decimal digits
400.100	ERROR	BAD_REQUEST	Order number is already used on the client
400.101	ERROR	BAD_REQUEST	TotalNetAmount doesn't match with items prices
400.102	ERROR	BAD_REQUEST	Order gross amount doesn't match with items prices
400.103	ERROR	BAD_REQUEST	The provided customerNumber differs from the customerNumber specified in the checkout
400.108	ERROR	BAD_REQUEST	Invalid payment method selected
400.109	ERROR	BAD_REQUEST	A valid contract id is required
400.110	ERROR	BAD_REQUEST	Installment profile not found
400.111	ERROR	BAD_REQUEST	Installment profile plans missing
400.112	ERROR	BAD_REQUEST	Monthly installment amount is invalid
400.113	ERROR	BAD_REQUEST	Number of installments is not allowed for amount
400.114	ERROR	BAD_REQUEST	Invalid AccountProfileNo
400.115	ERROR	BAD_REQUEST	Reservation not found
400.117	ERROR	BAD_REQUEST	Cannot capture the order because full capture can only be done for the entire reserved amount within the given tolerance level.
400.118	ERROR	BAD_REQUEST	Capture partial cannot capture more than the current reservation balance
400.119	ERROR	BAD_REQUEST	Order items missing
400.120	ERROR	BAD_REQUEST	Cannot capture the order as capture with the specified number is already exists
400.121	ERROR	BAD_REQUEST	Reservation, to which this order is linked to does not have a checkout
400.122	ERROR	BAD_REQUEST	Cannot create refund as invoice number already exists
400.124	ERROR	BAD_REQUEST	The grand total of gross unit prices must be positive
400.126	ERROR	BAD_REQUEST	Cannot refund the order because specified capture was not created from reservation, to which this order is linked to
400.127	ERROR	BAD_REQUEST	Cannot refund the order as refund amount is higher than the capture balance amount
400.128	ERROR	BAD_REQUEST	Cannot refund the order because there are no captures related to this order
400.129	ERROR	BAD_REQUEST	Cannot cancel the order, because it is partially or fully captured
400.131	ERROR	BAD_REQUEST	Order not found
400.132	ERROR	BAD_REQUEST	Capture not found
400.133	ERROR	BAD_REQUEST	Refund not found
400.134	ERROR	BAD_REQUEST	Void not found
400.135	ERROR	BAD_REQUEST	Customer not found
400.136	ERROR	BAD_REQUEST	Contract already exists
400.137	ERROR	BAD_REQUEST	When order items are provided then capture number is mandatory
400.138	ERROR	BAD_REQUEST	Shipping details not found
400.139	ERROR	BAD_REQUEST	Valid BankCode is required
400.140	ERROR	BAD_REQUEST	Valid BankAccount is required
400.142	ERROR	BAD_REQUEST	Checkout not found
400.144	ERROR	BAD_REQUEST	Validation failed
400.146	ERROR	BAD_REQUEST	Capture amount can't be with opposite sign to Reservation amount
400.147	ERROR	BAD_REQUEST	Void amount can't be with opposite sign to Reservation amount
400.148	ERROR	BAD_REQUEST	Cannot refund a negative invoice
400.150	ERROR	BAD_REQUEST	Installment profile is not valid for amount
400.151	ERROR	BAD_REQUEST	IdempotencyKey is aleady used with different endpoint URL
400.152	ERROR	BAD_REQUEST	DirectDebit is not enabled for client
400.153	ERROR	BAD_REQUEST	A valid order number can include alphanumeric characters, dashes and underscores
400.154	ERROR	BAD_REQUEST	totalGrossAmount cannot be negative
400.155	ERROR	BAD_REQUEST	In case of partial request the totalGrossAmount is required
400.156	ERROR	BAD_REQUEST	The country code is not valid for this customer
400.157	ERROR	BAD_REQUEST	The currency code is not valid for this customer
400.158	ERROR	BAD_REQUEST	Reservation is already cancelled, captured, or expired
400.159	ERROR	BAD_REQUEST	Item gross price, net price and VAT amount must be all positive or all negative
400.160	ERROR	BAD_REQUEST	Gross unit price must be equal to Net unit price plus VAT amount
400.161	ERROR	BAD_REQUEST	Item net price can't be bigger than gross price
400.162	ERROR	BAD_REQUEST	Item VAT amount can't be bigger than gross price
400.166	ERROR	BAD_REQUEST	The provided currency differs from the currency specified in the checkout
400.167	ERROR	BAD_REQUEST	File format is not supported. We support the following formats: {value}
400.168	ERROR	BAD_REQUEST	Order items must be specified if order amount is increased within the allowed tolerance level
400.169	ERROR	BAD_REQUEST	Order items must be specified if order amount has changed
400.170	ERROR	BAD_REQUEST	Full refund is not allowed after partial refund.
400.171	ERROR	BAD_REQUEST	Cannot refund the order as the total refund amount exceeds the maximum allowed amount.
400.172	ERROR	BAD_REQUEST	The maximum Idempotency Key length is 50 characters.
400.173	ERROR	BAD_REQUEST	The Idempotency key may contain alphanumeric characters and hyphens.
400.174	ERROR	BAD_REQUEST	Active campaign not found.
400.175	ERROR	BAD_REQUEST	The merchant id is not valid.
400.176	ERROR	BAD_REQUEST	The merchant id is deactivated.
400.177	ERROR	BAD_REQUEST	Too many operations with zero amount for this order.
400.178	ERROR	BAD_REQUEST	Account number is not supported.
400.179	ERROR	BAD_REQUEST	B2B customers not supported for this region.
400.180	ERROR	BAD_REQUEST	Nonce not found.
400.181	ERROR	BAD_REQUEST	A valid customer card classification can include only digits from 1 to 5.
400.182	ERROR	BAD_REQUEST	Virtual bank account not found.
400.183	ERROR	BAD_REQUEST	The checkout is already used by reservation.
400.184	ERROR	BAD_REQUEST	totalGrossAmount is higher than order amount.
400.185	ERROR	BAD_REQUEST	Both, orderItems and items are used. Please use one or another.
400.186	ERROR	BAD_REQUEST	Operation is rejected as reservation is in pending state.
200.001	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the age you entered does not meet the minimum requirement (18 years), please choose a different payment method or reenter your date of birth
200.002	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, B2B purchases are not allowed for this merchant. Please choose another payment method
200.003	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method
200.004	ERROR	REJECTED_BY_RISK_CHECKS	Pick-Up-point can not be used as billing address
200.005	ERROR	REJECTED_BY_RISK_CHECKS	Address of the Pick-Up-point is invalid, please doublecheck and correct it
200.006	ERROR	REJECTED_BY_RISK_CHECKS	Billing and delivery address must be the same
200.101	ERROR	REJECTED_BY_RISK_CHECKS	This billing address is invalid, please double check and correct it
200.102	ERROR	REJECTED_BY_RISK_CHECKS	This delivery address is invalid, please double check and correct it
200.103	ERROR	REJECTED_BY_RISK_CHECKS	The billing address was corrected, please verify (not sent for DACH and Benelux)
200.104	ERROR	REJECTED_BY_RISK_CHECKS	The delivery address was corrected, please verify (not sent for DACH and Benelux)
200.105	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method (not sent for DACH and Benelux)
200.900	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method
200.901	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method
200.902	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method
200.903	ERROR	REJECTED_BY_RISK_CHECKS	Sorry, the payment method is currently not available. Please choose another payment method
200.909	ERROR	REJECTED_BY_RISK_CHECKS	Account number from this country is not supported for this Riverty merchant
200.910	ERROR	REJECTED_BY_RISK_CHECKS	Strong identification needed