Settles transactions

Request

POST {{baseURL}}/pay-api/v1/transactions/settle

This endpoint settles, or completes, a transaction.

A settlement transaction is the step in the payment process when an authorized transaction is finalized. The funds are transferred to the merchant's acquiring bank.

See Also:
To capture a transaction, see POST /pay-api/v1/transactions/capture.
To create a transaction, see POST /pay-api/v1/transactions/sale.
To list transactions, see GET /pay-api/v1/transactions.

Security

Bearer

Bodyapplication/json

paymentProcessorIdstring, (uuid)required

Specifies the payment processor identifier.

A list of available payment processers can be found with GET {{baseURL}}/pay-api/v1/configurations/payments. See response availablePaymentProcessors.id.

Example: 8f5a4c27-71c4-4b5d-944e-8bb457594d86

Example:"8f5a4c27-71c4-4b5d-944e-8bb457594d86"

curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-api/v1/transactions/settle \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentProcessorId": "b72b54b3-de02-430c-80c3-2908167d817c"
  }'

Responses

OK

Bodyapplication/json

codeinteger, (int32)

A vendor independent response code.

Valid values are:

Value	Name	Description
0	Approve	Operation fully or partially approved.
1	Decline	Operation declined.
2	Error	Something prevents to complete the operation. Request format is wrong, or system error, or any other reason that prevented normal processing.

Example: 0

Example:0

messagestring or null

Free-form result description.

processorResponseCodestring or null

Processor-specific response code that precisely describes the operation result.

Response

{
  "code": 0,
  "message": "string",
  "processorResponseCode": "string"
}