@sumup/sdk
Version:
The official TypeScript SDK for the SumUp API
130 lines • 4.18 kB
text/typescript
/**
* CreateReaderCheckoutRequest
*
* Reader Checkout
*/
export type CreateReaderCheckoutRequest = {
/**
* Optional object containing data for transactions from ERP integrators in Greece that comply with the AADE 1155 protocol.
* When such regulatory/business requirements apply, this object must be provided and contains the data needed to validate the transaction with the AADE signature provider.
*
*/
aade?: {
/**
* The identifier of the AADE signature provider.
*/
provider_id: string;
/**
* The base64 encoded signature of the transaction data.
*/
signature: string;
/**
* The string containing the signed transaction data.
*/
signature_data: string;
};
/**
* Affiliate
*
* Affiliate metadata for the transaction.
* It is a field that allow for integrators to track the source of the transaction.
*
*/
affiliate?: {
/**
* Application ID of the affiliate.
* It is a unique identifier for the application and should be set by the integrator in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.
*
*/
app_id: string;
/**
* Foreign transaction ID of the affiliate.
* It is a unique identifier for the transaction.
* It can be used later to fetch the transaction details via the [Transactions API](https://developer.sumup.com/api/transactions/get).
*
*/
foreign_transaction_id: string;
/**
* Key of the affiliate.
* It is a unique identifier for the key and should be generated by the integrator in the [Affiliate Keys](https://developer.sumup.com/affiliate-keys) page.
*
*/
key: string;
/**
* Additional metadata for the transaction.
* It is key-value object that can be associated with the transaction.
*
*/
tags?: Record<string, unknown>;
} | null;
/**
* The card type of the card used for the transaction.
* Is is required only for some countries (e.g: Brazil).
*
*/
card_type?: "credit" | "debit";
/**
* Description of the checkout to be shown in the Merchant Sales
*/
description?: string;
/**
* Number of installments for the transaction.
* It may vary according to the merchant country.
* For example, in Brazil, the maximum number of installments is 12.
*
* Omit if the merchant country does support installments.
* Otherwise, the checkout will be rejected.
*
*/
installments?: number | null;
/**
* Webhook URL to which the payment result will be sent.
* It must be a HTTPS url.
*
*/
return_url?: string;
/**
* List of tipping rates to be displayed to the cardholder.
* The rates are in percentage and should be between 0.01 and 0.99.
* The list should be sorted in ascending order.
*
*/
tip_rates?: number[];
/**
* Time in seconds the cardholder has to select a tip rate.
* If not provided, the default value is 30 seconds.
*
* It can only be set if `tip_rates` is provided.
*
* **Note**: If the target device is a Solo, it must be in version 3.3.38.0 or higher.
*
*/
tip_timeout?: number;
/**
* Money
*
* Amount structure.
*
* The amount is represented as an integer value altogether with the currency and the minor unit.
*
* For example, EUR 1.00 is represented as value 100 with minor unit of 2.
*
*/
total_amount: {
/**
* Currency ISO 4217 code
*/
currency: string;
/**
* The minor units of the currency.
* It represents the number of decimals of the currency. For the currencies CLP, COP and HUF, the minor unit is 0.
*
*/
minor_unit: number;
/**
* Integer value of the amount.
*/
value: number;
};
};
//# sourceMappingURL=create-reader-checkout-request.d.cts.map