curl --request PATCH \
--url https://api.sandbox.primer.io/client-session \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-VERSION: <x-api-version>' \
--data '
{
"clientToken": "client-session-token",
"customerId": "customer-123",
"orderId": "order-abc",
"customer": {
"emailAddress": "john@primer.io"
},
"amount": 500,
"paymentMethod": {
"authorizationType": "FINAL"
},
"order": {
"lineItems": [
{
"itemId": "shoe-123",
"description": "Blue Shoe",
"amount": 100,
"quantity": 10
}
],
"countryCode": "FR"
}
}
'{
"customerId": "customer-123",
"orderId": "order-abc",
"currencyCode": "GBP",
"amount": 650,
"metadata": {
"productType": "Clothing"
},
"customer": {
"emailAddress": "john@primer.io"
},
"order": {
"lineItems": [
{
"itemId": "t-shirt-1",
"description": "White T-Shirt",
"amount": 500,
"quantity": 1
}
],
"fees": [
{
"type": "SURCHARGE",
"amount": 100
}
],
"shipping": {
"amount": 50
},
"paymentMethod": {
"vaultOnSuccess": false,
"vaultOn3DS": false,
"options": {
"GOOGLE_PAY": {
"surcharge": {
"amount": 100
}
},
"PAYMENT_CARD": {
"networks": {
"VISA": {
"surcharge": {
"amount": 10
}
},
"MASTERCARD": {
"surcharge": {
"amount": 20
}
}
}
},
"PAY_NL_IDEAL": {
"surcharge": {
"amount": 50
}
}
}
},
"authorizationType": "ESTIMATED"
}
}Update client session
You can update a clients session created earlier with the PATCH /client-session API call.
The only required field for the request is clientToken. Other supported request fields are same as for the POST /client-session API call.
You need to specify only the fields you wish to update. However, if the items to be updated are arrays (e.g.lineItems), you need to provide the entire array, including any new or modified items. Primer will replace the full array with whatever is sent in the request. If you want to keep existing items, make sure to include them in your request, anything omitted will be removed.
If you wish to update nested fields on the client session, such as the customer emailAddress field, you can pass the customer object with only one field, emailAddress, to update.
If you simply wish to clear the value of the field, pass null as your input.
You can update paymentMethod.vaultOnSuccess field but updating of the paymentMethod.options field through PATCH /client-session is not supported.
The response will contain all the fields of the client session including the ones that were changed.
curl --request PATCH \
--url https://api.sandbox.primer.io/client-session \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-VERSION: <x-api-version>' \
--data '
{
"clientToken": "client-session-token",
"customerId": "customer-123",
"orderId": "order-abc",
"customer": {
"emailAddress": "john@primer.io"
},
"amount": 500,
"paymentMethod": {
"authorizationType": "FINAL"
},
"order": {
"lineItems": [
{
"itemId": "shoe-123",
"description": "Blue Shoe",
"amount": 100,
"quantity": 10
}
],
"countryCode": "FR"
}
}
'{
"customerId": "customer-123",
"orderId": "order-abc",
"currencyCode": "GBP",
"amount": 650,
"metadata": {
"productType": "Clothing"
},
"customer": {
"emailAddress": "john@primer.io"
},
"order": {
"lineItems": [
{
"itemId": "t-shirt-1",
"description": "White T-Shirt",
"amount": 500,
"quantity": 1
}
],
"fees": [
{
"type": "SURCHARGE",
"amount": 100
}
],
"shipping": {
"amount": 50
},
"paymentMethod": {
"vaultOnSuccess": false,
"vaultOn3DS": false,
"options": {
"GOOGLE_PAY": {
"surcharge": {
"amount": 100
}
},
"PAYMENT_CARD": {
"networks": {
"VISA": {
"surcharge": {
"amount": 10
}
},
"MASTERCARD": {
"surcharge": {
"amount": 20
}
}
}
},
"PAY_NL_IDEAL": {
"surcharge": {
"amount": 50
}
}
}
},
"authorizationType": "ESTIMATED"
}
}Authorizations
Headers
Specifies the version of the API to use. This must be set to 2.4.
"2.4"
Body
Client token for use in the Primer-JS SDK obtained via POST /client-session API call.
A unique identifier for your customer.
Your reference for the order.
The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.
The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
Some currencies, such as Japanese Yen, do not have minor units. In this case you should use the value as it is, without any formatting. For example for ¥100, use 100.
If the amount is provided on this level, it would override any amount calculated from the provided line items, shipping and other amounts.
x >= 0Additional data to be used throughout the payment lifecycle.
Provide the entire object to update it. Anything provided previously will be overwritten.
More information associated with the customer.
Each of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.
Show child attributes
Show child attributes
Customer email address.
Must be a valid email address. Supports internationalized email addresses.
The customer's mobile number
1 - 256The customer's first name
1 - 256The customer's last name
1 - 256Customer billing address.
Show child attributes
Show child attributes
1 - 2561 - 256Street name, Company name or PO Box
1 - 256Apartment, Unit or Building number
256Name of the city, district, town or village
1 - 256State, County or Province
1 - 256Two letter ISO country code
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW Postal or ZIP code
1 - 256Customer shipping address
Show child attributes
Show child attributes
1 - 2561 - 256Street name, Company name or PO Box
1 - 256Apartment, Unit or Building number
256Name of the city, district, town or village
1 - 256State, County or Province
1 - 256Two letter ISO country code
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW Postal or ZIP code
1 - 256The customer's tax id number for tax exemptions
256The customer's national identification number
256More information associated with the order.
Each of the fields in this object must be updated in its entirety, i.e. provide the entire object to update it. Anything provided previously will be overwritten.
Show child attributes
Show child attributes
The details of the line items of the order.
Show child attributes
Show child attributes
The amount charged to the customer, in minor units. The minimum amount is 0. The maximum amount is the limit of int64.
x >= 0A unique identifier for the line item.
1 - 256A name of the item.
256A description of the item.
256The number of the particular line item that is being ordered.
Any discount applicable to this item, in minor units. This discount is applied for the entire line item, and not per quantity.
x >= 0The tax charged on this item, in minor units. This tax amount is applied for the entire line item, and not per quantity.
x >= 0The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations.
1 - 256An identifier for the product type.
PHYSICAL, DIGITAL Details related to the product
Show child attributes
Show child attributes
The product SKU
1 - 256The product brand
1 - 256The product color
1 - 256The product Global Trade Item Number (e.g. ISBN)
1 - 256The product Manufacturer Part Number
1 - 256The product weight
x >= 0The product weight unit (e.g. kg, g)
1 - 256The product page URL
1 - 1024The country in which the order is created
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW The country code of the retailer
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW The details of fees charged.
Show child attributes
Show child attributes
The fee amount charged to the customer, in minor units. e.g. for $7, use 700.
x >= 0The type of fee.
1 - 256A description of the fee, e.g. "Currency Conversion Fee".
1 - 256The details of shipping charged.
Show child attributes
Show child attributes
The shipping amount charged to the customer, in minor units. e.g. for $7, use 700.
x >= 0Your unique identifier of the shipping method selected by the customer.
The display label for the selected shipping method (e.g. "Standard Shipping").
The descriptive text that is displayed alongside the shipping method name.
Enable certain options associated with the payment method. Provide the entire object to update it. Anything provided previously will be overwritten.
Show child attributes
Show child attributes
Whether the payment method should be vaulted on a successful payment or not.
Whether the payment method should be vaulted after a successful 3DS authentication or not.
Whether the payment method should be vaulted right when payment is created or not.
A description of the payment, as it would typically appear on a bank statement.
256Payment types, primarily to be used for recurring payments. See the table below for all possible values.
Note: if no field is set, we will return a blank value and make a best effort to calculate the downstream fields required for processing the payment.
| paymentType | Use case |
|---|---|
FIRST_PAYMENT | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |
ECOMMERCE | a customer-initiated payment using stored payment details where the cardholder is present. |
SUBSCRIPTION | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |
UNSCHEDULED | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |
FIRST_PAYMENT, ECOMMERCE, SUBSCRIPTION, UNSCHEDULED If provided, the checkout will run the validation on the entered card number and raise an error in case the card network is not supported.
The order sets the default card network that should be used in the case of co-badged cards.
e.g. in the case of ["VISA", "CARTES_BANCAIRES", "MASTERCARD"] - if the user enters a "Visa" / "Cartes Bancaires" card: the default is Visa.
Values should be unique.
If null or nothing passed in the request, the following list with all card networks will be returned in the response:
["VISA", "MASTERCARD", "AMEX", "MAESTRO", "UNIONPAY", "CARTES_BANCAIRES", "DANKORT", "DINERS_CLUB", "DISCOVER", "ENROUTE", "ELO", "HIPER", "INTERAC", "JCB", "MIR", "OTHER"]
The list of available card networks.
AMEX, DANKORT, DINERS_CLUB, DISCOVER, ENROUTE, ELO, HIPER, INTERAC, JCB, MAESTRO, MASTERCARD, MIR, PRIVATE_LABEL, UNIONPAY, VISA, CARTES_BANCAIRES, OTHER Additional options for the payment methods represented as dictionary with key of available payment methods and value of corresponding options.
Show child attributes
Show child attributes
Options for the payment method of type PAYMENT_METHOD_TYPE.
Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0For payments using the Klarna payment method, depending on the merchant segment and/or the services available to consumers, Klarna may require additional information regarding the customer, the merchant and/or the purchase. This information, referred to as extra merchant data (EMD), consist of data that is typically not available at the checkout, but which enables Klarna to complete an assertive risk assessment, enable new promotional products and improve conversion rates for a boost in performance.
For payments using the Apple Pay payment method, use this field to override the default merchant
name for the Primer account from showing on the Apple Pay flow. For example, if your merchant
name on your account is "Company X" but you want to display a specific store name on the Apple Pay
flow, you can set the merchantName to "Store name A".
Apple Pay configuration used in a client session's payment method options.
Show child attributes
Show child attributes
Display name for the merchant shown in the Apple Pay sheet.
1 - 1024Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0Start of billing cycle date and time (UTC) in ISO 8601 format. If not provided, Apple Pay defaults it to now().
End of billing cycle date and time (UTC) in ISO 8601 format.
Calendar unit representing part of a recurring billing interval.
minute, hour, day, month, year Number of calendar units that make up the full recurring interval (e.g., 1 = monthly).
x >= 1{
"label": "Monthly Subscription",
"amount": 999,
"recurringStartDate": "2024-06-03T00:00:00Z",
"recurringIntervalUnit": "month"
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0Start of billing cycle date and time (UTC) in ISO 8601 format. If not provided, Apple Pay defaults it to now().
End of billing cycle date and time (UTC) in ISO 8601 format.
Calendar unit representing part of a recurring billing interval.
minute, hour, day, month, year Number of calendar units that make up the full recurring interval (e.g., 1 = monthly).
x >= 1{
"label": "Free Trial",
"amount": 0,
"recurringEndDate": "2024-06-09T00:00:00Z"
}{
"paymentDescription": "Subscription Service",
"billingAgreement": "You authorize us to charge your payment method monthly. You can cancel anytime.",
"managementUrl": "https://example.com/subscription",
"regularBilling": {
"label": "Premium Plan",
"amount": 1999,
"recurringStartDate": "2024-06-03T00:00:00Z",
"recurringIntervalUnit": "month",
"recurringIntervalCount": 1
},
"trialBilling": {
"label": "Free Trial",
"amount": 0,
"recurringEndDate": "2024-06-09T00:00:00Z"
}
}Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Start of billing cycle date and time (UTC) in ISO 8601 format.
Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0{
"label": "Product Payment",
"amount": 4999,
"deferredPaymentDate": "2024-07-03T00:00:00Z"
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024End of billing cycle date and time (UTC) in ISO 8601 format.
Time zone for interpreting freeCancellationDate.
3 - 50{
"paymentDescription": "Deferred Payment",
"billingAgreement": "You will be charged when the item ships. Free cancellation until shipping.",
"managementUrl": "https://example.com/orders",
"deferredBilling": {
"label": "Order Payment",
"amount": 4999,
"deferredPaymentDate": "2024-07-03T00:00:00Z"
},
"freeCancellationDate": "2024-07-02T00:00:00Z",
"freeCancellationTimeZone": "UTC"
}Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Balance threshold in minor units (e.g., 500 = $5.00) that triggers the reload.
x >= 0Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0{
"label": "Auto Reload",
"amount": 2500,
"automaticReloadThresholdAmount": 500
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024{
"paymentDescription": "Account Auto Reload",
"billingAgreement": "When your balance drops below the threshold, we'll automatically reload your account.",
"managementUrl": "https://example.com/account",
"automaticReloadBilling": {
"label": "Auto Reload",
"amount": 2500,
"automaticReloadThresholdAmount": 500
}
}{
"merchantName": "My Store",
"recurringPaymentRequest": {
"paymentDescription": "Monthly Subscription",
"billingAgreement": "You agree to pay monthly until you cancel.",
"managementUrl": "https://example.com/manage",
"regularBilling": {
"label": "Monthly Plan",
"amount": 999,
"recurringStartDate": "2025-06-09T00:00:00Z",
"recurringIntervalUnit": "month"
}
}
}Show child attributes
Show child attributes
Dictionary of available card networks as a key with value of Payment Method Card Network Option.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Whether to capture CVV for vaulted card.
Allows to adjust the authorized amount after the authorization, if supported by payment method.
FINAL - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.
ESTIMATED - the amount can be adjusted after the authorization, if supported by payment method.
ESTIMATED, FINAL The reason for the first payment. This is used for informing payment processors about the specific reason a payment method is being stored. Defaults to None if not provided.
CardOnFile, Recurring, Unscheduled Response
Successful Response
A unique identifier for your customer.
256Your reference for the payment.
256The 3-letter currency code in ISO 4217 format. e.g. use USD for US dollars.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SOS, SRD, SSP, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XSU, XTS, XUA, YER, ZAR, ZMW, ZWL The amount you are going to charge the customer, in minor units. This amount is calculated from the line items, shipping and other amounts provided in the order.
If a top-level amount is provided, it would override any calculated amount.
x >= 0Additional data to be used throughout the payment lifecycle.
More information associated with the customer.
Show child attributes
Show child attributes
Customer email address.
Note: It is recommended to include this field if a 3DS check will be performed
The customer's mobile number
256The customer's first name
256The customer's last name
256Customer billing address.
Note: It is recommended to include this field if a 3DS check will be performed
Show child attributes
Show child attributes
1 - 2561 - 256Street name, Company name or PO Box
1 - 256Apartment, Unit or Building number
256Name of the city, district, town or village
1 - 256State, County or Province
1 - 256Two letter ISO country code
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW Postal or ZIP code
1 - 256Customer shipping address
Show child attributes
Show child attributes
1 - 2561 - 256Street name, Company name or PO Box
1 - 256Apartment, Unit or Building number
256Name of the city, district, town or village
1 - 256State, County or Province
1 - 256Two letter ISO country code
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW Postal or ZIP code
1 - 256The customer's tax id number for tax exemptions
256The customer's national identification number
256More information associated with the order.
Show child attributes
Show child attributes
The details of the line items of the order.
Show child attributes
Show child attributes
The amount charged to the customer, in minor units. The minimum amount is 0. The maximum amount is the limit of int64.
x >= 0A unique identifier for the line item.
1 - 256A name of the item.
256A description of the item.
256The number of the particular line item that is being ordered.
Any discount applicable to this item, in minor units. This discount is applied for the entire line item, and not per quantity.
x >= 0The tax charged on this item, in minor units. This tax amount is applied for the entire line item, and not per quantity.
x >= 0The tax code associated with this item, in minor units. This is required for Primer-initiated tax calculations.
1 - 256An identifier for the product type.
PHYSICAL, DIGITAL Details related to the product
Show child attributes
Show child attributes
The product SKU
1 - 256The product brand
1 - 256The product color
1 - 256The product Global Trade Item Number (e.g. ISBN)
1 - 256The product Manufacturer Part Number
1 - 256The product weight
x >= 0The product weight unit (e.g. kg, g)
1 - 256The product page URL
1 - 1024The country in which the order is created
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW The country code of the retailer
AW, AF, AO, AI, AX, AL, AD, AE, AR, AM, AS, AQ, TF, AG, AU, AT, AZ, BI, BE, BJ, BQ, BF, BD, BG, BH, BS, BA, BL, BY, BZ, BM, BO, BR, BB, BN, BT, BV, BW, CF, CA, CC, CH, CL, CN, CI, CM, CD, CG, CK, CO, KM, CV, CR, CU, CW, CX, KY, CY, CZ, DE, DJ, DM, DK, DO, DZ, EC, EG, ER, EH, ES, EE, ET, FI, FJ, FK, FR, FO, FM, GA, GB, GE, GG, GH, GI, GN, GP, GM, GW, GQ, GR, GD, GL, GT, GF, GU, GY, HK, HM, HN, HR, HT, HU, ID, IM, IN, IO, IE, IR, IQ, IS, IL, IT, JM, JE, JO, JP, KZ, KE, KG, KH, KI, KN, KR, KW, LA, LB, LR, LY, LC, LI, LK, LS, LT, LU, LV, MO, MF, MA, MC, MD, MG, MV, MX, MH, MK, ML, MT, MM, ME, MN, MP, MZ, MR, MS, MQ, MU, MW, MY, YT, NA, NC, NE, NF, NG, NI, NU, NL, NO, NP, NR, NZ, OM, PK, PA, PN, PE, PH, PW, PG, PL, PR, KP, PT, PY, PS, PF, QA, RE, RO, RU, RW, SA, SD, SN, SG, GS, SH, SJ, SB, SL, SV, SM, SO, PM, RS, SS, ST, SR, SK, SI, SE, SZ, SX, SC, SY, TC, TD, TG, TH, TJ, TK, TM, TL, TO, TT, TN, TR, TV, TW, TZ, UG, UA, UM, UY, US, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, ZA, ZM, ZW The details of fees charged.
Show child attributes
Show child attributes
The fee amount charged to the customer, in minor units. e.g. for $7, use 700.
x >= 0The type of fee.
1 - 256A description of the fee, e.g. "Currency Conversion Fee".
1 - 256The details of shipping charged.
Show child attributes
Show child attributes
The shipping amount charged to the customer, in minor units. e.g. for $7, use 700.
x >= 0Your unique identifier of the shipping method selected by the customer.
The display label for the selected shipping method (e.g. "Standard Shipping").
The descriptive text that is displayed alongside the shipping method name.
Enable certain options associated with the payment methods.
Show child attributes
Show child attributes
Whether the payment method should be vaulted on a successful payment or not.
Whether the payment method should be vaulted after a successful 3DS authentication or not.
Whether the payment method should be vaulted right when payment is created or not.
A description of the payment, as it would typically appear on a bank statement.
256Payment types, primarily to be used for recurring payments. See the table below for all possible values.
Note: if no field is set, we will return a blank value and make a best effort to calculate the downstream fields required for processing the payment.
| paymentType | Use case |
|---|---|
FIRST_PAYMENT | a customer-initiated payment which is the first in a series of recurring payments or subscription, or a card on file scenario. |
ECOMMERCE | a customer-initiated payment using stored payment details where the cardholder is present. |
SUBSCRIPTION | a merchant-initiated payment as part of a series of payments on a fixed schedule and a set amount. |
UNSCHEDULED | a merchant-initiated payment using stored payment details with no fixed schedule or amount. |
FIRST_PAYMENT, ECOMMERCE, SUBSCRIPTION, UNSCHEDULED If provided, the checkout will run the validation on the entered card number and raise an error in case the card network is not supported.
The order sets the default card network that should be used in the case of co-badged cards.
e.g. in the case of ["VISA", "CARTES_BANCAIRES", "MASTERCARD"] - if the user enters a "Visa" / "Cartes Bancaires" card: the default is Visa.
Values should be unique.
If null or nothing passed in the request, the following list with all card networks will be returned in the response:
["VISA", "MASTERCARD", "AMEX", "MAESTRO", "UNIONPAY", "CARTES_BANCAIRES", "DANKORT", "DINERS_CLUB", "DISCOVER", "ENROUTE", "ELO", "HIPER", "INTERAC", "JCB", "MIR", "OTHER"]
The list of available card networks.
AMEX, DANKORT, DINERS_CLUB, DISCOVER, ENROUTE, ELO, HIPER, INTERAC, JCB, MAESTRO, MASTERCARD, MIR, PRIVATE_LABEL, UNIONPAY, VISA, CARTES_BANCAIRES, OTHER Additional options for the payment methods represented as dictionary with key of available payment methods and value of corresponding options.
Show child attributes
Show child attributes
Options for the payment method of type PAYMENT_METHOD_TYPE.
Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0For payments using the Klarna payment method, depending on the merchant segment and/or the services available to consumers, Klarna may require additional information regarding the customer, the merchant and/or the purchase. This information, referred to as extra merchant data (EMD), consist of data that is typically not available at the checkout, but which enables Klarna to complete an assertive risk assessment, enable new promotional products and improve conversion rates for a boost in performance.
For payments using the Apple Pay payment method, use this field to override the default merchant
name for the Primer account from showing on the Apple Pay flow. For example, if your merchant
name on your account is "Company X" but you want to display a specific store name on the Apple Pay
flow, you can set the merchantName to "Store name A".
Apple Pay configuration used in a client session's payment method options.
Show child attributes
Show child attributes
Display name for the merchant shown in the Apple Pay sheet.
1 - 1024Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0Start of billing cycle date and time (UTC) in ISO 8601 format. If not provided, Apple Pay defaults it to now().
End of billing cycle date and time (UTC) in ISO 8601 format.
Calendar unit representing part of a recurring billing interval.
minute, hour, day, month, year Number of calendar units that make up the full recurring interval (e.g., 1 = monthly).
x >= 1{
"label": "Monthly Subscription",
"amount": 999,
"recurringStartDate": "2024-06-03T00:00:00Z",
"recurringIntervalUnit": "month"
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0Start of billing cycle date and time (UTC) in ISO 8601 format. If not provided, Apple Pay defaults it to now().
End of billing cycle date and time (UTC) in ISO 8601 format.
Calendar unit representing part of a recurring billing interval.
minute, hour, day, month, year Number of calendar units that make up the full recurring interval (e.g., 1 = monthly).
x >= 1{
"label": "Free Trial",
"amount": 0,
"recurringEndDate": "2024-06-09T00:00:00Z"
}{
"paymentDescription": "Subscription Service",
"billingAgreement": "You authorize us to charge your payment method monthly. You can cancel anytime.",
"managementUrl": "https://example.com/subscription",
"regularBilling": {
"label": "Premium Plan",
"amount": 1999,
"recurringStartDate": "2024-06-03T00:00:00Z",
"recurringIntervalUnit": "month",
"recurringIntervalCount": 1
},
"trialBilling": {
"label": "Free Trial",
"amount": 0,
"recurringEndDate": "2024-06-09T00:00:00Z"
}
}Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Start of billing cycle date and time (UTC) in ISO 8601 format.
Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0{
"label": "Product Payment",
"amount": 4999,
"deferredPaymentDate": "2024-07-03T00:00:00Z"
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024End of billing cycle date and time (UTC) in ISO 8601 format.
Time zone for interpreting freeCancellationDate.
3 - 50{
"paymentDescription": "Deferred Payment",
"billingAgreement": "You will be charged when the item ships. Free cancellation until shipping.",
"managementUrl": "https://example.com/orders",
"deferredBilling": {
"label": "Order Payment",
"amount": 4999,
"deferredPaymentDate": "2024-07-03T00:00:00Z"
},
"freeCancellationDate": "2024-07-02T00:00:00Z",
"freeCancellationTimeZone": "UTC"
}Show child attributes
Show child attributes
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
1 - 1024Show child attributes
Show child attributes
Display label shown in the Apple Pay sheet to describe this billing option.
1 - 1024Balance threshold in minor units (e.g., 500 = $5.00) that triggers the reload.
x >= 0Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100 = 100).
x >= 0{
"label": "Auto Reload",
"amount": 2500,
"automaticReloadThresholdAmount": 500
}Text shown to the user during Apple Pay authorization.
1 - 1024Terms and conditions the user agrees to when authorizing Apple Pay billing.
1 - 1024{
"paymentDescription": "Account Auto Reload",
"billingAgreement": "When your balance drops below the threshold, we'll automatically reload your account.",
"managementUrl": "https://example.com/account",
"automaticReloadBilling": {
"label": "Auto Reload",
"amount": 2500,
"automaticReloadThresholdAmount": 500
}
}{
"merchantName": "My Store",
"recurringPaymentRequest": {
"paymentDescription": "Monthly Subscription",
"billingAgreement": "You agree to pay monthly until you cancel.",
"managementUrl": "https://example.com/manage",
"regularBilling": {
"label": "Monthly Plan",
"amount": 999,
"recurringStartDate": "2025-06-09T00:00:00Z",
"recurringIntervalUnit": "month"
}
}
}Show child attributes
Show child attributes
Dictionary of available card networks as a key with value of Payment Method Card Network Option.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Show child attributes
Show child attributes
Surcharge information
Show child attributes
Show child attributes
The surcharge amount, in minor units. Surcharge amount must be used in conjunction with line item amounts, if a top level amount is passed then surcharge will not be calculated.
x >= 0Whether to capture CVV for vaulted card.
Allows to adjust the authorized amount after the authorization, if supported by payment method.
FINAL - the authorized amount is final and can not be adjusted. Adjusting the amount can be only done via canceling the payment and re-authorization with new amount.
ESTIMATED - the amount can be adjusted after the authorization, if supported by payment method.
ESTIMATED, FINAL The reason for the first payment. This is used for informing payment processors about the specific reason a payment method is being stored. Defaults to None if not provided.
CardOnFile, Recurring, Unscheduled