Mark a transaction declined

POST 
/api/v3/transaction/:transaction_id/_action/decline

If ChargeOver is unable to get informaton back about NSF payments from your ACH payment gateway, you can use this API call to manually mark a transaction as declined via the API.

Optionally, you can specify values for the gateway_msg, gateway_err_code, and gateway_err_detail fields to supply more information about the failed transaction.

For the gateway_msg field, you can put the message from your gateway about why the transaction failed. For instance, if a transaction failed because of insufficient funds, you could put "Insufficient Funds" in for this field.

If you are not sure what error code to use for the gateway_err_code field, you can view our list of payment processor error codes here.

Request

application/json

Body

gateway_msg string
gateway_err_code string
gateway_err_detail string

Responses

200

Action completed successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": true
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...