Parameter | Specification | Required |
---|---|---|
publishableKey | Type: String Example: mu5r693slwpdk1nmr4vn985b Description: Merchant Customer's publishable key Abbreviation: k | Required: All ** |
checkoutDomain | Type: String Format: Url Example: https://checkout.paystand.co/v3/ Abbreviation: h | Optional |
domain | Type: String Format: Url Example: https://api.paystand.co/ Abbreviation: o | Optional |
theme | Type: String Default: classic Description: The theme selected. See Themes Abbreviation: t | Optional |
layout | Type: String Default: two-col Description: The layout selected. See Layouts Abbreviation: l | Optional |
css | Type: String Format: Url Description: An external css file to be read. Abbreviation: w | Optional |
palette | Type: JSON Object Format: Palettes Object Description: Palette for defining colors. Abbreviation: a | Optional |
paymentMethods | Type: Array of Strings Values: echeck , card Default: echeck Description: The payment methods available Abbreviation: m | Optional |
currency | Type: String Values: One of USD , CAN Abbreviation: c | Required: All ** |
payment.amount | Type: String Format: Number Description: Payment amount Abbreviation: p.a | Required: Payment |
scheduledPayment | Type: JSON Object Format: Scheduled Payments Description: Scheduled payment information Abbreviation: r | Required: Scheduled Payment |
billing | Type: JSON Object Description: Billing information to autofill. Abbreviation: b | Optional |
payer.name | Type: String Description: The customer's name Abbreviation: y.n | Optional |
payer.email | Type: String Format: Email Description: The customer's email Abbreviation: y.e | Optional |
meta | Type: JSON Object Format: Meta Abbreviation: z | Optional |
** required for all checkout types: direct payment, scheduled payment, and tokenize
The Billing Object
Parameter | Specification | Required |
---|---|---|
street | Type: String Length: 0-256 Example: "100 Enterprise Way" Abbreviation: s | Optional |
city | Type: String Length: 0-256 Example: "Scotts Valley" Abbreviation: c | Optional |
subdivisionCode | Type: String Length: 0-256 Example: "CA" Abbreviation: d | Optional |
postalCode | Type: String Length: 0-256 Example: "95066" Abbreviation: p | Optional |
countryCode | Type: String Format: ISO 3166-1 alpha-3 Length: 3 Example: "USA" Abbreviation: u | Optional |
{
"publishableKey": "mu5r693slwpdk1nmr4vn985b",
"checkoutDomain": "https://checkout.paystand.co/v3/",
"domain": "https://api.paystand.co",
"theme": "classic",
"layout": "two-col",
"css": "https://www.mySite.com/myExternalCss.css",
"payment": {
"amount": "5000.20"
},
"currency": "USD",
"paymentMethods": [
'echeck',
'card'
],
"billing": {
"street": "41 Grandview St",
"city": "Santa Cruz",
"postalCode": "95060",
"subdivisionCode": "CA",
"countryCode": "USA"
},
"payer": {
"name": "Christina Chan",
"email": "[email protected]"
},
"meta": {
"extra": "data"
}
}
{
"k": "mu5r693slwpdk1nmr4vn985b",
"h": "https://checkout.paystand.co/v3/",
"o": "https://api.paystand.co",
"t": "classic",
"l": "two-col",
"w": "https://www.mySite.com/myExternalCss.css",
"p": {
"a": "5000.20"
},
"c": "USD",
"m": [
'echeck',
'card'
],
"b": {
"s": "41 Grandview St",
"c": "Santa Cruz",
"p": "95060",
"d": "CA",
"u": "USA"
},
"y": {
"n": "Christina Chan",
"e": "[email protected]"
},
"z": {
"extra": "data"
}
}