Transaction

ch:transaction LINK RELATION , EMBEDDED RELATION

Actions

method description
GET View transaction
OPTIONS Retrieve supported HTTP methods

Request parameters

No request parameters.

Profile

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

Properties

name type
id string
rrn1 string
arn2 string
type3 string
processed_at ISO 8601 date and time in UTC
amount4 integer
currency ISO 4217 3-letter code
text_on_statement string
reference string
threed_secure5 string
recurring boolean
region6 string
payment_method7 string
status.code integer status code
status.message string status message
3dsecure.status string 3dsecure status
3dsecure.version string 3dsecure version
series.type12 string series type
card.type string
card.scheme string
card.country ISO 3166-1 2-letter code
card.last4 string
card.bin string
card.expire_year ISO 8601 year
card.expire_month ISO 8601 month
card.segment8 string
fraud.type9 string
fraud.date9 ISO 8601 date
settlement.amount_gross410 integer
settlement.amount_net410 integer
settlement.fees410 integer
settlement.fee_details[].type1011 string
settlement.fee_details[].amount410 integer
settlement.currency10 ISO 4217 3-letter code
1
RRN stands for “Retrieval Reference Number”.
2
ARN stands for “Acquirer Reference Number” and is available for transactions where type is one of capture, refund, credit, debit. Note that the ARN is only available after a transaction has been cleared by the card scheme, which in some rare cases can take several business days.
3
One of: authorization, capture, refund, credit, void, debit.
4
Amount in minor units of given currency (e.g. cents if in Euro).
5
One of: false, attempt, full.
6
One of: inter, intra, domestic.
7
One of: card, applepay, mobilepayonline, samsungpay, googlepay, vipps, moto, tokenized_card, token.
8
This property indicates whether the card is a consumer or business card. Values can be one of: consumer, business, unknown.
9
Fraud information is collected from TC40/SAFE data.
10
Settlement information is collected when the transaction is settled with card schemes. The settlement currency is the currency of the account.
11
One of: authorization, capture, refund, credit, debit, interchange, scheme, series, 3dsecure, late_capture.
12
One of: recurring, unscheduled.
rel conditional
self false
ch:account false
ch:settlement true

Embedded

Additional semantics

No additional semantics.

Example representation

{
  "id": "a51a3abe-8eee-4a92-b941-e89f18c5bf66",
  "rrn": "619811057524",
  "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": true,
  "region": "intra",
  "payment_method": "applepay",
  "series": {
    "type": "recurring"
  },
  "status": {
    "code": 20000
  },
  "3dsecure": {
    "status": "A",
    "version": "2.2.0"
  },
  "card": {
    "bin": "411111",
    "country": "US",
    "last4": "1111",
    "scheme": "visa",
    "type": "credit",
    "expire_year": "2022",
    "expire_month": "06",
    "segment": "consumer"
  },
  "settlement": {
    "amount_gross": 10050,
    "amount_net": 9000,
    "fees": -1050,
    "fee_details": [
      {
        "type": "capture",
        "amount": -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