CheckoutCreateRequest.md

SumUpRestApi.CheckoutCreateRequest

Properties

Name	Type	Description	Notes
checkoutReference	String	Unique ID of the payment checkout specified by the client application when creating the checkout resource.
amount	Number	Amount of the payment.
currency	Currency
merchantCode	String	Unique identifying code of the merchant profile.
payToEmail	String	Email address of the registered user (merchant) to whom the payment is made. It is highly recommended to use `merchant_code` instead of `pay_to_email`.	[optional]
description	String	Short description of the checkout visible in the SumUp dashboard. The description can contribute to reporting, allowing easier identification of a checkout.	[optional]
returnUrl	String	URL to which the SumUp platform sends the processing status of the payment checkout.	[optional]
customerId	String	Unique identification of a customer. If specified, the checkout session and payment instrument are associated with the referrenced customer.	[optional]
id	String	Unique ID of the checkout resource.	[optional]
status	String	Currrent status of the checkout.	[optional]
_date	Date	Date and time of the creation of the payment checkout. Response format expressed according to <a href=&quot;https://en.wikipedia.org/wiki/ISO_8601\" target=&quot;_blank&quot; rel=&quot;noopener&quot;>ISO8601</a> code.	[optional]
validUntil	Date	Date and time of the checkout expiration before which the client application needs to send a processing request. If no value is present, the checkout does not have an expiration time.	[optional]
transactions	[AllOfCheckoutCreateRequestTransactionsItems]	List of transactions related to the payment.	[optional]
redirectUrl	String	Required for 3DS checkouts. Refers to a url where the end user is redirected once the payment processing completes.	[optional]
paymentType	String	Alternative payment method name	[optional]
personalDetails	CheckoutCreateRequestPersonalDetails		[optional]

Enum: StatusEnum

• PENDING (value: "PENDING")
• FAILED (value: "FAILED")
• PAID (value: "PAID")