PurchaseInformation: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
(14 intermediate revisions by 2 users not shown)
Line 13: Line 13:
|-
|-
| DeliveryTimeframe|| [[DeliveryTimeframeType]] ||  
| DeliveryTimeframe|| [[DeliveryTimeframeType]] ||  
* Optional  
* Optional
|| The speed of the delivery method.
|| The speed of the delivery method.
|-
|-
| DeliveryEmailAddress || string ||  
| DeliveryEmailAddress || string ||  
* Optional  
* Optional
|| If the goods are sent electronically to the payer, here should be the e-mail address where the payer asked the goods to.
|| If the goods are sent electronically to the payer, here should be the e-mail address where the payer asked the goods to.
|-
|-
Line 37: Line 37:
* Optional  
* Optional  
|| What kind of shipping is used.
|| What kind of shipping is used.
|-
| RecurringExpiry|| datetime ||
* Optional, required in case of token payment
* In UTC
* Expected format: "2019-06-27T07:15:51.327"
|| What is the last date when the payment can be used as a recurring source.
|-
| RecurringFrequency|| int ||
* Optional, required in case of token payment
* Must be between 0 and 9999
|| How many days must be between usages of the this payment as a recurring source.
|-
| PurchaseType || [[PurchaseType]] ||
* Optional
|| The type of the purchase
|-
| GiftCardPurchase || [[GiftCardPurchase]] ||
* Optional
|| If the purchased items included gift cards, fill out the information about them
|-
| PurchaseDate || datetime||
* Optional
* In UTC
* Expected format: "2019-06-27T07:15:51.327"
|| The time of the purchase.
|-
|-
|}
|}

Revision as of 05:26, 10 August 2019

Purchase information structure

This structure represents information about the purchase related to a payment. The data provided here is used to analyze and avoid possible fraud attempts and assure frictionless 3D secure flow.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Limitations and constraints Description
DeliveryTimeframe DeliveryTimeframeType
  • Optional
The speed of the delivery method.
DeliveryEmailAddress string
  • Optional
If the goods are sent electronically to the payer, here should be the e-mail address where the payer asked the goods to.
PreOrderDate datetime
  • Optional
  • In UTC
  • Expected format: "2019-06-27T07:15:51.327"
If the payer pre-ordered the goods, here should be the date when the goods will be available.
AvailabilityIndicator AvailabilityIndicator
  • Optional
When will the goods be available
ReOrderIndicator ReOrderIndicator
  • Optional
Is this purchase a re-order of a previous one.
ShippingAddressIndicator ShippingAddressIndicator
  • Optional
What kind of shipping is used.
RecurringExpiry datetime
  • Optional, required in case of token payment
  • In UTC
  • Expected format: "2019-06-27T07:15:51.327"
What is the last date when the payment can be used as a recurring source.
RecurringFrequency int
  • Optional, required in case of token payment
  • Must be between 0 and 9999
How many days must be between usages of the this payment as a recurring source.
PurchaseType PurchaseType
  • Optional
The type of the purchase
GiftCardPurchase GiftCardPurchase
  • Optional
If the purchased items included gift cards, fill out the information about them
PurchaseDate datetime
  • Optional
  • In UTC
  • Expected format: "2019-06-27T07:15:51.327"
The time of the purchase.