Credit

Performs a standalone credit (general credit) returning funds to a customer without referencing an original sale. Only available when the merchant's gateway supports the general credit feature; otherwise returns a 400 error. Prefer refund routes when reversing a known prior transaction.

Use Cases: Goodwill adjustments, manual payouts where an original transaction does not exist.

Restrictions & Considerations:

  • Gateway must permit general credits; feature is rarely enabled by default.
  • May trigger higher fraud scrutiny; velocity limits can apply.
  • Amount must be >= 0.01.
  • Inventory adjustments: meta.update_inventory indicates stock changes (often inverted).

Differences vs Refund:

  • Refund references a prior sale; credit does not.
  • Settlement tokenization is not required for credit.

Security: ApiKeyAuth or EphemeralAuth.

Errors: 400 gateway reject, 422 validation, cancellation by user.

Polling & Receipts: Same as charge.

🚧

General credits are risky, and therefore not allowed for every merchant account. It is recommended to correlate any credits to an original transaction by performing a refund or void instead. For more information about general credits for your account, please reach out to support.

Body Params
float
required

this float is required and will be the amount a customer is credited.

json

i.e. {"tax":2,"subtotal":10} can contain any json objectwill be blindly stored and returned during a GET operation.values in meta may also appear in an email receipt if the template calls for it.the Stax front-end uses subtotal, tax, memo, lineItems = [].

string
enum
Defaults to Both

Possible values: No, Merchant, Customer, Both. (defaults to Both).

Allowed:
string
enum
Defaults to Credit

Possible values: Credit, Debit, Check, Gift, Loyalty

Allowed:
string

The id of the customer attributed to this credit.

string

The id of the invoice attributed to this charge.

string
required

The id of the register performing this operation.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json