Edit

Changes

There are 3 types of changes: transaction, subscriber and charge. All fields are always present and have valid default values.

Transaction

In this context, transactions are regular payment transactions.

JSON fields Description
"type": "transaction" Type denoting that this is a transaction.
"id": 378 The transaction ID.
"rev": 3 A revision number. It starts at 1 and it increments every time the transaction data changes.
"locked": "u7812:4" Whether or not this transaction has been made immutable and if so, which API key was responsible. 
"method": {
    "type": "card",
    "id": "WkS3rJht/unginSCpOEwqVtH6SJWt4+StC8TWl+kP6w=",
    "card": {
        "brand": "visadankort",
        "last4": "1234"
    }
}
  • type: The method type can be either "card", "mobilepay" or "applepay"
  • id: A per-shop opaque ID of the payment device.
  • card/mobilepay/applepay: A subobject with the same name as the value of "type" containing method-specific information about the payment means. All currently supported types are functionally credit cards so they all have the same fields.
    • brand: "amex", "dankort", "diners", "discover", "forbrugsforening", "jcb", "maestro", "mastercard", "unionpay", "visa", "visadankort"
    • last4: The last 4 digits of the card number.
 
"services": [
    "mobilepay",
    "3dsecurev2",
    "clearhaus-3"
]
A list of services used when authorizing this transaction. In addition to the acquiring agreement in the form seen in the dashboard (eg. "clearhaus-1" or "nets-3") these are the currently supported additional services: "3dsecurev2", "applepay", "mobilepay". The legacy services "3dsecure" and "dsbn" can appear on older entries, denoting 3-D Secure before version 2 and the first version of Dankort Secured by Nets. 
"info": {
    "ip": "127.250.74.142",
    "ndisplay": 2,
    "nfail": 0
}
Information about the use pattern of the payment window by the payer.
  • ip: The IP address that successfully paid using the payment link.
  • ndisplay: How many times the window was displayed before being paid.
  • nfail: How many times the payment was attempted unsuccessfully before being paid.
 
"time": {
    "created": 1727088810,
    "authorized": 1727088919
}
Unix timestamps denoting
  • created: When the payment link was created and
  • authorized: When the authorization succeeded.
"orderid": "00029384", The order ID that you assigned to the transaction when creating the payment link. 
"billing": {
    "name": "Peter Nielsen",
    "company": "Nielsen A/S",
    "vatin": "DK91738264",
    "gln": "7953878173521",
    "email": "pn@nielsenas.dk",
    "phone": "+45 90014893",
    "address": [
        "Pederstrupvej 14"
    ],
    "city": "Teststrup",
    "zip": "8320",
    "state": "",
    "country": "Denmark"
}

"shipping": {
    "name": "Peter Nielsen",
    "company": "Nielsen A/S",
    "email": "pn@nielsenas.dk",
    "phone": "+45 90014893",
    "address": [
        "C/O Peter Nielsen",
        "Pederstrupvej 14"
    ],
    "city": "Teststrup",
    "zip": "8320",
    "state": "",
    "country": "Denmark"
}
The shipping and billing addresses that were given when creating the payment link. 
"items": [
    {
        "quantity": 2,
        "total": "199.90 DKK",
        "name": "Danmarkskort plakat",
        "sku": "182932000-MAP-DK"
    },
    {
        "quantity": 1,
        "total": "45 DKK",
        "name": "Fragt - PostNord",
        "sku": ""
    },
    {
        "quantity": 1,
        "total": "0.50 DKK",
        "name": "",
        "sku": ""
    }
]
The array of items that were given when creating the payment link.
Note: the "quantity" field defaults to 1 if none was specified. 
"acts": [
    {
        "act": "capture",
        "time": 1727109740,
        "who": "s1286:1",
        "total": "244.90 DKK",
        "history": [
            {
                "item": 0,
                "quantity": 2,
                "total": "199.90 DKK"
            },
            {
                "item": 1,
                "quantity": 1,
                "total": "45 DKK"
            }
        ],
        "fees": {
            "capture": "0.25 DKK"
        }
    },
    {
        "act": "refund",
        "time": 1727196369,
        "who": "u7812:3",
        "total": "99.95 DKK",
        "history": [
            {
                "item": 7,
                "quantity": 190,
                "total": "12 DKK"
            }
        ],
        "fees": {}
    }
]
A chronologically ordered array of actions performed on this transaction. There are 3 types of actions:
  • capture: Some or all of the authorized funds were captured.
  • refund: Some or all of the capturd funds were refunded.
  • void: The entire authorization was invalidated. This action can only be present if it is the first and only action in the array.
