Class: Transaction

Transaction

A transaction is the charging of a credit card or a direct debit. In this case you need a new transaction object with either a valid token, payment, client + payment or preauthorization. Every transaction has a unique identifier which will be generated by Paymill to identify every transaction. You can issue/create, list and display transactions in detail. Refunds can be done in an extra entity.

new Transaction()

Creates a new Transaction. Generally you should never create a PAYMILL object on your own.
Source:

Classes

Filter
Order

Members

<static> Status

Status of a Transaction.
Properties:
Name Type Description
OPEN string
PENDING string
CLOSED string
FAILED string
PARTIAL_REFUNDED string
REFUNDED string
PREAUTHORIZE string
Source:

amount :string

Formatted amount of this transaction
Type:
  • string
Source:

app_id :string

App (ID) that created this transaction or null if created by yourself.
Type:
  • string
Source:

client :Client

Corresponding Client object.
Type:
Source:

created_at :Date

Unix-Timestamp for the creation date.
Type:
  • Date
Source:

currency :string

ISO 4217 formatted currency code.
Type:
  • string
Source:

description :string

Need a additional description for this transaction? Maybe your shopping cart ID or something like that?
Type:
  • string
Source:

fees :Array.<Fee>

App fees
Type:
Source:

id :string

Unique identifier for this transaction.
Type:
  • string
Source:

invoices :Array.<string>

PAYMILL invoice where the transaction fees are charged or null.
Type:
  • Array.<string>
Source:

is_markable_as_fraud :boolean

Whether or not this transaction can be marked as fraud
Type:
  • boolean
Source:

is_refundable :boolean

Whether or not this transaction is refundable
Type:
  • boolean
Source:

livemode :boolean

Whether this transaction was issued while being in live mode or not.
Type:
  • boolean
Source:

mandate_reference :string

SEPA mandate reference, can be optionally specified for direct debit transactions. If specified for other payment methods, it has no effect but must still be valid. If specified, the string must not be empty, can be up to 35 characters long and may contain:

  • digits 0-9
  • letters a-z A-Z
  • special characters: ‘ , . : + - / ( ) ?
Type:
  • string
Source:

origin_amount :number

The used amount, smallest possible unit per currency (for euro, we're calculating the amount in cents).
Type:
  • number
Source:

payment :Payment

Corresponding payment object.
Type:
Source:

preauthorization :Preauthorization

Corresponding Preauthorization object.
Type:
Source:

refunds :Array.<Refund>

List of refunds.
Type:
Source:

response_code :number

Response code
Type:
  • number
Source:

short_id :string

Unique identifier of this transaction provided to the acquirer for the statements.
Type:
  • string
Source:

status :string

Indicates the current status of this transaction, e.g closed means the transaction is sucessfully transfered, refunded means that the amount is fully or in parts refunded. ISO 4217 formatted currency code.
Type:
  • string
Source:

updated_at :Date

Unix-Timestamp for the last update.
Type:
  • Date
Source: