Patch Settlement

patch

https://api.partners.sandbox.nowlvble.com/v2/payments/settlements/{settlement_id}

Update the payment status of a specific settlement.

payment_status: The new payment status to set on the settlement.
Note that only specific status changes are possible (requesting other status transitions would result a 400 response):
- From any status to the same status (for example from "UNSETTLED" to "UNSETTLED")
- From "UNSETTLED" to any other status.
- From "UNVERIFIED" to "FAILED"
- From "UNVERIFIED" to "VERIFIED"
processor_transaction_id: The transaction ID of the settlement in the portal's processor.
This field can then later be used for tracking settlements easily.
Note that this field can be updated only if the settlement's current status is "UNSETTLED".
failure_reason: The reason why the settlement transaction has failed (if it failed).
Note that when updating this field on a settlement it will only work if its new status is "FAILED".,

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

settlement_id

integer

required

Body Params

This model is accepted as a request body when updating a settlement.

payment_status

string

enum

required

The status of the settlement, possible values are:

'UNSETTLED': Settlements that were not charged from Livble yet.
'UNVERIFIED': Settlements that were charged and are still processing.
'FAILED': Settlements that were charged but the transaction failed.
'VERIFIED': Settlements that were charged and the transaction was completed successfully.

Allowed:

processor_transaction_id

string

The ID of the settlement's transaction in your ACH processor.
This field can then be used to query settlements easily.
Note that when updating this field on a settlement it will only work if its current status is 'UNSETTLED'.

failure_reason

string

Reason why the settlement transaction has failed (if it failed).
Note that when updating this field on a settlement it will only work if its new status is 'FAILED'.

Responses

401

Unauthorized

200Successful Response

400Bad Request

422Validation Error