Skip to main content
POST
/
v3
/
api
/
interchange
/
settlement
/
status
Check the status of the settlement instructions
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/interchange/settlement/status \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "settlementRequestId": "<string>"
}
'
{
  "settlementRequestId": "<string>",
  "settlementTrackingId": "<string>",
  "status": "SETTLEMENT_INITIATED",
  "errors": {
    "message": "Available methods : GET,POST",
    "code": "ER-204"
  }
}

Authorizations

​
X-Signature
string
header
required

Body

application/json
​
settlementRequestId
string
required

id of the settlement

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