Process a Settlement

POST /cardpayments/v1/accounts/account_id/auths/authorization_id/settlements

To process a settlement, you must refer to the original authorization ID and POST your request to the settlement endpoint.

For details of invoking Split Payouts during a card settlement, click here.

Prior to trying the example, you should replace the API key (after the -u) with the API key you received.

Request Example
curl -X POST \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json' \
  -d ' {
         "merchantRefNum" : "settlementonlydemo-1"

If you do not specify an amount for settlement, the entire amount remaining on the authorization will be settled by default.

Response Example

A pending settlement is created. For most account configurations, the settlement remains pending until it is batched at the end of the day. You can cancel a settlement while it has the status of Pending, in which case the customer is not charged. However, after the settlement has been batched, you cannot cancel it, and you will need to refund the purchase.

The response contains the following obligatory parameters:

Value Type Description Example
id string Unique id for the settlement (capture). This ID can be used to look up the settlement details e50e19a6-8edd-44ec-abc4-18d0a97d51d8
links array of link objects

Contains a single "settlement" link which can be used to fetch details about the settlement (capture)

txnTime string Transaction time and date in UTC format 2013-12-14T15:12:18Z
amount integer amount settled in minor units 10098
availableToRefund integer Amount in minor units available for refunding. For example. available to refund will be 0 if the settlement failed (status=FAILED). If the settlement succeeds, it will be the same as the amount. 10098
status enum

The status of the settlement. Possible values are:

  • RECEIVED – Our system has received the request and is waiting for the downstream processor’s response.
  • PENDING – Our system has received the request but it has not yet been batched.
  • PROCESSING – The Settlement batch has started.
  • COMPLETED – The transaction has been completed.
  • FAILED – The transaction failed, due to either an error or being declined.
  • CANCELLED – The transaction request has been cancelled.

See our API Reference section for a list of all the JSON attributes and types available in the settlement object.

Did you find this page useful?