RawPurchasePaymentReference Data Type

Represents a transaction of a payment.

Properties
name data type description
amount number The amount of the reference. Optional for transaction type REFERENCE.
reference string The payment reference.
externalReference string The external reference. May be used differently for different payment methods. Needs to be used if references should be grouped.

NOTE: For Adyen recurring transactions it must contain shopperReference (original purchase number).

paymentMethodCode string The payment method for the reference. If this is not specified, the reference will fallback to the purchase payment method.
paymentMethodType string The payment method type.

NOTE: For Adyen recurring transactions it must contain payment method type (i.e. paypal, ideal, klarna_pay_now).

transactionType TransactionType The transaction type.
forSubscription boolean Whether this transaction is for subscription. False by default. Should be true if the payment reference is used to create orders for the subscription. Should be set to true when setting transactionType to REFERENCE for the .
forOrder boolean Whether this transaction is for order. True by default. Should be true for the AUTHORIZATION/SALE transaction of a subscription if createInitialOrderDirectly is used.
parentReference string The parent reference. Should be used if the transaction is related to another transaction. For example when doing an initial charge of subscription payment agreement, the parent reference of the AUTHORIZATION should be the reference of the recurring transaction with transaction type REFERENCE.

Example

{
  "amount" : 12345.0,
  "reference" : "...",
  "externalReference" : "...",
  "paymentMethodCode" : "...",
  "paymentMethodType" : "...",
  "transactionType" : "REFUND",
  "forSubscription" : true,
  "forOrder" : true,
  "parentReference" : "..."
}