GEgetpliant
Transactions

Transaction Details (Single)

Changed on

Returns the details of a single transaction by its ID.

This endpoint has changed in comparison to the previous version of the API. The following changes were made:

  • we removed the following data from the response body: merchantId (field), merchantName (field)
  • we added the following data to the response body: merchantData (object), merchantRawData (object), authCode (field)
get/transactions/{transactionId}

Request

Path parameters

transactionIdstring uuid required

The unique identifier of the transaction.

Response

Ok

transactionIdstring uuid

The unique ID of the transaction.

organizationIdstring uuid

The unique ID of the organization to which this transaction belongs to.

cardholderIdstring uuid

The unique ID of the cardholder to which this transaction belongs to.

cardIdstring uuid

The unique ID of the card to which this transaction belongs to.

status'DECLINED' | 'PENDING' | 'REVERSED' | 'CONFIRMED' | 'BOOKED'

The status of the transaction.

type'PURCHASE' | 'CASH_WITHDRAWAL' | 'REFUND' | 'CHARGEBACK' | 'RECHARGE' | 'STATUS_INQUIRY'

The type of the transaction.

partnerSubmissionStatus'NOT_SYNCED' | 'SYNCED' | 'TEMP_LOCKED' | 'LOCKED'

This status can be driven by the partner to mark transactions on Pliant-side as consumed by the partner. TEMP_LOCKED makes transaction immutable for cardholders within Pliant apps. LOCKED makes them immutable for all users. TEMP_LOCKED can be changed to SYNCED. LOCKED is the final state that cannot be modified anymore

partnerSubmissionStatusSyncedAtstring date-time nullable

The date-time the partnerSubmissionStatus was changed to SYNCED.

partnerSubmissionStatusTempLockedAtstring date-time nullable

The date-time the partnerSubmissionStatus was changed to TEMP_LOCKED.

partnerSubmissionStatusLockedAtstring date-time nullable

The date-time the partnerSubmissionStatus was changed to LOCKED.

category'ADVERTISING_AND_MARKETING' | 'COMPUTING_AND_SOFTWARE' | 'EDUCATION_AND_TRAINING' | 'ELECTRONICS_AND_IT_EQUIPMENT' | 'ENTERTAINMENT_AND_WELLNESS' | 'FOOD_AND_DRINKS' | 'GIFTS_AND_VOUCHERS' | 'MATERIALS_AND_PACKAGING' | 'OFFICE_SUPPLIES_AND_EQUIPMENT' | 'SERVICES' | 'TRAVEL_AND_ACCOMMODATION' | 'HEALTHCARE' | 'OTHER'

The category of the transaction. This groups together similar merchants into Pliant-defined categories.

transactionCountrystring

ISO 3166-1 alpha-3 code of the country the transaction was made it, e.g. DEU for Germany or NLD for Netherlands. You can find a list of valid country code on Wikipedia.

transactionLocalTimestring date-time nullable

The date-time the transaction was made in the local time of the merchant.

createdAtstring date-time

The date-time the transaction was first recognized by Pliant, e.g. 2023-09-15T11:55:34.527552Z.

authorizedAtstring date-time nullable

The date-time this transaction was authorized by the card network, e.g. 2023-09-15T11:55:34.527552Z. Can be null in cases of not successful transactions, like a declined one.

confirmedAtstring date-time nullable

The date-time this transaction was confirmed by the card network, e.g. 2023-09-19T07:24:52.707296Z. Value is null, until the transaction is confirmed.

bookedAtstring date nullable

The date this transaction was booked by Pliant against the internal bank account of the organization, e.g. 2023-09-19. Value is null, until the transaction is booked.

reversedAtstring date-time nullable

The date-time this transaction was reversed by the card network, e.g. 2023-09-15T11:55:34.527552Z. Value is only filled, if the transaction is reversed.

linkedTransactionIdstring uuid nullable

Optional reference to any original transaction, used for recharges, chargebacks and chargeback reversals.

receiptCountinteger

Number of uploaded receipts to this transaction.

receiptIdsstring[]

The receipts attached to this transaction, if any. Otherwise, the array is empty.

receiptUploadEnabledboolean

This field describes if the transaction is waiting for a receipt, or if no receipt is expected for this transaction. If set to true its possible to upload receipts to the transaction, if set to false it is not possible to upload receipts to the transaction.

commentstring nullable

A cardholder-defined comment for this transaction.

authCodestring nullable

Authorization code used for this transaction.

paymentDatestring date nullable

The date on which the outstanding amount of this transaction was paid back to Pliant. It basically is the date the bank settlement was received by Pliant. This field is only filled after the next payment frequency cycle of this organization.

paymentReferencestring uuid nullable

The reference to the payment itself. Check the payment API to get details about the payment. This field is only filled after the next payment frequency cycle of this organization.

wallet'APPLE' | 'ANDROID' | 'OTHER'

If the transaction was made using a mobile wallet (APPLE or ANDROID), the respective wallet type is returned. Otherwise, the field is OTHER.

personalboolean

Indicates transaction was done for personal purpose.

acquirerReferenceNumberstring

The acquirer reference number as provided by the card network for the transaction.

Example response

{
  "declineReason": {
    "type": "LOCKED_CARD",
    "title": {
      "en": "Card locked"
    },
    "description": {
      "en": "The card is locked. You can unlock the card in the Wallet section of the cardholder app."
    }
  },
  "fxFee": {
    "fxFeePercentage": 2.1,
    "fxFeeAmount": {
      "value": 21,
      "currency": "EUR"
    }
  }
}

Changes