Skip to main content
POST
Create a settlement instruction

Body

application/json
header
object
required
settlements
object[]
required

List of Settlement Instructions

netSettlements
object[]
required

Netted Settlement Instructions

Response

OK

settlementRequestId
string
required
settlementTrackingId
string
required
status
enum<string>
required

Status of settlement request

Available options:
SETTLEMENT_RECEIVED,
SETTLEMENT_INITIATED,
SETTLEMENT_AWAITING_FUNDS,
SETTLEMENT_PAY_IN,
SETTLEMENT_PAY_OUT,
SETTLEMENT_COMPLETE,
SETTLEMENT_REJECTED,
SETTLEMENT_FAILED
Example:

"SETTLEMENT_INITIATED"

errors
object
required

One or more details about the error