Sign in
Payment.Settlement Accounts

Get transaction

Retrieves a specific transaction for a specific settlement account and merchant.

get/payment/v1/merchants/{merchantId}/accounts/{accountId}/transactions/{transactionId}

Path parameters

merchantIdstring required

The id of the merchant.

accountIdstring required

The id of the account.

transactionIdstring required

The id of the transaction.

Query parameters

appIdEqstring

App id to filter transactions by.

Response

A successful response.

idstring

The id of the transaction.

merchantIdstring

The id of the merchant.

metadataobject

A key-value dictionary with custom metadata for the transaction.

originalTransactionIdstring

The id of the original transaction.

paymentRequestIdstring

The id of the payment request which is affiliated with this transaction.

referencestring

The transaction reference.

timestampstring date-time

The date and time the transaction was processed.

type'TRANSACTION_TYPE_UNSPECIFIED' | 'SWEEP' | 'REFUND' | 'PAYIN' | 'REVERT' | 'WITHDRAWAL' | 'MERCHANT_PAYIN' | 'EXTERNAL_PAYIN' | 'TRANSFER' | 'PAYMENT_REVERSAL'

The type of the transaction.

  • TRANSACTION_TYPE_UNSPECIFIED: Default value for transaction type when none of the other types can be assigned.
  • SWEEP: A scheduled payout to Merchant corporate account.
  • REFUND: Partial or full refund to the original payer of previously received funds.
  • PAYIN: Received payment which increases settlement account balance.
  • REVERT: A corrective transaction which reverses transaction made in error.
  • WITHDRAWAL: Payout to an end-user's bank account.
  • MERCHANT_PAYIN: Received payment from the merchant's payout account.
  • EXTERNAL_PAYIN: Received direct bank payment (outside Tink PIS).
  • TRANSFER: A payout from the account.
  • PAYMENT_REVERSAL: The reversal of a payment from the account. Indicates that the payout has been reverted after being initially marked as succeeded.

Example response

{
  "accountBalance": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "400"
    }
  },
  "amount": {
    "currencyCode": "GBP",
    "value": {
      "scale": "2",
      "unscaledValue": "12300"
    }
  },
  "id": "817465f1-adbf-493b-bf7e-d167c39289ba",
  "merchantId": "bef35277-ec45-4445-a153-05dbb42390df",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "originalTransactionId": "",
  "payee": {
    "account": {
      "identifier": "00000070438944",
      "type": "SORT_CODE"
    },
    "beneficiaryId": "d502bbff-8e44-49ee-bab6-093a0d1787e2",
    "name": "John Smith"
  },
  "payer": {
    "account": {
      "identifier": "00000070438943",
      "type": "SORT_CODE"
    },
    "beneficiaryId": "d502bbff-8e44-49ee-bab6-093a0d1787ed",
    "name": "John Smith"
  },
  "paymentRequestId": "a4d82dd0901411ed9f8787175ad2c3e2",
  "reference": "Wdr7ad0feabb4ab",
  "timestamp": "2021-07-14T14:01:53Z",
  "type": "PAYIN"
}