> For the complete documentation index, see [llms.txt](https://www.pionex.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.pionex.com/docs/api-docs/institution-api/deposit.md).
# Deposit
Fiat deposit accounts and deposit orders (requires platform KYB APPROVED).
## List deposit accounts
> List the fiat deposit accounts for a \`userId\`. Requires the \`userId\`'s\
> platform KYB to be \`APPROVED\` (otherwise\
> \`P\_PAY\_OPEN\_API\_INTERNAL\_KYB\_NOT\_APPROVED\`).
```json
{"openapi":"3.0.3","info":{"title":"Pionex Institution Open API (v2)","version":"2.0.0"},"tags":[{"name":"Deposit","description":"Fiat deposit accounts and deposit orders (requires platform KYB APPROVED)."}],"servers":[{"url":"https://api.pionex.com","description":"Production"}],"security":[{"ApiKey":[],"Signature":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-APIKEY","description":"Your institution API Key, in the form `webot_xxxxxxxx`. Used to look up\nyour registered public key. Must be accompanied by the `X-Signature`\nheader. See the Authentication section for the full signing algorithm\n(RSA-PSS over SHA-256, or Ed25519) and the canonical-string construction.\n"}},"parameters":{"Timestamp":{"name":"timestamp","in":"query","required":true,"description":"Current time in **seconds** (Unix). Required on every signed request and\nparticipates in the signature. Must be within +/-5 seconds of server time.\n","schema":{"type":"integer","format":"int64"}},"UserIdQueryRequired":{"name":"userId","in":"query","required":true,"description":"Target sub-account UUID. Participates in the signature.","schema":{"type":"string"}},"Page":{"name":"page","in":"query","required":false,"description":"Page number, starting from 1.","schema":{"type":"integer"}},"Size":{"name":"size","in":"query","required":false,"description":"Page size.","schema":{"type":"integer"}}},"schemas":{"BaseResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Success indicator."},"timestamp":{"type":"integer","format":"int64","description":"Response timestamp in milliseconds."},"code":{"type":"string","description":"Error code (present only on failure)."},"message":{"type":"string","description":"Error message (present only on failure)."}}},"DepositAccount":{"type":"object","properties":{"channel":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["PENDING","ACTIVE","UNAVAILABLE","CLOSED"],"description":"`PENDING` (not yet remittable) / `ACTIVE` (remittable) / `UNAVAILABLE` / `CLOSED`."},"channelStatus":{"type":"string"},"instructions":{"type":"array","items":{"$ref":"#/components/schemas/FundingInstruction"}},"feeAmount":{"type":"string"},"minDepositAmount":{"type":"string"},"maxDepositAmount":{"type":"string"}}},"FundingInstruction":{"type":"object","description":"Wire funding instruction fields.","properties":{"rails":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"bankName":{"type":"string"},"bankAddress":{"type":"string"},"accountNumber":{"type":"string"},"routingCode":{"type":"string"},"routingCodeAlternate":{"type":"string"},"swiftBic":{"type":"string"},"accountHolderName":{"type":"string"},"accountHolderAddress":{"type":"string"},"reference":{"type":"string"},"channelExtra":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}}}},"KeyValue":{"type":"object","description":"A generic key/value pair.","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"responses":{"BadRequest":{"description":"Bad Request - the request body could not be read.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"Unauthorized":{"description":"Unauthorized - authentication failed (missing key, bad signature, etc.).","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"InternalError":{"description":"Internal or business error. Note that most business failures are returned\nas HTTP `200` with `result: false` and a `code`; this `500` covers\nserver-side internal errors.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}}}},"paths":{"/api/v2/institution/wire/deposit/accounts":{"get":{"tags":["Deposit"],"summary":"List deposit accounts","description":"List the fiat deposit accounts for a `userId`. Requires the `userId`'s\nplatform KYB to be `APPROVED` (otherwise\n`P_PAY_OPEN_API_INTERNAL_KYB_NOT_APPROVED`).\n","operationId":"institutionDepositAccountsList","parameters":[{"$ref":"#/components/parameters/Timestamp"},{"$ref":"#/components/parameters/UserIdQueryRequired"},{"name":"channel","in":"query","required":true,"description":"Channel.","schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"description":"ISO 4217.","schema":{"type":"string"}},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/Size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/DepositAccount"}},"total":{"type":"integer"}}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```
## List deposit orders
> List deposit orders for a \`userId\`. Requires the \`userId\`'s platform KYB to\
> be \`APPROVED\`.
```json
{"openapi":"3.0.3","info":{"title":"Pionex Institution Open API (v2)","version":"2.0.0"},"tags":[{"name":"Deposit","description":"Fiat deposit accounts and deposit orders (requires platform KYB APPROVED)."}],"servers":[{"url":"https://api.pionex.com","description":"Production"}],"security":[{"ApiKey":[],"Signature":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-APIKEY","description":"Your institution API Key, in the form `webot_xxxxxxxx`. Used to look up\nyour registered public key. Must be accompanied by the `X-Signature`\nheader. See the Authentication section for the full signing algorithm\n(RSA-PSS over SHA-256, or Ed25519) and the canonical-string construction.\n"}},"parameters":{"Timestamp":{"name":"timestamp","in":"query","required":true,"description":"Current time in **seconds** (Unix). Required on every signed request and\nparticipates in the signature. Must be within +/-5 seconds of server time.\n","schema":{"type":"integer","format":"int64"}},"UserIdQueryRequired":{"name":"userId","in":"query","required":true,"description":"Target sub-account UUID. Participates in the signature.","schema":{"type":"string"}},"StartTime":{"name":"startTime","in":"query","required":false,"description":"Start time, millisecond Unix timestamp.","schema":{"type":"integer","format":"int64"}},"EndTime":{"name":"endTime","in":"query","required":false,"description":"End time, millisecond Unix timestamp.","schema":{"type":"integer","format":"int64"}},"Page":{"name":"page","in":"query","required":false,"description":"Page number, starting from 1.","schema":{"type":"integer"}},"Size":{"name":"size","in":"query","required":false,"description":"Page size.","schema":{"type":"integer"}}},"schemas":{"BaseResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Success indicator."},"timestamp":{"type":"integer","format":"int64","description":"Response timestamp in milliseconds."},"code":{"type":"string","description":"Error code (present only on failure)."},"message":{"type":"string","description":"Error message (present only on failure)."}}},"DepositOrder":{"type":"object","properties":{"orderId":{"type":"string"},"channel":{"type":"string"},"creditCurrency":{"type":"string"},"receivedCurrency":{"type":"string"},"receivedAmount":{"type":"string"},"feeAmount":{"type":"string"},"creditAmount":{"type":"string"},"status":{"type":"string","enum":["PENDING","CREDITED","COMPLETED","FAILED","CANCELED"],"description":"`PENDING` (processing) / `CREDITED` (credited, not settled) / `COMPLETED` (final) / `FAILED` (final) / `CANCELED` (final)."},"rail":{"type":"string"},"rate":{"type":"string"},"reason":{"$ref":"#/components/schemas/Reason"},"createdAt":{"type":"integer","format":"int64","description":"Millisecond Unix timestamp; `0` until the event occurs."},"updatedAt":{"type":"integer","format":"int64"},"creditedAt":{"type":"integer","format":"int64","description":"`0` before crediting."},"completedAt":{"type":"integer","format":"int64","description":"`0` before the order is final."}}},"Reason":{"type":"object","description":"Failure/return reason, present only when a channel returns one.","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean","description":"Whether the same request/order may be retried."}}}},"responses":{"BadRequest":{"description":"Bad Request - the request body could not be read.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"Unauthorized":{"description":"Unauthorized - authentication failed (missing key, bad signature, etc.).","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"InternalError":{"description":"Internal or business error. Note that most business failures are returned\nas HTTP `200` with `result: false` and a `code`; this `500` covers\nserver-side internal errors.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}}}},"paths":{"/api/v2/institution/wire/deposit/orders":{"get":{"tags":["Deposit"],"summary":"List deposit orders","description":"List deposit orders for a `userId`. Requires the `userId`'s platform KYB to\nbe `APPROVED`.\n","operationId":"institutionDepositOrdersList","parameters":[{"$ref":"#/components/parameters/Timestamp"},{"$ref":"#/components/parameters/UserIdQueryRequired"},{"name":"channel","in":"query","required":true,"description":"Channel.","schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/StartTime"},{"$ref":"#/components/parameters/EndTime"},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/Size"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/DepositOrder"}},"total":{"type":"integer"}}}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```
## Get a deposit order
> Get a single deposit order. On a non-success status (e.g. \`FAILED\`), the\
> order also carries a \`reason\` object.
```json
{"openapi":"3.0.3","info":{"title":"Pionex Institution Open API (v2)","version":"2.0.0"},"tags":[{"name":"Deposit","description":"Fiat deposit accounts and deposit orders (requires platform KYB APPROVED)."}],"servers":[{"url":"https://api.pionex.com","description":"Production"}],"security":[{"ApiKey":[],"Signature":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-APIKEY","description":"Your institution API Key, in the form `webot_xxxxxxxx`. Used to look up\nyour registered public key. Must be accompanied by the `X-Signature`\nheader. See the Authentication section for the full signing algorithm\n(RSA-PSS over SHA-256, or Ed25519) and the canonical-string construction.\n"}},"parameters":{"Timestamp":{"name":"timestamp","in":"query","required":true,"description":"Current time in **seconds** (Unix). Required on every signed request and\nparticipates in the signature. Must be within +/-5 seconds of server time.\n","schema":{"type":"integer","format":"int64"}},"UserIdQueryRequired":{"name":"userId","in":"query","required":true,"description":"Target sub-account UUID. Participates in the signature.","schema":{"type":"string"}}},"schemas":{"BaseResponse":{"type":"object","properties":{"result":{"type":"boolean","description":"Success indicator."},"timestamp":{"type":"integer","format":"int64","description":"Response timestamp in milliseconds."},"code":{"type":"string","description":"Error code (present only on failure)."},"message":{"type":"string","description":"Error message (present only on failure)."}}},"DepositOrder":{"type":"object","properties":{"orderId":{"type":"string"},"channel":{"type":"string"},"creditCurrency":{"type":"string"},"receivedCurrency":{"type":"string"},"receivedAmount":{"type":"string"},"feeAmount":{"type":"string"},"creditAmount":{"type":"string"},"status":{"type":"string","enum":["PENDING","CREDITED","COMPLETED","FAILED","CANCELED"],"description":"`PENDING` (processing) / `CREDITED` (credited, not settled) / `COMPLETED` (final) / `FAILED` (final) / `CANCELED` (final)."},"rail":{"type":"string"},"rate":{"type":"string"},"reason":{"$ref":"#/components/schemas/Reason"},"createdAt":{"type":"integer","format":"int64","description":"Millisecond Unix timestamp; `0` until the event occurs."},"updatedAt":{"type":"integer","format":"int64"},"creditedAt":{"type":"integer","format":"int64","description":"`0` before crediting."},"completedAt":{"type":"integer","format":"int64","description":"`0` before the order is final."}}},"Reason":{"type":"object","description":"Failure/return reason, present only when a channel returns one.","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean","description":"Whether the same request/order may be retried."}}}},"responses":{"BadRequest":{"description":"Bad Request - the request body could not be read.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"Unauthorized":{"description":"Unauthorized - authentication failed (missing key, bad signature, etc.).","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}},"InternalError":{"description":"Internal or business error. Note that most business failures are returned\nas HTTP `200` with `result: false` and a `code`; this `500` covers\nserver-side internal errors.\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}}}}}},"paths":{"/api/v2/institution/wire/deposit/order":{"get":{"tags":["Deposit"],"summary":"Get a deposit order","description":"Get a single deposit order. On a non-success status (e.g. `FAILED`), the\norder also carries a `reason` object.\n","operationId":"institutionDepositOrderGet","parameters":[{"$ref":"#/components/parameters/Timestamp"},{"$ref":"#/components/parameters/UserIdQueryRequired"},{"name":"orderId","in":"query","required":true,"schema":{"type":"string"}},{"name":"channel","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DepositOrder"}}}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```