Skip to main content
POST
/
v3
/
api
/
interchange
/
settlements
Retrieve settlements
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/interchange/settlements \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "settlementRequestIds": [
    "<string>"
  ],
  "fromDate": "<string>",
  "toDate": "<string>",
  "statuses": [
    "SETTLEMENT_INITIATED"
  ],
  "paginationLimit": 123,
  "paginationOffset": 123
}
'
{
  "items": [
    {
      "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",
          "currencyId": "eth-USDC",
          "currency": "USDC",
          "ledger": "ETH",
          "amount": "<string>",
          "externalSettlementId": "<string>",
          "transferId": "<string>",
          "transactionHash": "<string>",
          "status": "<string>"
        }
      ],
      "netSettlements": [
        {
          "counterparty": {
            "type": "WALLET_ID",
            "value": "<string>"
          },
          "settlementDirection": "PAY",
          "currency": "USDC",
          "ledger": "ETH",
          "transferAmount": {
            "amount": "6482,14",
            "amountLedger": "648.214.000.000",
            "amountFiat": "32,41"
          },
          "transferId": "<string>",
          "transactionHash": "<string>",
          "status": "<string>",
          "currencyId": "eth-USDC"
        }
      ]
    }
  ],
  "total": 123
}

Authorizations

X-Signature
string
header
required

Body

application/json
settlementRequestIds
string[]
fromDate
string<yyyy-MM-dd>

Starting from date of request

toDate
string<yyyy-MM-dd>

Up until date of request

statuses
enum<string>[]

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
paginationLimit
number

Number of items in response (default is 10)

paginationOffset
number

Response

OK

items
object[]
required
total
integer
required

total count of matching records