> ## Documentation Index > Fetch the complete documentation index at: https://docs.halliday.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get withdrawal status > Poll the status of a withdrawal using the `withdraw_id` returned by `POST /payments/withdraw` and `POST /payments/withdraw/confirm`. Clients can start tracking a withdrawal as soon as `POST /payments/withdraw` returns, before the user signs. The confirm endpoint waits up to `polling_timeout` for the withdrawal to land and returns `PENDING` if it has not completed in time. Keep polling this endpoint until the status is `SUCCESS`, `FAILED`, or `EXPIRED`. `transaction_hash` is null while the withdrawal is pending. ## OpenAPI ````yaml /public/openapi.yaml get /payments/withdraw/status openapi: 3.1.0 info: title: Halliday description: > Halliday's payment infrastructure, supporting onramps, swaps, and offramps. This API provides a unified interface for cryptocurrency payments, allowing developers to: - Quote payments across multiple providers - Execute payments with onramps, swaps, and offramps - Track payment status and history ## Authentication API key authentication is required for all endpoints. version: 2.0.0 contact: name: Contact Halliday url: https://halliday.xyz email: support@halliday.xyz servers: - url: https://v2.prod.halliday.xyz description: Base domain security: - ApiKeyAuth: [] tags: - name: Chains description: Blockchain network information and configuration - name: Assets description: Asset information, discovery, and supported asset pairs - name: Geolocation description: >- Resolve an end user's IP address to a location and default fiat currency before quoting - name: Prices description: Current token prices denominated in a fiat currency - name: Payments description: >- Core payment operations including quotes, confirmation, and status tracking - name: Webhooks description: > Register HTTPS endpoints to receive signed notifications when a workflow reaches a terminal state, instead of polling for status. You subscribe to one or more event types per webhook. | Event type | Fires when a workflow's status becomes | | --- | --- | | `WORKFLOW_COMPLETED` | `COMPLETE` | | `WORKFLOW_FAILED` | `FAILED` | All management endpoints live under `/orgs/webhooks` and authenticate with a secret API key (passed as a bearer token) that has webhook access. Publishable keys cannot manage webhooks. **Integration checklist** - Receiver is a public HTTPS endpoint (no private IPs). - Save the `signing_secret` when you create the webhook — it is shown only once. - Verify `X-Halliday-Signature` against the raw body, accepting any of its comma-separated signatures. - Respond `2xx` quickly and do the real work afterward. - Skip deliveries whose `id` you have already handled. paths: /payments/withdraw/status: get: tags: - Payments summary: Get withdrawal status description: > Poll the status of a withdrawal using the `withdraw_id` returned by `POST /payments/withdraw` and `POST /payments/withdraw/confirm`. Clients can start tracking a withdrawal as soon as `POST /payments/withdraw` returns, before the user signs. The confirm endpoint waits up to `polling_timeout` for the withdrawal to land and returns `PENDING` if it has not completed in time. Keep polling this endpoint until the status is `SUCCESS`, `FAILED`, or `EXPIRED`. `transaction_hash` is null while the withdrawal is pending. operationId: getWithdrawStatus parameters: - name: withdraw_id in: query required: true description: >- Withdrawal identifier returned by `POST /payments/withdraw` and `POST /payments/withdraw/confirm` schema: type: string format: uuid example: 9d1f6c2e-3b7a-4c8d-9e0f-1a2b3c4d5e6f responses: '200': description: Withdrawal status retrieved successfully content: application/json: schema: $ref: '#/components/schemas/WithdrawStatusResponse' example: withdraw_id: 9d1f6c2e-3b7a-4c8d-9e0f-1a2b3c4d5e6f payment_id: 41b16a6f-704e-44ba-9964-2b66df8a73e8 status: SUCCESS transaction_hash: >- 0x7d3c1f2a9b8e4d6c5a1f0e9d8c7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' example: errors: - code: invalid_format path: - withdraw_id message: Invalid UUID '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - kind: other message: Invalid API key '404': description: Withdrawal not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - kind: other message: Withdrawal 9d1f6c2e-3b7a-4c8d-9e0f-1a2b3c4d5e6f not found components: schemas: WithdrawStatusResponse: type: object required: - withdraw_id - status - transaction_hash properties: withdraw_id: type: string format: uuid description: ID of the withdrawal payment_id: type: string description: ID of the payment the withdrawal belongs to status: type: string enum: - PENDING - SUCCESS - FAILED - EXPIRED description: Status of the withdrawal transaction_hash: anyOf: - type: string - type: 'null' description: >- Blockchain transaction hash for the withdrawal, or null while the withdrawal is pending ValidationErrorResponse: type: object description: > Returned when a request body fails schema validation. `errors` contains one entry per validation issue. required: - errors properties: errors: type: array items: type: object required: - code - path - message properties: code: type: string description: Validation issue code (for example `invalid_type`). example: invalid_type expected: type: string description: Expected type. Present on type-mismatch issues. example: string path: type: array description: Path to the offending field in the request body. items: type: - string - integer example: - label message: type: string example: 'Invalid input: expected string, received undefined' ErrorResponse: type: object required: - errors properties: errors: type: array items: $ref: '#/components/schemas/Issue' description: Error response for known errors Issue: oneOf: - $ref: '#/components/schemas/AmountIssue' - $ref: '#/components/schemas/AmountDownstreamIssue' - $ref: '#/components/schemas/FundingIssue' - $ref: '#/components/schemas/OwnerIssue' - $ref: '#/components/schemas/GeolocationIssue' - $ref: '#/components/schemas/ProviderIssue' - $ref: '#/components/schemas/PayinMethodIssue' - $ref: '#/components/schemas/OtherIssue' - $ref: '#/components/schemas/UnknownIssue' - $ref: '#/components/schemas/OrgConfigurationIssue' - $ref: '#/components/schemas/ParkedFundIssue' - $ref: '#/components/schemas/DestinationIssue' - $ref: '#/components/schemas/PayoutMethodIssue' - $ref: '#/components/schemas/KycIssue' discriminator: propertyName: kind AmountIssue: type: object required: - kind - asset - given - limits - source - message - reason properties: kind: type: string enum: - amount asset: $ref: '#/components/schemas/Asset' given: $ref: '#/components/schemas/Amount' limits: $ref: '#/components/schemas/Limits' downstream_limits: $ref: '#/components/schemas/Limits' source: type: string message: type: string reason: type: string enum: - TOO_LOW - TOO_HIGH - UNEXPECTEDLY_LOW - UNEXPECTEDLY_HIGH - NO_VALID_AMOUNT - UNKNOWN AmountDownstreamIssue: type: object required: - kind - asset - given - limits - source - message - reason properties: kind: type: string enum: - amount-downstream asset: $ref: '#/components/schemas/Asset' given: $ref: '#/components/schemas/Amount' limits: $ref: '#/components/schemas/Limits' downstream_limits: $ref: '#/components/schemas/Limits' source: type: string message: type: string reason: type: string enum: - TOO_LOW - TOO_HIGH - UNEXPECTEDLY_LOW - UNEXPECTEDLY_HIGH - NO_VALID_AMOUNT - UNKNOWN FundingIssue: type: object required: - kind - token - balance properties: kind: type: string enum: - funding token: $ref: '#/components/schemas/Token' balance: type: object required: - '#' properties: '#': type: string description: Balance amount as a decimal string. description: Current token balance at the funding address. OwnerIssue: type: object required: - kind - message - mitigation properties: kind: type: string enum: - owner message: type: string mitigation: type: string enum: - change - verify GeolocationIssue: type: object required: - kind - message properties: kind: type: string enum: - geolocation message: type: string ProviderIssue: type: object required: - kind - message properties: kind: type: string enum: - provider message: type: string PayinMethodIssue: type: object required: - kind - message properties: kind: type: string enum: - payin_method message: type: string OtherIssue: type: object required: - kind - message properties: kind: type: string enum: - other message: type: string UnknownIssue: type: object required: - kind - message properties: kind: type: string enum: - unknown message: type: string OrgConfigurationIssue: type: object required: - kind - message properties: kind: type: string enum: - org_configuration message: type: string rev_share_pct: type: string total_pct: type: string threshold: type: string ParkedFundIssue: type: object description: >- Funds are held at a deposit address associated with the owner and are not being processed. required: - kind - token - balance - classification - severity - payment_gist - withdraw_from properties: kind: type: string enum: - parked_fund token: $ref: '#/components/schemas/Token' balance: type: object required: - '#' properties: '#': type: string description: >- Integer amount in the token's smallest unit, serialized as a string. example: '25500000' description: > Token balance parked at the address, as an integer in the token's smallest unit. The `{"#": "..."}` wrapper is how the API serializes integers too large for a JSON number. Divide by the token's `decimals` from `GET /assets` to display it, for example `{"#": "25500000"}` is 25.5 USDC. Note that `POST /payments/balances` reports the same funds as a plain decimal string (`"25.5"`). classification: type: string enum: - MISSENT - STUCK - UNDERFUNDED - STALLED - EXTRA - SLIPPED - DELAYED description: Why the funds are parked. severity: type: string enum: - HIGH - LOW payment_gist: $ref: '#/components/schemas/PaymentGist' description: Summary of the payment the funds were intended for, or null. withdraw_from: $ref: '#/components/schemas/WithdrawFrom' description: >- Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API. DestinationIssue: type: object required: - kind - message properties: kind: type: string enum: - destination message: type: string PayoutMethodIssue: type: object required: - kind - message properties: kind: type: string enum: - payout_method message: type: string KycIssue: type: object required: - kind - message properties: kind: type: string enum: - kyc message: type: string provider_id: type: string Asset: type: string description: >- Identifier in the token format ("chain:address") or fiat currency code ("USD") example: ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 Amount: type: string description: A decimal amount string. Limits: type: object properties: min: type: string description: Minimum amount as a decimal string. max: type: string description: Maximum amount as a decimal string. Token: type: string description: Token identifier in the format "chain:address" pattern: ^[a-z]+:0x[a-fA-F0-9]+$ example: ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 PaymentGist: anyOf: - type: object required: - op - destination_address - destination_token properties: op: type: string enum: - buy destination_address: type: string destination_token: $ref: '#/components/schemas/Token' - type: 'null' description: Summary of a payment, or null. WithdrawFrom: anyOf: - type: object required: - withdraw_type - payment_id - withdraw_account properties: withdraw_type: type: string enum: - PAYMENT payment_id: type: string format: uuid withdraw_account: type: string enum: - INTENT - SPW - RDW - type: object required: - withdraw_type - rdw_address properties: withdraw_type: type: string enum: - EXTRA_RDW_BALANCE rdw_address: type: string - type: 'null' description: >- Where funds can be withdrawn from, or null if they cannot be withdrawn through the API. securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API_KEY ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.