Create a settlement

This API endpoint returns the settlement document requested.

🚧

What can cause a bad request (HTTP code 400)?

  • merchantId is empty.
  • idempotentId is empty.
  • idempotentId is duplicated.
  • enterpriseId is not a valid enterprise.

Successful response payload data

Parameter nameTypeDescription
idstringThe ID of the settlement generated.
merchantIdstringThe ID of the merchant.
idempotentIdstringThe ID of the request to generate the settlement.
typestringThe type of transaction in the settlement file.
totalTransactionsstringThe number of transactions in the settlement.
statusstringThe status of generating the settlement.
amountstringThe amount of the settlement.
Language
Authorization
Click Try It! to start a request and see the response here!