increase-test
POST/simulations/card_settlements

Sandbox: Settle a Card Authorization

Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
amountintegeroptional
The amount to be settled. This defaults to the amount of the Pending Transaction being settled, or a random amount if `pending_transaction_id` is not provided.
card_idstringrequired
The identifier of the Card to create a settlement on.
pending_transaction_idstringoptional
The identifier of the Pending Transaction for the Card Authorization you wish to settle. If not provided, the settlement will be force posted without a Card Authorization.

3 status codes
200Transaction
account_idstringrequired
The identifier for the Account the Transaction belongs to.
amountintegerrequired
The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transaction occurred.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
Allowed:USD
descriptionstringrequired
An informational message describing this transaction. Use the fields in `source` to get more detailed information. This field appears as the line-item on the statement.
idstringrequired
The Transaction identifier.
route_idstringrequired
The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
route_typestringrequired
The type of the route this Transaction came through.
Allowed:account_numbercardlockbox
sourceobjectrequired
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
typestringrequired
A constant representing the object's type. For this resource it will always be `transaction`.
Allowed:transaction
4XXError
5XXError