Transaction

Profile

A Transaction represents information about a given transaction as processed by the Gateway API.

Properties

name type
id string
arn1 string
type2 string
processed_at ISO 8601 date and time in UTC
amount3 integer
currency ISO 4217 3-letter code
text_on_statement string
reference string
threed_secure string
recurring boolean
status.code integer status code
status.message string status message
card.type string
card.scheme string
card.country ISO 3166-1 2-letter code
card.last4 string
card.bin string
fraud.type4 string
fraud.date4 ISO 8601 date
settlement.date5 ISO 8601 date
settlement.amount_gross35 integer
settlement.amount_net35 integer
settlement.fees35 integer
settlement.currency 5 ISO 4217 3-letter code
1
ARN stands for “Acquirer Reference Number” and is available for transactions where type is one of capture, refund, credit.
2
One of: authorization, capture, refund, credit, void.
3
Amount in minor units of given currency (e.g. cents if in Euro).
4
Fraud information is collected from TC40/SAFE data.
5
Settlement information is collected when the transaction is settled with card schemes. The settlement currency is the currency of the account.
rel conditional
self false
ch:account false
ch:settlement true

Embedded

Additional semantics

No additional semantics.

Example representation

{
  "id": "a51a3abe-8eee-4a92-b941-e89f18c5bf66",
  "arn": "76874308121337230471105",
  "type": "capture",
  "processed_at": "2016-07-16T11:07:17+00:00",
  "amount": 10050,
  "currency": "DKK",
  "text_on_statement": "site.com",
  "reference": "abc123",
  "threed_secure": "attempt",
  "recurring": false,
  "status": {
    "code": 20000
  },
  "card": {
    "bin": "411111",
    "country": "US",
    "last4": "1111",
    "scheme": "visa",
    "type": "credit"
  },
  "settlement": {
    "date": "2016-07-17",
    "amount_gross": 10050,
    "amount_net": 9000,
    "fees": -1050,
    "currency": "DKK"
  },
  "fraud": {
    "date": "2016-08-01",
    "type": "fraudulent_usage"
  },
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/transactions/a51a3abe-8eee-4a92-b941-e89f18c5bf66"
    },
    "ch:account": {
      "href": "https://merchant.test.clearhaus.com/accounts/f72e20a6-31dc-4c24-9314-4bcc5b8820d4"
    },
    "ch:settlement": {
      "href": "https://merchant.test.clearhaus.com/settlements/8ba78356-5c39-46d6-9ba7-0fe766dfd2fe"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "trail": [...],
    "ch:account": {...}
  }
}
Open Navigation Close Navigation