Settle charge

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Charge handle

Body Params
string

Optional idempotency key. Only one settle can be performed for the same handle. If two settle attempts are attempted and the first succeeds the second will fail because charge is already settled or authorized. An idempotency key identifies uniquely the request and multiple requests with the same key will yield the same result. In case of networking errors the same request with same key can safely be retried.

int32
≥ 0

Optional amount different from authorized amount to settle. Must be less than or equal to the authorized amount. Either amount or order_lines can be provided. If multiple partial settles are performed the total settled amount cannot exceed the authorized amount. If partial settles are used a subsequent settle with no amount will settle the remaining amount up to the authorized amount.

string

Optional alternative order text to use in conjunction with amount. Ignored if order_lines is provided. If new amount is provided either ordertext or order_lines must be provided, otherwise order lines will default to a single empty line.

order_lines
array of objects

Optional new order lines to replace old order lines for the charge. The order lines controls the amount. The new amount must be less than or equal to the authorized amount. See amount.

order_lines
string

Optional reference for the transaction at the acquirer. Notice the following about this argument:

  1. It only works for some acquirers.
  2. Acquirers may have rigid rules on the content of the acquirer reference. Not complying to these rules can result in declined payments.
  3. It is already possible to define custom acquirer reference using templating in the Frisbii Administration. Contact support for help. We highly recommend to only supply this argument if absolutely necessary, and the templated default acquirer reference is not sufficient. Maximum length is 128, but most acquirers require a maximum length of 22 characters. Truncating will be applied if too long for specific acquirer. Characters must match regex [\x20-\x7F]
manual_settle
object

Optional manual transfer. If given the invoice will be settled using the manual transfer transaction.

Responses

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