Reset card transaction

POST

card-transactions

{transactionId}

reset

curl --request POST \
  --url https://api.light.inc/v1/card-transactions/{transactionId}/reset \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/card-transactions/{transactionId}/reset"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/card-transactions/{transactionId}/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.light.inc/v1/card-transactions/{transactionId}/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/card-transactions/{transactionId}/reset"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.light.inc/v1/card-transactions/{transactionId}/reset")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/card-transactions/{transactionId}/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
  "merchant": {
    "name": "<string>",
    "cleanName": "<string>",
    "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"
            }
          ]
        }
      ],
      "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amortizationStartDate": "2023-12-25",
      "amortizationEndDate": "2023-12-25"
    }
  ],
  "failureContext": {
    "name": "<string>",
    "errors": [
      {
        "type": "<string>",
        "message": "<string>",
        "path": [
          "<string>"
        ],
        "context": {}
      }
    ]
  },
  "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

Response

default - application/json;charset=UTF-8

default response

string<uuid>

companyId

string<uuid>

companyEntityId

string<uuid>

cardBalanceAccountId

string<uuid>

cardId

string<uuid>

originalAmount

integer<int64>

originalCurrency

string

Example:

"USD"

amount

integer<int64>

currency

string

Example:

"USD"

direction

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

DEBIT,

CREDIT

transactionReason

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

ACCOUNT_NOT_ACTIVE,

AMOUNT_LIMIT_EXCEEDED,

APPROVAL_EXPIRED,

APPROVED,

AUTHENTICATION_FAILED,

AUTHENTICATION_REQUIRED,

BALANCE_ACCOUNT_BLOCKED_BY_RULE,

CALL_REFERRAL,

CANCELLED,

CARD_BLOCKED,

CARD_CAPTURED,

CARD_EXPIRED,

CARD_LOST_OR_STOLEN,

CARD_RESTRICTED,

CARD_VERIFICATION_FAILED,

CASHBACK_LIMIT_EXCEEDED,

CONTACTLESS_FALLBACK,

CONTACTLESS_LIMIT_REACHED,

COUNTERPARTY_ACCOUNT_UNAVAILABLE,

COUNTERPARTY_ADDRESS_REQUIRED,

COUNTERPARTY_BANK_UNAVAILABLE,

CRYPTOGRAPHIC_FAILURE,

DECLINED,

DECLINED_BY_BAP_VALIDATION,

DECLINED_BY_TRANSACTION_RULE,

DECLINED_NON_GENERIC,

DOMESTIC_DEBIT_NOT_ALLOWED,

DO_NOT_HONOR,

DUPLICATE_TRANSMISSION,

FORMAT_ERROR,

FRAUD,

HONOR_WITH_ID,

INSUFFICIENT_FUNDS,

INTERNAL_TIMEOUT,

INVALID_ACCOUNT,

INVALID_AMOUNT,

INVALID_AUTHORIZATION_LIFECYCLE,

INVALID_CARD,

INVALID_ISSUER,

INVALID_MERCHANT,

INVALID_TRANSACTION,

ISSUER_SUSPECTED_FRAUD,

MOBILE_PIN_REQUIRED,

NOT_SUBMITTED,

NO_ACCOUNT_OF_TYPE,

OTHER,

PARTIALLY_APPROVED,

PENDING,

PIN_INVALID,

PIN_NOT_CHANGED,

PIN_REQUIRED,

PIN_TRIES_EXCEEDED,

PIN_VALIDATION_NOT_POSSIBLE,

PROVIDER_ERROR,

PURCHASE_AMOUNT_ONLY_NO_CASHBACK,

REFUSED_BY_COUNTERPARTY_BANK,

REFUSED_BY_CUSTOMER,

REVOCATION_OF_AUTH,

ROUTE_NOT_FOUND,

SCHEME_ADVICE,

SECURITY_VIOLATION,

TRANSACTION_NOT_PERMITTED,

TRANSFER_INSTRUMENT_NOT_FOUND,

TRANSFER_NOT_SUPPORTED,

UNKNOWN,

WITHDRAWAL_AMOUNT_EXCEEDED,

WITHDRAWAL_COUNT_EXCEEDED

purchaseType

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

ATM,

BALANCE_INQUIRY,

ECOMMERCE,

POS,

RECURRING,

UNKNOWN,

OTHER

status

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

AUTHORIZED,

DECLINED,

CAPTURED,

REFUNDED,

VOIDED,

POSTED

type

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:

PAYMENT,

REFUND,

OTHER

merchant

object

Show child attributes

receiptDocumentKey

string

lines

object[]

Show child attributes

failureContext

object | null

Failure context when vendor onboarding fails.

Show child attributes

editStatus

enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

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 | null)[]

Custom properties set on the vendor.

Show child attributes

Update card transactionUpdates an existing card transaction

⌘I

Reset card transaction

curl --request POST \
  --url https://api.light.inc/v1/card-transactions/{transactionId}/reset \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.light.inc/v1/card-transactions/{transactionId}/reset"

headers = {"Authorization": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

fetch('https://api.light.inc/v1/card-transactions/{transactionId}/reset', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.light.inc/v1/card-transactions/{transactionId}/reset",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.light.inc/v1/card-transactions/{transactionId}/reset"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.light.inc/v1/card-transactions/{transactionId}/reset")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.light.inc/v1/card-transactions/{transactionId}/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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",
  "merchant": {
    "name": "<string>",
    "cleanName": "<string>",
    "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"
            }
          ]
        }
      ],
      "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amortizationStartDate": "2023-12-25",
      "amortizationEndDate": "2023-12-25"
    }
  ],
  "failureContext": {
    "name": "<string>",
    "errors": [
      {
        "type": "<string>",
        "message": "<string>",
        "path": [
          "<string>"
        ],
        "context": {}
      }
    ]
  },
  "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"
        }
      ]
    }
  ]
}

Accounting Documents

Attachments

Authorization

Bank Accounts

Card Balance Accounts

Card Customers

Card Transactions

Cards

Companies

Contracts

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

User Comments

Users

Vendors

Authorizations

Path Parameters

Response