Skip to navigation

Observe crypto deposit

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Myaza-VersionstringOptional
X-Request-IdstringOptional<=128 characters
Idempotency-KeystringRequiredformat: "^[A-Za-z0-9._:~-]+$"8-200 characters

Request

This endpoint expects an object.
externalDepositIdstringRequired
networkstringRequiredformat: "^[a-z][a-z0-9_-]{1,59}$"

Network code from GET /api/v1/crypto/catalogue. A catalogue entry is not proof of feed or screening coverage.

transactionHashstringRequiredformat: "^[A-Za-z0-9]{32,128}$"
outputIndexintegerRequired>=0
destinationstringRequired20-128 characters
amountstringRequiredformat: "^(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$"

Positive decimal string, never a floating-point number. At most 8 decimal places.

currencystringRequiredformat: "^[A-Z0-9]{2,12}$"
confirmationsintegerRequired>=0
observedAtdatetimeRequired

Response

Success
recordobject
replayedboolean

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error