PurchaseInformation: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
 
(21 intermediate revisions by 5 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 28: Line 28:
| AvailabilityIndicator|| [[AvailabilityIndicator]] ||  
| AvailabilityIndicator|| [[AvailabilityIndicator]] ||  
* Optional  
* Optional  
|| When will the goods be available
|| When will the goods be available.
|-
|-
| ReOrderIndicator || [[ReOrderIndicator]] ||  
| ReOrderIndicator || [[ReOrderIndicator]] ||  
Line 39: Line 39:
|-
|-
| RecurringExpiry|| datetime ||  
| RecurringExpiry|| datetime ||  
* Optional
* Required in case of initial [[RecurrenceType|Recurring]] payment, otherwise not
* In UTC  
* In UTC  
* Expected format: "2019-06-27T07:15:51.327"
* Expected format: "2019-06-27T07:15:51.327"
|| What is the last date when the payment can be used as a recurring source.
|| The date past which no further payments should be accepted in the recurrence cycle.</br>Practically, the term of the subscription cycle.
|-
|-
| RecurringFrequency|| int ||  
| RecurringFrequency|| int ||  
* Required in case of initial [[RecurrenceType|Recurring]] payment, otherwise not
* Must be between 1 and 9999 inclusive
|| What is the minimum number of days between subsequent payments.</br>The payment instrument's issuing bank checks whether the number of days specified here has elapsed between consecutive recurring payments in a subscription cycle, and may reject payments that violate this configuration.</br>Note that the Barion Sandbox environment doesn't check whether recurring payments violate this configuration.
|-
| PurchaseType || [[PurchaseType]] ||
* Optional
|| The type of the purchase.
|-
| GiftCardPurchase || [[GiftCardPurchase]] ||
* Optional  
* Optional  
|| How many days must be between usages of the this payment as a recurring source.
|| 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.  
|-
|-
|}
|}

Latest revision as of 12:54, 24 May 2024

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
  • Required in case of initial Recurring payment, otherwise not
  • In UTC
  • Expected format: "2019-06-27T07:15:51.327"
The date past which no further payments should be accepted in the recurrence cycle.
Practically, the term of the subscription cycle.
RecurringFrequency int
  • Required in case of initial Recurring payment, otherwise not
  • Must be between 1 and 9999 inclusive
What is the minimum number of days between subsequent payments.
The payment instrument's issuing bank checks whether the number of days specified here has elapsed between consecutive recurring payments in a subscription cycle, and may reject payments that violate this configuration.
Note that the Barion Sandbox environment doesn't check whether recurring payments violate this configuration.
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.