Skip to main content
POST
/
v3
/
api
/
interchange
/
settlement
/
create
Create a settlement instruction
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/interchange/settlement/create \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "header": {
    "status": "SETTLEMENT_INITIATED",
    "venueId": "<string>",
    "errors": "<string>",
    "settlementRequestId": "<string>",
    "requestDateTime": "<string>",
    "receivableAddresses": [
      {
        "address": "<string>",
        "ledger": "<string>",
        "destinationTag": 2147483647,
        "memo": "<string>"
      }
    ],
    "instructionCount": 123
  },
  "settlements": [
    {
      "counterparty": {
        "type": "WALLET_ID",
        "value": "<string>"
      },
      "settlementDirection": "PAY",
      "currency": "ETH",
      "ledger": "ETH",
      "amount": "<string>",
      "externalSettlementId": "<string>",
      "executionDate": "<string>"
    }
  ],
  "netSettlements": [
    {
      "settlementDirection": "PAY",
      "currency": "ETH",
      "ledger": "ETH",
      "amount": "<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
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