Update Several Transaction Field Values or Transaction Status

put https://stage.check21.com/c2/api/transaction/{id}

The PUT Transaction endpoint, in most cases, is used to change the status of the transaction from Pending Credit or Pending Deposit to deleted. This can occur only before cutoff time. A limited amount of fields can also be edited while in Pending status.

Path Params

integer

required

The Transaction ID was provided during the submission of the Transaction to the POST Transaction Endpoint.

Body Params

int32

required

merchantAccountId

int32

required

This is the initial value of the depositBankId or creditBankId field used during the POST Transaction process.

amount

double

orderId

string

memo

string

checkNumber

string

micr

string

length between 18 and 50

status

string

required

Only if a transaction is in Pending status can it be marked for deletion. Please note, a credit cannot be converted to a deposit and a deposit cannot be converted into a credit.

Headers

string

required

application/json should be set.

X-Auth-ApiKeyContent

string

required

Can be found in the administrative user profile within the Check21.com Gateway

X-Auth-ApiKeyAccess

string

required

Can be found in the administrative user profile within the Check21.com Gateway

Content-Type

string

required

application/json should be set.

Responses

xxxxxxxxxx
curl --request PUT \
     --url https://stage.check21.com/c2/api/transaction/id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"status":"DELETED"}'

200Successful submission to Check21.com returned.

500Account ID is not authorized or Transaction ID Cannot be Found. Ensure proper API keys and Account ID is being utilized and the Transaction ID queried is correct. See message for more information.