GDM
Address object attributes
| Attribute | Type | Description |
|---|---|---|
| name | string | name |
| line1 | string | Address line |
| suburb | string | City |
| geoCode | Geocode | Geocode information. OPTIONAL |
| postcode | string | Postcode |
| countryCode | string | Country Code |
| phoneNumber | string | Phone Number |
Amount object attributes
| Attribute | Type | Description |
|---|---|---|
| amount | float | The total value amount |
| currency | string | The currency of the amount |
Consumer object attributes
| Attribute | Type | Description |
|---|---|---|
| string | Consumer | |
| surname | string | Consumer |
| givenNames | string | Consumer |
| phoneNumber | string | Consumer |
Discount object attributes
| Attribute | Type | Description |
|---|---|---|
| amount | Amount | Total discount amount |
| displayName | string | Discount description |
Frequency object attributes
| Attribute | Type | Description |
|---|---|---|
| Number | integer | Numbner of installments per period |
| frequencyType | string | Time between each installment (e.g. monthly) |
Geocode object attributes
| Attribute | Type | Description |
|---|---|---|
| place_id | string | Unique identifier of the geographic entity |
Item object attributes
| sku | string | Sku |
| gtin | string | Product serial number. OPTIONAL |
| name | string | Name |
| brand | string | Product Brand name. OPTIONAL |
| price | Amount | Product price |
| category | string | Product main category. OPTIONAL |
| quantity | integer | Quantity |
| subcategory | array | Product subcategories. OPTIONAL |
Merchant object attributes
| Attribute | Type | Description |
|---|---|---|
| redirectCancelUrl | string | Merchant cancel url for failure |
| redirectConfirmUrl | string | Merchant cancel url for success |
Order details object
| Attribute | Type | Description |
|---|---|---|
| items | array | Order items list. See Item |
| billing | Address | Billing informations |
| consumer | [Consumer] (https://developers.scalapay.com/reference/3-consumer-object) | Consumer informations |
| merchant | Merchant | Merchant urls informations |
| shipping | Address | Shipping informations |
| discounts | array | Discount list. See Discount |
| taxAmount | Amount | Total tax amount |
| totalAmount | Amount | Total order amount |
| shippingAmount | Amount | Total shipping amount |
| merchantReference | string | Unique reference that identifies merchant order |
| type | string | Accepted values: online or offline |
| product | string | Which Scalapay product is being called Accepted values: pay-in-3 , pay-in-4 , later |
| frequency | [Frequency] (https://developers.scalapay.com/reference/5-frequency-object) | Number of installments |
Order extension object
| Attribute | Type | Description |
|---|---|---|
| type | object | link |
Order link object
| Attribute | Type | Description |
|---|---|---|
| notification | object | Notification field |
Order notification object
| Attribute | Type | Description |
|---|---|---|
| phoneCountryCode | String | phone number prefix (e.g. +39) |
| phoneNumber | String | phone number without prefix |
| emailAddress | String | Email Address |
| preferredLanguage | String | Language in which we want to send the message (e.g.: EN) |
| channels | Array Enum ( sms | email | push | qrcode) | Type of sending request |