Skip to main content
PATCH
/
v1
/
card-transactions
/
{transactionId}
Update card transaction
curl --request PATCH \
  --url https://api.light.inc/v1/card-transactions/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '{
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "description": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cardBalanceAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originalAmount": 123,
  "originalCurrency": "USD",
  "amount": 123,
  "currency": "USD",
  "direction": "DEBIT",
  "transactionReason": "APPROVED",
  "purchaseType": "ATM",
  "status": "AUTHORIZED",
  "type": "PAYMENT",
  "merchant": {
    "name": "<string>",
    "cleanName": "<string>",
    "country": "UNDEFINED",
    "zipcode": "<string>",
    "id": "<string>",
    "mcc": "<string>",
    "acquirerId": "<string>",
    "logoUrl": "<string>"
  },
  "receiptDocumentKey": "<string>",
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "netAmount": 123,
      "taxAmount": 123,
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "customProperties": [
        {
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "values": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupInternalName": "<string>",
              "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "internalName": "<string>",
              "label": "<string>",
              "context": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "failureContext": {
    "type": "BAD_REQUEST",
    "errors": [
      {
        "type": "<string>",
        "clientMessage": "<string>",
        "message": "<string>",
        "path": [
          "<string>"
        ],
        "context": {}
      }
    ],
    "stackTrace": [
      {
        "classLoaderName": "<string>",
        "moduleName": "<string>",
        "moduleVersion": "<string>",
        "methodName": "<string>",
        "fileName": "<string>",
        "lineNumber": 123,
        "nativeMethod": true,
        "className": "<string>"
      }
    ],
    "message": "<string>",
    "suppressed": [
      {
        "stackTrace": [
          {
            "classLoaderName": "<string>",
            "moduleName": "<string>",
            "moduleVersion": "<string>",
            "methodName": "<string>",
            "fileName": "<string>",
            "lineNumber": 123,
            "nativeMethod": true,
            "className": "<string>"
          }
        ],
        "message": "<string>",
        "localizedMessage": "<string>"
      }
    ],
    "localizedMessage": "<string>",
    "name": "<string>"
  },
  "editStatus": "ALL_EDITS_ALLOWED",
  "description": "<string>",
  "performedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

​
transactionId
string<uuid>
required

Body

application/json;charset=UTF-8
​
customProperties
object[] | null
​
description
string | null

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>
​
companyId
string<uuid>
​
companyEntityId
string<uuid>
​
cardBalanceAccountId
string<uuid>
​
cardId
string<uuid>
​
originalAmount
integer
​
originalCurrency
string
Example:

"USD"

​
amount
integer
​
currency
string
Example:

"USD"

​
direction
enum<string>
Available options:
DEBIT,
CREDIT
​
transactionReason
enum<string>
Available options:
APPROVED,
INSUFFICIENT_FUNDS,
OTHER
​
purchaseType
enum<string>
Available options:
ATM,
BALANCE_INQUIRY,
ECOMMERCE,
POS,
RECURRING,
UNKNOWN,
OTHER
​
status
enum<string>
Available options:
AUTHORIZED,
DECLINED,
CAPTURED,
REFUNDED,
VOIDED,
POSTED
​
type
enum<string>
Available options:
PAYMENT,
REFUND,
OTHER
​
merchant
object
​
receiptDocumentKey
string
​
lines
object[]
​
failureContext
object
​
editStatus
enum<string>
Available options:
ALL_EDITS_ALLOWED,
LINE_AMOUNT_EDITS_LOCKED,
ALL_EDITS_LOCKED
​
description
string
​
performedAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
updatedBy
string<uuid>
​
customProperties
object[]
⌘I