The other fields are:
  • time: The Unix time at which the action completed.
  • who: The API key that initiated the action.
  • total: The total amount that was captured, refunded, or voided.
  • history: Freeform structured data about the items related to this action.
  • fees: An associative array of fees charged by us for this action.
The "history" array contains meta-data about the action which is used in the dashboard to show, for example, which items have been captured. The data is not checked for correctness and may be invalid or missing. 
"fees": {},
An associative array of fees you were charged by us for the authorization. There are currently no fees for any authorizations. 
"totals": {
    "attempted": "245.40 DKK",
    "authorized": "245.40 DKK",
    "captured": "244.90 DKK",
    "refunded": "99.95 DKK",
    "voided": "0 DKK",
    "left": "0.50 DKK"
}
The sum totals of all actions performed on this transaction.
  • attempted: The sum total of all items.
  • authorized: How much was originally authorized. This can differ from how much you attempted to authorize.
  • captured: How much has been captured so far.
  • refunded: how much has been refunded so far.
  • left: How much is still left to capture.

Charge

Charges are transactions with payment window data missing and some extra information about the subcriber that was charged.

JSON fields Description
"type": "charge" Type denoting that this is a subscriber charge.
Note: charges functionally are transactions. The difference in data here is purely cosmetic.
"info": {} Unlike for regular transactions, this object is not returned. 
"subscriber": {
    "id": 192,
    "rev": 5,
    "ref": "a-1083"
}
  • id: The ID of the subscriber.
  • rev: The revision the subscriber had when the charge was made.
  • ref: The reference data you supplied when creating the subscriber.

Subscriber

JSON fields Description
"type": "subscriber" Type denoting that this is a subscriber.
"id": 19 The subscriber ID.
"rev": 2 A revision number. It starts at 1 and it increments every time the subcriber data changes.
"ref": "user301" The reference ID that you assigned to the subscriber when you created it. 
"method": {
    "type": "card",
    "id": "I2hfG55UvlDvAwzW8aVec1049giH0Z1ZEPlGYMPiCac=",
    "card": {
        "brand": "mastercard",
        "last4": "2847",
        "exp": 1848700800
    }
}
  • type: The type of stored credentials. It is currently always "card".
  • id: A per-shop opaque ID of the card.
  • card: Information about the stored card.
    • brand: "amex", "dankort", "diners", "discover", "forbrugsforening", "jcb", "maestro", "mastercard", "unionpay", "visa", "visadankort"
    • last4: The last 4 digits of the card number.
    • exp: A Unix timestamp denoting the expected last possible valid use time of the card.
 
"time": {
    "created": 1715259306,
    "authorized": 1715259314
}
Unix timestamps denoting
  • created: When the payment link that created this subscriber was created and
  • authorized: When the first subscription succeeded.
 
"info": {
    "ip": "2001:1450:400f:804::200e"
}
Information about the payer whose credentials got stored when first creating or last renewing the subscriber.
  • ip: The payer's IP address.
 
"billing": {
    "name": "Anne Jensen",
    "company": "",
    "vatin": "",
    "gln": "",
    "email": "anne@gmail.com",
    "phone": "80781943",
    "address": [
        "Hans Christiansvænge 99",
        "Postboks 401"
    ],
    "city": "Neder Vindinge",
    "zip": "4760",
    "state": "",
    "country": ""
}

"shipping": {
    "name": "",
    "company": "",
    "email": "",
    "phone": "",
    "address": [],
    "city": "",
    "zip": "",
    "state": "",
    "country": ""
}
The shipping and billing addresses that were supplied when creating or last renewing the subscriber. 
"acts": [
    {
        "act": "renew",
        "time": 1757573571,
        "services": [
            "3dsecurev2",
            "nets-2"
        ]
    }
]
A chronologically ordered array of actions performed on this subscriber. There is currently only 1 type of action:
  • renew: The stored credentials were updated.
The other fields are:
  • time: The Unix time at which the re-subscription succeeded.
  • services: An list of services used when re-subscribing.
In addition to the acquiring agreement in the form seen in the dashboard (eg. "nets-2" or "clearhaus-1") there is currently only 1 supported service: "3dsecurev2". The legacy services "3dsecure" and "dsbn" can appear on older entries, denoting 3-D Secure before version 2 and the first version of Dankort Secured by Nets.