Skip to content

Commit a2a0c20

Browse files
committed
update method specific params
1 parent 506a2e5 commit a2a0c20

File tree

1 file changed

+55
-27
lines changed

1 file changed

+55
-27
lines changed

src/binders/payments/parameters.ts

Lines changed: 55 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export type CreateParameters = Pick<
5656
*
5757
* For documentation on how to get this token, see /wallets/applepay-direct-integration.
5858
*
59-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=applePayPaymentToken#apple-pay
59+
* @see https://docs.mollie.com/reference/extra-payment-parameters#apple-pay
6060
*/
6161
applePayPaymentToken?: string;
6262
/**
@@ -66,68 +66,96 @@ export type CreateParameters = Pick<
6666
/**
6767
* The date the payment should expire, in `YYYY-MM-DD` format. **Note:** the minimum date is tomorrow and the maximum date is 100 days after tomorrow.
6868
*
69-
* After you created the payment, you can still update the `dueDate` via /reference/v2/payments-api/update-payment.
69+
* After you created the payment, you can still update the `dueDate` via [Update payment](https://docs.mollie.com/reference/update-payment).
7070
*
71-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=dueDate#bank-transfer
71+
* @see https://docs.mollie.com/reference/extra-payment-parameters#bank-transfer
7272
*/
7373
dueDate?: string;
7474
/**
75-
* The card token you got from Mollie Components. The token contains the card information (such as card holder, card number, and expiry date) needed to complete the payment.
75+
* When creating credit card payments using Mollie Components, you need to provide the card token you received from the card component in this field. The token represents the customer's card information needed to complete the payment.
7676
*
77-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=cardToken#credit-card
77+
* __Note:__ field only valid for `oneoff` and `first` payments. For recurring payments, the `customerId` alone is enough.
78+
*
79+
* @see https://docs.mollie.com/reference/extra-payment-parameters#credit-card
7880
*/
7981
cardToken?: string;
8082
/**
8183
* The unique identifier used for referring to a terminal. This ID is used for assigning the payment to a specific terminal and it can be retrieved via List terminals. For more information about
8284
* point-of-sale payments, please check our guide point-of-sale payments.
8385
*
84-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=terminalId#point-of-sale
86+
* @see https://docs.mollie.com/reference/extra-payment-parameters#point-of-sale
8587
*/
8688
terminalId?: string;
8789
/**
88-
* The card number on the gift card. You can supply this to prefill the card number.
90+
* The card token you received from the card component of Mollie Components. The token represents the customer's card information needed to complete the payment.
8991
*
90-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=voucherNumber#gift-cards
92+
* @see https://docs.mollie.com/reference/extra-payment-parameters#gift-card
9193
*/
9294
voucherNumber?: string;
9395
/**
94-
* The PIN code on the gift card. You can supply this to prefill the PIN, if the card has any.
96+
* The PIN on the gift card. You can supply this to prefill the PIN, if the card has any.
9597
*
96-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=voucherPin#gift-cards
98+
* @see https://docs.mollie.com/reference/extra-payment-parameters#gift-card
9799
*/
98100
voucherPin?: string;
99101
/**
100-
* The unique ID you have used for the PayPal fraud library. You should include this if you use PayPal for an on-demand payment. The maximum character length is 32.
102+
* The customer's date of birth. If not provided via the API, iDeal in3 will ask the customer to provide it during the payment process.
103+
*
104+
* @see https://docs.mollie.com/reference/extra-payment-parameters#ideal-in3
105+
*/
106+
consumerDateOfBirth?: string;
107+
/**
108+
* For some industries, additional purchase information can be sent to Klarna to increase the authorization rate. You can submit your extra data in this field if you have agreed upon this with Klarna.
109+
* This field should be an object containing any of the allowed keys and sub-objects described at the [Klarna Developer Documentation](https://docs.klarna.com/api/extra-merchant-data/).
110+
*
111+
* Reach out to your account manager at Mollie to enable this feature with Klarna, and to agree on which fields you can send.
112+
*
113+
* @see https://docs.mollie.com/reference/extra-payment-parameters#klarna
114+
*/
115+
extraMerchantData?: Record<string, unknown>;
116+
/**
117+
* Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization that is completing the payment. It is recommended to include these parameters up front for a seamless flow.
118+
* Otherwise, Billie will ask the customer to complete the missing fields during checkout.
119+
*
120+
* @see https://docs.mollie.com/reference/extra-payment-parameters#billie
121+
*/
122+
company?: {
123+
/**
124+
* The organization's registration number.
125+
*/
126+
registrationNumber: string;
127+
/**
128+
* The organization's VAT number.
129+
*/
130+
vatNumber: string;
131+
/**
132+
* The organization's entity type.
133+
*/
134+
entityType: string;
135+
};
136+
/**
137+
* The unique ID you have used for the PayPal fraud library. You should include this if you use PayPal for an on-demand payment.
101138
*
102139
* Refer to the Recurring payments guide for more information on how to implement the fraud library.
103140
*
104-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=sessionId#paypal-method-details
141+
* @see https://docs.mollie.com/reference/extra-payment-parameters#paypal
105142
*/
106143
sessionId?: string;
107144
/**
108-
* Indicate if you are about to deliver digital goods, like for example a license. Setting this parameter can have consequences for your Seller Protection by PayPal. See [PayPal's help
109-
* article](https://www.paypal.com/us/brc/article/seller-protection) about Seller Protection for more information.
145+
* Indicate if you are about to deliver digital goods, such as for example a software license. Setting this parameter can have consequences for your PayPal Seller Protection.
146+
* Refer to [PayPal's documentation]https://www.paypal.com/us/brc/article/seller-protection) for more information.
110147
*
111148
* Default: `false`
112149
*
113-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=digitalGoods#paypal-method-details
150+
* @see https://docs.mollie.com/reference/extra-payment-parameters#paypal
114151
*/
115152
digitalGoods?: boolean;
116153
/**
117-
* Used for consumer identification. Use the following guidelines to create your `customerReference`:
118-
*
119-
* - Has to be unique per shopper
120-
* - Has to remain the same for one shopper
121-
* - Should be as disconnected from personal data as possible
122-
* - Must not contain customer sensitive data
123-
* - Must not contain the timestamp
124-
* - Must not contain the IP address
125-
*
126-
* Due to data privacy regulations, make sure not to use any personal identifiable information in this parameter.
154+
* Used by paysafecard for customer identification across payments. When you generate a customer reference yourself, make sure not to put personal identifiable information or IP addresses in the customer reference directly.
127155
*
128-
* If not provided, Mollie will send a hashed version of the shopper IP address.
156+
* If not provided, Mollie will use a hashed version of the customer's IP address.
129157
*
130-
* @see https://docs.mollie.com/reference/v2/payments-api/create-payment?path=customerReference#paysafecard
158+
* @see https://docs.mollie.com/reference/extra-payment-parameters#paysafecard
131159
*/
132160
customerReference?: string;
133161
/**

0 commit comments

Comments
 (0)