Request settlement

Requests a settlement from the available merchant balance. Available merchant balance is your current available unsettled merchant balance, less any negative balances. This endpoint will initiate an ACH transfer in the amount requested. Ansa supports at most one settlement per calendar day.

This endpoint will reject requests that are for an amount higher than the available merchant balance. We recommend calling the calculate settlement endpoint to calculate the desired settlement before attempting to request a settlement via this API.

A successful Request Settlement transaction can not be undone or reversed.

Note: Any Request Settlement call in sandbox will fail as there is no real money to settle. Contact your implementation manager if you need to test this endpoint in sandbox.



Authorization Scope

Only the merchant secret key is authorized to call this endpoint.

Path Params
string
required

The id of the merchant

Body Params
int32
required

The requested settlement amount. A positive integer in the smallest currency unit (e.g. cents for USD).

string
required

The three-letter ISO currency code, in lowercase.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json