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.

See our full API documentation for a complete description of the parameters required for the Settlement request.
Request Example
curl -X POST https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/auths/6ce78961-5989-4c4b-ad68-5f5af506143e/settlements \
  -u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
  -H 'Content-Type: application/json' \
  -d ' {
 	"merchantRefNum": "settlementonlydemo-1"
 }'
Prior to trying the example, you should replace the API key (after the -u) with the API key you received.

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

The request contains the following parameters:

Element Type Required? Description
merchantRefNum

string
length<=255

Yes This is the merchant reference number created by the merchant and submitted as part of the request. A unique merchant reference number must be provided for each transaction.
Response Example
{
  "links":[
    {
      "rel":"self",
      "href":"https://api.test.paysafe.com/cardpayments/v1/accounts/89987201/settlements/0fd73475-9837-4613-8464-355a3a99b8bb"
    }
  ],
  "id":"0fd73475-9837-4613-8464-355a3a99b8bb",
  "merchantRefNum":"settlementonlydemo-1",
  "txnTime":"2017-05-05T13:09:47Z",
  "status":"PENDING",
  "amount":10098,
  "availableToRefund":10098
}

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 parameters:

Element Type Description
links array of link objects

This parameter contains a single settlement link which can be used to fetch details about the settlement (capture).

id string
length<=36
This is the unique ID for the settlement (capture). This ID can be used to look up the settlement details.
txnTime string This is the transaction time and date in UTC format.
status enum

This is 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.
amount integer
max=99999999999
This is the amount settled in minor units.
availableToRefund integer
max=99999999999
This is the amount in minor units available for refunding. For example, the availableToRefund parameter will be 0 if the settlement failed (status=FAILED). If the settlement succeeds, it will be the same as the amount.
Did you find this page useful?