Example Riverty Transaction

post

https://secure-staging.curopayments.net/rest/v1/curo/payment/riverty

Create a new Riverty (formerly Afterpay) payment transaction.

This is the riverty variant of the generic
Create Transaction entry point;

the request body and response shown below apply to Riverty only.

Entry points: /rest/v1/curo/payment/riverty/ or /rest/v1/curo/payment/afterpay/ (legacy).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for a Riverty payment (payment_method = riverty).
Riverty (formerly Afterpay) allows consumers to pay after receiving the goods.
Beside the default parameters you supply the consumer and cartitems containers.

Notes:

afterpay is a legacy alias of riverty; in the callback the payment type (pt)
will be either riverty or afterpay, depending on the entry point used.
CURO creates the Riverty transaction as "Not Shipped"; after shipping the products
the order must be captured (confirmed) before Riverty starts collecting.
If not all required fields are specified you will receive an error or warning
container in the response, and the consumer is redirected to the standard internal
Riverty form where the missing data can be filled out.
If you collect all required data on your own website, you must show the Riverty
Terms and Conditions and have the consumer agree to them via a checkbox.

site_id

integer

required

≤ 9999999999

Merchant's site ID.

url_success

string

required

length ≤ 255

Valid return URL beginning with http:// or https:// where a consumer will be redirected after payment.

url_pending

string

length ≤ 255

Optional return URL for pending payments. The url_success will be used if not specified.

url_failure

string

required

length ≤ 255

Return URL for failed payments.

url_cancel

string

length ≤ 255

Optional return URL for cancelled payments. The url_failure will be used if not specified.

url_callback

string

length ≤ 255

URL which will receive transaction updates automatically; please check Callback for more information. (recommended)

reference

string

required

length ≤ 255

Unique merchant identification for a transaction.

amount

integer

required

1 to 9999999999

The amount in cents (with no decimal separator).

currency_id

string

required

^[A-Z]{3}$

Currency in which payment should be effected, expressed using the three-letter international currency code as per ISO-4217.

string

length ≤ 255

Consumer's email address.
Required if it is not included in the consumer container.

description

string

required

length ≤ 128

Transaction description which will be presented to the user if supported by the payment method.

info

string

length ≤ 255

Extra information to store with the transaction.

string

required

length ≤ 64

Consumer's IP address.
Note: although IP6 addresses are supported by CURO, most payment methods (still) don't support it.
Please do not use your own (host) IP as this may cause it to be blocked or throttled!
Private IP ranges will also be refused by this API. Use 0.0.0.0 to indicate unknown.

country_id

string

length ≤ 2

ISO country code of the consumer.

language_id

string

length ≤ 2

This field enables the issuer's site to select the consumer's preferred language.
Possible options: cz (Czech), hr (Croatian), da/dk (Danish), nl (Dutch), en (English, default),
fr (French), fi (Finnish), de (German), gr (Greek), hu (Hungarian), it (Italian),
no (Norwegian), pl (Polish), pt (Portuguese), ru (Russian), es (Spanish), se (Swedish), tr (Turkish).

platform_name

string

length ≤ 64

Optional name of the e-commerce platform integrating with the API (e.g. "PHP", "Magento").

platform_version

string

length ≤ 32

Optional version of the e-commerce platform.

plugin_name

string

length ≤ 64

Optional name of the plugin/integration used.

plugin_version

string

length ≤ 32

Optional version of the plugin/integration used.

consumer

object

required

Consumer and shipping information for this transaction. Some fields are required depending on payment method.

cartitems

array of objects

required

The cart items of the webshop order.

cartitems*

Responses

200Transaction created successfully.

400Bad Request.

403Authorisation failed.