> For the complete documentation index, see [llms.txt](https://developers.unigox.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.unigox.com/api-reference/models.md).

# Models

## The OperatingMoneyResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"OperatingMoneyResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","required":["operation_id","type","status"],"properties":{"operation_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["conversion","withdrawal"]},"status":{"type":"string","enum":["in_progress","submitted","failed","needs_review"],"description":"Submission outcome, not final blockchain delivery or settled balance."},"amount":{"type":"string"},"currency":{"type":"string"},"crypto_currency":{"type":"string"},"destination_address":{"type":"string","description":"Server-resolved owner UNIGOX deposit address; withdrawal only."},"message":{"type":"string"},"conversion":{"type":"object","description":"Bank-reported fiat_amount, crypto_amount, price, bank_fee and bank_status, where available."},"fee":{"type":"object","description":"Recorded Unigox fee (rate, amount and currency), where available."}}}}}}}}
```

## The WalletType object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WalletType":{"type":"string","enum":["partner_wallet","external_wallet"],"default":"partner_wallet","description":"Whose address holds this customer's funds, fixed at creation.\n- `partner_wallet` — your partner wallet holds them and you sign (default, and every customer created before this field existed).\n- `external_wallet` — the customer's own EVM address holds them and the customer signs. Requires non-custodial mode.\n"}}}}
```

## The CustomerWalletSummary object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CustomerWalletSummary":{"type":"object","nullable":true,"required":["address","status"],"description":"Present for `external_wallet` customers, `null` for `partner_wallet` ones.","properties":{"address":{"type":"string","nullable":true,"description":"The linked address in lower case, `null` until linked"},"status":{"type":"string","enum":["unlinked","linked"]}}}}}}
```

## The WalletChallenge object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WalletChallenge":{"type":"object","properties":{"message":{"type":"string","description":"EIP-4361 message to sign with `personal_sign`, unchanged"},"nonce":{"type":"string"},"expires_at":{"type":"string","format":"date-time"}}}}}}
```

## The CustomerWallet object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CustomerWallet":{"type":"object","required":["address","status","linked_at","chain_id","balances"],"properties":{"address":{"type":"string","nullable":true,"description":"The linked address in lower case"},"status":{"type":"string","enum":["unlinked","linked"]},"linked_at":{"type":"string","format":"date-time","nullable":true},"chain_id":{"type":"string","description":"Chain where the balance is held (XAI)"},"balances":{"type":"array","description":"Balance at the linked address on XAI for USDT and USDC. Empty until linked. On `POST …/wallet` also empty when the balance could not be read at that moment; `GET …/wallet` answers `502 BALANCE_UNAVAILABLE` instead. Amounts drop trailing zeros. Compare token addresses case-insensitively.","items":{"type":"object","properties":{"crypto_currency":{"type":"string"},"token_address":{"type":"string"},"amount_human":{"type":"string"},"decimals":{"type":"integer"}}}}}}}}}
```

## The WithdrawalQuote object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WithdrawalQuote":{"type":"object","properties":{"withdrawal_quote_id":{"type":"string","format":"uuid"},"expires_at":{"type":"string","format":"date-time"},"crypto_currency":{"type":"string"},"amount":{"type":"string","description":"Debited from the customer's XAI balance, with the token's full precision"},"to_amount":{"type":"string","description":"Estimated amount arriving, in the destination token's decimals"},"fee":{"type":"string","description":"Bridge and network cost, in `crypto_currency`; `\"0.000000\"` for `xai`"},"destination_chain":{"type":"string"},"destination_address":{"type":"string"},"forward_request":{"type":"object","description":"EIP-712 `ForwardRequest` to sign unchanged","properties":{"from":{"type":"string","description":"The customer's linked address"},"to":{"type":"string","description":"Token contract on XAI"},"value":{"type":"string"},"gas":{"type":"string","description":"Always `\"500000\"`"},"nonce":{"type":"string"},"deadline":{"type":"string","description":"Unix seconds; equals `expires_at`"},"data":{"type":"string","description":"ERC-20 `transfer` calldata"}}},"eip712_domain":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"chainId":{"type":"string"},"verifyingContract":{"type":"string","description":"The XAI forwarder"}}}}}}}}
```

## The CustomerWithdrawal object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CustomerWithdrawal":{"type":"object","properties":{"withdrawal_id":{"type":"string","format":"uuid","description":"Equals `withdrawal_quote_id`"},"withdrawal_quote_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["submitted","bridging","completed","failed","needs_review"],"description":"`submitted` — accepted for submission; `bridging` — executed on XAI, on its way to the destination chain;\n`completed` — arrived; `failed` — did not take effect on XAI (reverted, or not executed before the quote's\ndeadline), the funds are still on the customer's address; `needs_review` — could not be settled automatically (for example the bridge\nfailed after the funds left XAI, or still open after 24 hours), Unigox reconciles it.\n"},"crypto_currency":{"type":"string"},"amount":{"type":"string"},"to_amount":{"type":"string"},"destination_chain":{"type":"string"},"destination_address":{"type":"string"},"source_tx_hash":{"type":"string","nullable":true,"description":"Transaction on XAI"},"destination_tx_hash":{"type":"string","nullable":true,"description":"Transaction on the destination chain, once known"},"failure_reason":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerWalletLinkedData object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerWalletLinkedData":{"type":"object","required":["user_uuid","address","linked_at"],"description":"Data for wallet.linked, delivered in the signed partner webhook envelope.","properties":{"user_uuid":{"type":"string","format":"uuid","description":"Customer belonging to the receiving partner."},"address":{"type":"string","description":"Linked EVM address."},"linked_at":{"type":"string","format":"date-time","description":"UTC time at which the address was linked."}}}}}}
```

## The PartnerWalletDepositData object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerWalletDepositData":{"type":"object","required":["deposit_id","user_uuid","address","chain_id","crypto_currency","token_address","amount","amount_atomic","source_chain_id","source_tx_hash","tx_hash","credited_at"],"description":"Data for wallet.deposit.received in the signed partner webhook envelope. Identifies a\ncompleted bridge credit to the customer's linked XAI wallet. Does not include a memo,\nmemo-lock ID or collection address. Amounts are strings and describe the XAI credit.\n","properties":{"deposit_id":{"type":"string","description":"Stable credited-payment identifier. Treat as opaque; deduplicate within your partner account and environment."},"user_uuid":{"type":"string","format":"uuid","description":"Customer belonging to the receiving partner."},"address":{"type":"string","description":"Linked customer wallet credited on XAI."},"chain_id":{"type":"string","enum":["660279"],"description":"XAI settlement chain ID as a decimal string."},"crypto_currency":{"type":"string","description":"Credited token symbol."},"token_address":{"type":"string","description":"Credited token's contract address on XAI."},"amount":{"type":"string","description":"Credited amount in whole-token units as a decimal string."},"amount_atomic":{"type":"string","description":"Same credited amount in the token's smallest units, as an integer string."},"source_chain_id":{"type":"string","description":"Source chain ID as a decimal string; empty if absent from the payment record."},"source_tx_hash":{"type":"string","description":"Source transaction identifier; empty if absent from the payment record."},"tx_hash":{"type":"string","description":"XAI settlement transaction hash; empty if absent from the payment record."},"credited_at":{"type":"string","format":"date-time","description":"UTC time the XAI settlement transaction was mined."}}}}}}
```

## The PartnerDepositAddressMonitoring object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerDepositAddressMonitoring":{"type":"object","required":["watched","chains"],"description":"Monitoring result for this saved address. A false or missing confirmation means\nunconfirmed, not proof that monitoring is absent. Older responses without monitoring\nmetadata are returned as `watched: false` and `chains: []`.\n\nEVM and Tron report each network independently. Solana confirms address registration\nwith Helius. TON monitors saved addresses without an external registration step;\nits confirmation is not a live service-health check. Solana and TON return `chains: []`.\n","properties":{"watched":{"type":"boolean","description":"Whether monitoring is confirmed for all required networks of this address.\nFor EVM and Tron, use the per-network confirmations when selecting a payment network.\n"},"chains":{"type":"array","description":"Per-network confirmations for EVM and Tron. Missing networks are unconfirmed.","items":{"type":"object","required":["chainId","confirmed"],"properties":{"chainId":{"type":"integer","format":"int64","minimum":1,"description":"Numeric chain identifier of the network being checked."},"confirmed":{"type":"boolean","description":"Whether this address's monitoring is confirmed on that network."}}}}}}}}}
```

## The PartnerDepositAddress object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerDepositAddress":{"type":"object","required":["chain_type","address","monitoring"],"description":"One saved customer deposit address with its monitoring result.","properties":{"chain_type":{"type":"string","enum":["evm","svm","tvm","ton"],"description":"Address family; svm is Solana and tvm is Tron."},"address":{"type":"string","description":"The saved collection address. Allocation and subsequent lists retain this address."},"monitoring":{"$ref":"#/components/schemas/PartnerDepositAddressMonitoring"}}},"PartnerDepositAddressMonitoring":{"type":"object","required":["watched","chains"],"description":"Monitoring result for this saved address. A false or missing confirmation means\nunconfirmed, not proof that monitoring is absent. Older responses without monitoring\nmetadata are returned as `watched: false` and `chains: []`.\n\nEVM and Tron report each network independently. Solana confirms address registration\nwith Helius. TON monitors saved addresses without an external registration step;\nits confirmation is not a live service-health check. Solana and TON return `chains: []`.\n","properties":{"watched":{"type":"boolean","description":"Whether monitoring is confirmed for all required networks of this address.\nFor EVM and Tron, use the per-network confirmations when selecting a payment network.\n"},"chains":{"type":"array","description":"Per-network confirmations for EVM and Tron. Missing networks are unconfirmed.","items":{"type":"object","required":["chainId","confirmed"],"properties":{"chainId":{"type":"integer","format":"int64","minimum":1,"description":"Numeric chain identifier of the network being checked."},"confirmed":{"type":"boolean","description":"Whether this address's monitoring is confirmed on that network."}}}}}}}}}
```

## The PartnerDepositAddressesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerDepositAddressesResponse":{"type":"object","required":["success","data"],"description":"Successful address allocation or retrieval; readiness is separate from HTTP success.","properties":{"success":{"type":"boolean","enum":[true],"description":"The allocation or list request completed successfully."},"data":{"type":"object","required":["deposit_addresses"],"properties":{"deposit_addresses":{"type":"array","description":"Saved addresses for the requested customer; listing may return an empty array.","items":{"$ref":"#/components/schemas/PartnerDepositAddress"}}}}}},"PartnerDepositAddress":{"type":"object","required":["chain_type","address","monitoring"],"description":"One saved customer deposit address with its monitoring result.","properties":{"chain_type":{"type":"string","enum":["evm","svm","tvm","ton"],"description":"Address family; svm is Solana and tvm is Tron."},"address":{"type":"string","description":"The saved collection address. Allocation and subsequent lists retain this address."},"monitoring":{"$ref":"#/components/schemas/PartnerDepositAddressMonitoring"}}},"PartnerDepositAddressMonitoring":{"type":"object","required":["watched","chains"],"description":"Monitoring result for this saved address. A false or missing confirmation means\nunconfirmed, not proof that monitoring is absent. Older responses without monitoring\nmetadata are returned as `watched: false` and `chains: []`.\n\nEVM and Tron report each network independently. Solana confirms address registration\nwith Helius. TON monitors saved addresses without an external registration step;\nits confirmation is not a live service-health check. Solana and TON return `chains: []`.\n","properties":{"watched":{"type":"boolean","description":"Whether monitoring is confirmed for all required networks of this address.\nFor EVM and Tron, use the per-network confirmations when selecting a payment network.\n"},"chains":{"type":"array","description":"Per-network confirmations for EVM and Tron. Missing networks are unconfirmed.","items":{"type":"object","required":["chainId","confirmed"],"properties":{"chainId":{"type":"integer","format":"int64","minimum":1,"description":"Numeric chain identifier of the network being checked."},"confirmed":{"type":"boolean","description":"Whether this address's monitoring is confirmed on that network."}}}}}}}}}
```

## The PartnerDepositAddressPendingResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerDepositAddressPendingResponse":{"type":"object","required":["success","error","data"],"description":"Monitoring is unconfirmed; returned addresses remain saved and must not be reallocated.","properties":{"success":{"type":"boolean","enum":[false],"description":"Monitoring confirmation did not complete."},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["DEPOSIT_ADDRESS_NOT_WATCHED"],"description":"Allocation may have completed, but monitoring was not confirmed."},"message":{"type":"string","description":"Explanation of the pending monitoring result."}}},"data":{"type":"object","required":["deposit_addresses"],"properties":{"deposit_addresses":{"type":"array","description":"Saved addresses returned by the allocation. An empty array does not prove no allocation occurred.","items":{"$ref":"#/components/schemas/PartnerDepositAddress"}}}}}},"PartnerDepositAddress":{"type":"object","required":["chain_type","address","monitoring"],"description":"One saved customer deposit address with its monitoring result.","properties":{"chain_type":{"type":"string","enum":["evm","svm","tvm","ton"],"description":"Address family; svm is Solana and tvm is Tron."},"address":{"type":"string","description":"The saved collection address. Allocation and subsequent lists retain this address."},"monitoring":{"$ref":"#/components/schemas/PartnerDepositAddressMonitoring"}}},"PartnerDepositAddressMonitoring":{"type":"object","required":["watched","chains"],"description":"Monitoring result for this saved address. A false or missing confirmation means\nunconfirmed, not proof that monitoring is absent. Older responses without monitoring\nmetadata are returned as `watched: false` and `chains: []`.\n\nEVM and Tron report each network independently. Solana confirms address registration\nwith Helius. TON monitors saved addresses without an external registration step;\nits confirmation is not a live service-health check. Solana and TON return `chains: []`.\n","properties":{"watched":{"type":"boolean","description":"Whether monitoring is confirmed for all required networks of this address.\nFor EVM and Tron, use the per-network confirmations when selecting a payment network.\n"},"chains":{"type":"array","description":"Per-network confirmations for EVM and Tron. Missing networks are unconfirmed.","items":{"type":"object","required":["chainId","confirmed"],"properties":{"chainId":{"type":"integer","format":"int64","minimum":1,"description":"Numeric chain identifier of the network being checked."},"confirmed":{"type":"boolean","description":"Whether this address's monitoring is confirmed on that network."}}}}}}}}}
```

## The KycDocumentType object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"KycDocumentType":{"type":"string","description":"Complete set of document types accepted by the partner KYC upload endpoint. `document_type` only selects the upload slot (front/back/selfie); it is not a document-category and does not set the country — our verification system detects the document type from the image, and the country comes from the customer's KYC profile. Values named after a country (`ghana_card`, `ghana_ssnit_card`, `kenya_alien_card`, `green_book`, `colombia_ppt`) are country-specific hints; all others (`passport`, `national_id`, `driver_license`, `voter_id`, `resident_card`, `id_card`, `tax_id`, `identity_front`/`identity_back`, `selfie`) are general — any country. Nigeria's NIN is submitted as `national_id`.","enum":["identity_front","identity_back","selfie","passport","passport_front","national_id","national_id_front","national_id_back","driver_license","driver_license_front","driver_license_back","voter_id","voter_id_front","voter_id_back","resident_card","resident_card_front","resident_card_back","id_card","id_card_front","id_card_back","ghana_card","ghana_card_front","ghana_card_back","ghana_ssnit_card","ghana_ssnit_card_front","ghana_ssnit_card_back","kenya_alien_card","kenya_alien_card_front","kenya_alien_card_back","green_book","green_book_front","green_book_back","tax_id","tax_id_front","tax_id_back","colombia_ppt","colombia_ppt_front","colombia_ppt_back"]}}}}
```

## The APIResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["error_key"],"properties":{"error_key":{"type":"string","description":"Standardized error key for client error handling"}}}}}}}}
```

## The CryptoCurrencyCapability object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CryptoCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Cryptocurrency code. Unigox settles in stablecoins only — today USDC, USDT and USDT0."},"name":{"type":"string","description":"Cryptocurrency name"},"contract":{"type":"string","description":"Token contract address on this blockchain. Within `/supported/blockchains` this is always the\naddress on the enclosing chain. Within `/supported/crypto-currencies`, where one entry\naggregates every chain, it is the address on the FIRST chain listed in `blockchains` — use\n`/supported/blockchains` when you need a specific chain's address.\n"},"decimals":{"type":"integer","format":"int64","description":"Token decimals (number of decimal places)"},"blockchains":{"type":"array","items":{"type":"string"},"description":"Blockchain slugs this token is available on. Slugs are the same values returned in\n`BlockchainCapability.slug` — note they are fully qualified (`ethereum-mainnet`,\n`base-mainnet`, `arbitrum-one`), not bare chain names.\n"}}}}}}
```

## The CryptoCurrenciesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CryptoCurrenciesResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CryptoCurrencyCapability"}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"CryptoCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Cryptocurrency code. Unigox settles in stablecoins only — today USDC, USDT and USDT0."},"name":{"type":"string","description":"Cryptocurrency name"},"contract":{"type":"string","description":"Token contract address on this blockchain. Within `/supported/blockchains` this is always the\naddress on the enclosing chain. Within `/supported/crypto-currencies`, where one entry\naggregates every chain, it is the address on the FIRST chain listed in `blockchains` — use\n`/supported/blockchains` when you need a specific chain's address.\n"},"decimals":{"type":"integer","format":"int64","description":"Token decimals (number of decimal places)"},"blockchains":{"type":"array","items":{"type":"string"},"description":"Blockchain slugs this token is available on. Slugs are the same values returned in\n`BlockchainCapability.slug` — note they are fully qualified (`ethereum-mainnet`,\n`base-mainnet`, `arbitrum-one`), not bare chain names.\n"}}}}}}
```

## The BlockchainCapability object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BlockchainCapability":{"type":"object","properties":{"name":{"type":"string","description":"Blockchain name"},"slug":{"type":"string","description":"Blockchain slug identifier. Match on this, not on `name`."},"ticker":{"type":"string","description":"Blockchain ticker symbol. Empty for chains that have no ticker mapping yet, so treat it as\noptional and key your own logic off `slug`.\n"},"crypto_currencies":{"type":"array","items":{"$ref":"#/components/schemas/CryptoCurrencyCapability"},"description":"List of cryptocurrencies supported on this blockchain"}}},"CryptoCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Cryptocurrency code. Unigox settles in stablecoins only — today USDC, USDT and USDT0."},"name":{"type":"string","description":"Cryptocurrency name"},"contract":{"type":"string","description":"Token contract address on this blockchain. Within `/supported/blockchains` this is always the\naddress on the enclosing chain. Within `/supported/crypto-currencies`, where one entry\naggregates every chain, it is the address on the FIRST chain listed in `blockchains` — use\n`/supported/blockchains` when you need a specific chain's address.\n"},"decimals":{"type":"integer","format":"int64","description":"Token decimals (number of decimal places)"},"blockchains":{"type":"array","items":{"type":"string"},"description":"Blockchain slugs this token is available on. Slugs are the same values returned in\n`BlockchainCapability.slug` — note they are fully qualified (`ethereum-mainnet`,\n`base-mainnet`, `arbitrum-one`), not bare chain names.\n"}}}}}}
```

## The BlockchainsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BlockchainsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BlockchainCapability"}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"BlockchainCapability":{"type":"object","properties":{"name":{"type":"string","description":"Blockchain name"},"slug":{"type":"string","description":"Blockchain slug identifier. Match on this, not on `name`."},"ticker":{"type":"string","description":"Blockchain ticker symbol. Empty for chains that have no ticker mapping yet, so treat it as\noptional and key your own logic off `slug`.\n"},"crypto_currencies":{"type":"array","items":{"$ref":"#/components/schemas/CryptoCurrencyCapability"},"description":"List of cryptocurrencies supported on this blockchain"}}},"CryptoCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Cryptocurrency code. Unigox settles in stablecoins only — today USDC, USDT and USDT0."},"name":{"type":"string","description":"Cryptocurrency name"},"contract":{"type":"string","description":"Token contract address on this blockchain. Within `/supported/blockchains` this is always the\naddress on the enclosing chain. Within `/supported/crypto-currencies`, where one entry\naggregates every chain, it is the address on the FIRST chain listed in `blockchains` — use\n`/supported/blockchains` when you need a specific chain's address.\n"},"decimals":{"type":"integer","format":"int64","description":"Token decimals (number of decimal places)"},"blockchains":{"type":"array","items":{"type":"string"},"description":"Blockchain slugs this token is available on. Slugs are the same values returned in\n`BlockchainCapability.slug` — note they are fully qualified (`ethereum-mainnet`,\n`base-mainnet`, `arbitrum-one`), not bare chain names.\n"}}}}}}
```

## The FiatCurrencyCapability object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Fiat currency code (ISO 4217)"},"name":{"type":"string","description":"Fiat currency name"},"institution_id":{"type":"array","items":{"type":"string"},"description":"List of payment method slugs that support this currency (retrieved from active payment method options)"},"countries":{"type":"array","items":{"type":"string"},"description":"List of ISO 2-letter country codes where this currency is supported (retrieved from active payment method options)"},"onramp":{"type":"boolean","description":"Whether onramp (fiat to crypto) is supported. Currently set to true if there are any active payment method options for this currency.\nThis will be refined in future updates based on trade types and explicit direction configuration.\n"},"offramp":{"type":"boolean","description":"Whether offramp (crypto to fiat) is supported. Currently set to true if there are any active payment method options for this currency.\nThis will be refined in future updates based on trade types and explicit direction configuration.\n"}}}}}}
```

## The FiatCurrenciesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatCurrenciesResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FiatCurrencyCapability"}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"FiatCurrencyCapability":{"type":"object","properties":{"code":{"type":"string","description":"Fiat currency code (ISO 4217)"},"name":{"type":"string","description":"Fiat currency name"},"institution_id":{"type":"array","items":{"type":"string"},"description":"List of payment method slugs that support this currency (retrieved from active payment method options)"},"countries":{"type":"array","items":{"type":"string"},"description":"List of ISO 2-letter country codes where this currency is supported (retrieved from active payment method options)"},"onramp":{"type":"boolean","description":"Whether onramp (fiat to crypto) is supported. Currently set to true if there are any active payment method options for this currency.\nThis will be refined in future updates based on trade types and explicit direction configuration.\n"},"offramp":{"type":"boolean","description":"Whether offramp (crypto to fiat) is supported. Currently set to true if there are any active payment method options for this currency.\nThis will be refined in future updates based on trade types and explicit direction configuration.\n"}}}}}}
```

## The CorridorRateQuote object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CorridorRateQuote":{"type":"object","description":"One partner-type variant of a corridor rate (P2P or Licensed).\n","properties":{"rate":{"type":"number","format":"double","nullable":true,"description":"All-in fiat-per-USDT rate (platform fee already applied)."},"min_notional_fiat":{"type":"number","format":"double","nullable":true,"description":"Smallest amount accepted by any active offer in this variant, in the corridor's local currency. Set only when it exceeds the reference notional in dollar terms — i.e. the customer would need to size up to use this variant."}}}}}}
```

## The CorridorDirectionInfo object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CorridorDirectionInfo":{"type":"object","description":"Per-direction info for one fiat corridor. The whole object is\nomitted when no active offer exists in that direction. Either\n`p2p` or `licensed` (or both) will be present.\n","properties":{"supported":{"type":"boolean","description":"Always `true` when the object is present (the object is omitted otherwise). Reserved for future states where a corridor may be configured but temporarily without liquidity."},"p2p":{"$ref":"#/components/schemas/CorridorRateQuote"},"licensed":{"$ref":"#/components/schemas/CorridorRateQuote"}}},"CorridorRateQuote":{"type":"object","description":"One partner-type variant of a corridor rate (P2P or Licensed).\n","properties":{"rate":{"type":"number","format":"double","nullable":true,"description":"All-in fiat-per-USDT rate (platform fee already applied)."},"min_notional_fiat":{"type":"number","format":"double","nullable":true,"description":"Smallest amount accepted by any active offer in this variant, in the corridor's local currency. Set only when it exceeds the reference notional in dollar terms — i.e. the customer would need to size up to use this variant."}}}}}}
```

## The Corridor object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"Corridor":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"mid_market_rate":{"type":"number","format":"double","nullable":true,"description":"Open Exchange Rates reference rate (fiat per USDT) for this currency. Same value applies to both directions."},"mid_market_updated_at":{"type":"string","format":"date-time","nullable":true},"unigox_fee_pct":{"type":"number","format":"double","nullable":true,"description":"Cheapest active Unigox platform fee for this corridor, in percent. Already baked into every `rate` below."},"onramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"},"offramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"}}},"CorridorDirectionInfo":{"type":"object","description":"Per-direction info for one fiat corridor. The whole object is\nomitted when no active offer exists in that direction. Either\n`p2p` or `licensed` (or both) will be present.\n","properties":{"supported":{"type":"boolean","description":"Always `true` when the object is present (the object is omitted otherwise). Reserved for future states where a corridor may be configured but temporarily without liquidity."},"p2p":{"$ref":"#/components/schemas/CorridorRateQuote"},"licensed":{"$ref":"#/components/schemas/CorridorRateQuote"}}},"CorridorRateQuote":{"type":"object","description":"One partner-type variant of a corridor rate (P2P or Licensed).\n","properties":{"rate":{"type":"number","format":"double","nullable":true,"description":"All-in fiat-per-USDT rate (platform fee already applied)."},"min_notional_fiat":{"type":"number","format":"double","nullable":true,"description":"Smallest amount accepted by any active offer in this variant, in the corridor's local currency. Set only when it exceeds the reference notional in dollar terms — i.e. the customer would need to size up to use this variant."}}}}}}
```

## The SupportedCorridorsPayload object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SupportedCorridorsPayload":{"type":"object","properties":{"notional_usdt":{"type":"number","format":"double"},"generated_at":{"type":"string","format":"date-time"},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/Corridor"}}}},"Corridor":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"mid_market_rate":{"type":"number","format":"double","nullable":true,"description":"Open Exchange Rates reference rate (fiat per USDT) for this currency. Same value applies to both directions."},"mid_market_updated_at":{"type":"string","format":"date-time","nullable":true},"unigox_fee_pct":{"type":"number","format":"double","nullable":true,"description":"Cheapest active Unigox platform fee for this corridor, in percent. Already baked into every `rate` below."},"onramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"},"offramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"}}},"CorridorDirectionInfo":{"type":"object","description":"Per-direction info for one fiat corridor. The whole object is\nomitted when no active offer exists in that direction. Either\n`p2p` or `licensed` (or both) will be present.\n","properties":{"supported":{"type":"boolean","description":"Always `true` when the object is present (the object is omitted otherwise). Reserved for future states where a corridor may be configured but temporarily without liquidity."},"p2p":{"$ref":"#/components/schemas/CorridorRateQuote"},"licensed":{"$ref":"#/components/schemas/CorridorRateQuote"}}},"CorridorRateQuote":{"type":"object","description":"One partner-type variant of a corridor rate (P2P or Licensed).\n","properties":{"rate":{"type":"number","format":"double","nullable":true,"description":"All-in fiat-per-USDT rate (platform fee already applied)."},"min_notional_fiat":{"type":"number","format":"double","nullable":true,"description":"Smallest amount accepted by any active offer in this variant, in the corridor's local currency. Set only when it exceeds the reference notional in dollar terms — i.e. the customer would need to size up to use this variant."}}}}}}
```

## The SupportedCorridorsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SupportedCorridorsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SupportedCorridorsPayload"}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"SupportedCorridorsPayload":{"type":"object","properties":{"notional_usdt":{"type":"number","format":"double"},"generated_at":{"type":"string","format":"date-time"},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/Corridor"}}}},"Corridor":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"},"mid_market_rate":{"type":"number","format":"double","nullable":true,"description":"Open Exchange Rates reference rate (fiat per USDT) for this currency. Same value applies to both directions."},"mid_market_updated_at":{"type":"string","format":"date-time","nullable":true},"unigox_fee_pct":{"type":"number","format":"double","nullable":true,"description":"Cheapest active Unigox platform fee for this corridor, in percent. Already baked into every `rate` below."},"onramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"},"offramp":{"$ref":"#/components/schemas/CorridorDirectionInfo"}}},"CorridorDirectionInfo":{"type":"object","description":"Per-direction info for one fiat corridor. The whole object is\nomitted when no active offer exists in that direction. Either\n`p2p` or `licensed` (or both) will be present.\n","properties":{"supported":{"type":"boolean","description":"Always `true` when the object is present (the object is omitted otherwise). Reserved for future states where a corridor may be configured but temporarily without liquidity."},"p2p":{"$ref":"#/components/schemas/CorridorRateQuote"},"licensed":{"$ref":"#/components/schemas/CorridorRateQuote"}}},"CorridorRateQuote":{"type":"object","description":"One partner-type variant of a corridor rate (P2P or Licensed).\n","properties":{"rate":{"type":"number","format":"double","nullable":true,"description":"All-in fiat-per-USDT rate (platform fee already applied)."},"min_notional_fiat":{"type":"number","format":"double","nullable":true,"description":"Smallest amount accepted by any active offer in this variant, in the corridor's local currency. Set only when it exceeds the reference notional in dollar terms — i.e. the customer would need to size up to use this variant."}}}}}}
```

## The PaymentField object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PaymentField":{"type":"object","properties":{"key":{"type":"string","description":"Field identifier/key"},"label":{"type":"string","description":"Human-readable field label"},"type":{"type":"string","description":"Field input type (text, number, select, etc.)"},"required":{"type":"boolean","description":"Whether this field is required"},"pattern":{"type":"string","description":"Regex pattern for validation (optional)"},"placeholder":{"type":"string","description":"Placeholder text for input (optional)"},"lookup":{"type":"boolean","description":"Whether field can be used for lookup (optional)"},"options":{"type":"array","description":"Options for select fields (optional)","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}}}}}
```

## The Rails object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"Rails":{"type":"object","properties":{"slug":{"type":"string","description":"Payment rail slug identifier"},"name":{"type":"string","description":"Payment rail name"},"institution_required":{"type":"boolean","description":"Whether institution (bank) selection is required by the rail itself. In the current partner API, omission of `institution_id` is explicitly supported for `iban-sepa`, `nip-nigeria`, and `imps-neft-india` (which returns `false` and is routed by `ifsc_code` instead)."},"institution_lookup_key":{"type":"string","nullable":true,"description":"Lookup key for institution search, e.g., ifsc or sort_code"},"currencies":{"type":"array","items":{"type":"string"},"description":"List of supported fiat currency codes"},"settlement":{"type":"object","nullable":true,"description":"Settlement information","properties":{"speed":{"type":"string","enum":["INSTANT","SAME_DAY","NEXT_DAY","STANDARD"],"description":"Settlement speed"},"typical_minutes":{"type":"integer","description":"Typical settlement time in minutes"},"note":{"type":"string","nullable":true,"description":"Optional note about settlement"}}},"limits":{"type":"object","nullable":true,"description":"Transaction limits","properties":{"min_amount":{"type":"number","nullable":true,"description":"Minimum transaction amount"},"max_amount":{"type":"number","nullable":true,"description":"Maximum transaction amount (null = no limit)"},"max_per_transaction":{"type":"number","nullable":true,"description":"Maximum per transaction (null = no limit)"}}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PaymentField"},"description":"Required fields for payment details input. For a multi-format rail (see `formats`) this is a single best-effort field set kept for backward compatibility; the authoritative, institution-specific fields are in `formats`.\n"},"formats":{"type":"array","description":"Present only when a rail accepts more than one field-set (e.g. GHIPSS and EthSwitch accept a mobile-money format keyed on `phone_number` and a bank format keyed on `account_number`). The required field set depends on the chosen institution's type, so pick an institution from `/api/v1/supported/institutions`, match its `institution_type` to a format via `institution_types`, and submit that format's `fields`.\n","items":{"$ref":"#/components/schemas/RailFormat"}}}},"PaymentField":{"type":"object","properties":{"key":{"type":"string","description":"Field identifier/key"},"label":{"type":"string","description":"Human-readable field label"},"type":{"type":"string","description":"Field input type (text, number, select, etc.)"},"required":{"type":"boolean","description":"Whether this field is required"},"pattern":{"type":"string","description":"Regex pattern for validation (optional)"},"placeholder":{"type":"string","description":"Placeholder text for input (optional)"},"lookup":{"type":"boolean","description":"Whether field can be used for lookup (optional)"},"options":{"type":"array","description":"Options for select fields (optional)","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}},"RailFormat":{"type":"object","properties":{"id":{"type":"string","description":"Format identifier"},"name":{"type":"string","description":"Human-readable format name"},"institution_types":{"type":"array","items":{"type":"string"},"description":"Institution types this format applies to. Match the chosen institution's type to select the format."},"has_liquidity":{"type":"boolean","description":"Whether a vendor/provider can currently settle this format in the corridor. Computed only when the query names both `country` and `currency`; omitted otherwise, and when liquidity could not be determined (treat as unknown, not \"no\"). This reflects configured liquidity; live availability is confirmed at quote time.\n"},"beneficiary_type":{"type":"string","enum":["individual","business"],"description":"Present only for rails that distinguish an individual vs a business beneficiary. A `business` format shares its individual sibling's `institution_types` but collects a company's details. To use it, submit this format's `fields` AND set `\"beneficiary_type\": \"business\"` inside the create-payment-details `details` object. Omitting `\"beneficiary_type\"` in the request details defaults to the individual variant. A recipient destination is different: there the recipient's `recipient_kind` selects the format and any `beneficiary_type` you send is replaced by it.\n"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PaymentField"},"description":"Required fields for payment details input when paying out to an institution of this format's type."}}}}}}
```

## The RailFormat object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"RailFormat":{"type":"object","properties":{"id":{"type":"string","description":"Format identifier"},"name":{"type":"string","description":"Human-readable format name"},"institution_types":{"type":"array","items":{"type":"string"},"description":"Institution types this format applies to. Match the chosen institution's type to select the format."},"has_liquidity":{"type":"boolean","description":"Whether a vendor/provider can currently settle this format in the corridor. Computed only when the query names both `country` and `currency`; omitted otherwise, and when liquidity could not be determined (treat as unknown, not \"no\"). This reflects configured liquidity; live availability is confirmed at quote time.\n"},"beneficiary_type":{"type":"string","enum":["individual","business"],"description":"Present only for rails that distinguish an individual vs a business beneficiary. A `business` format shares its individual sibling's `institution_types` but collects a company's details. To use it, submit this format's `fields` AND set `\"beneficiary_type\": \"business\"` inside the create-payment-details `details` object. Omitting `\"beneficiary_type\"` in the request details defaults to the individual variant. A recipient destination is different: there the recipient's `recipient_kind` selects the format and any `beneficiary_type` you send is replaced by it.\n"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PaymentField"},"description":"Required fields for payment details input when paying out to an institution of this format's type."}}},"PaymentField":{"type":"object","properties":{"key":{"type":"string","description":"Field identifier/key"},"label":{"type":"string","description":"Human-readable field label"},"type":{"type":"string","description":"Field input type (text, number, select, etc.)"},"required":{"type":"boolean","description":"Whether this field is required"},"pattern":{"type":"string","description":"Regex pattern for validation (optional)"},"placeholder":{"type":"string","description":"Placeholder text for input (optional)"},"lookup":{"type":"boolean","description":"Whether field can be used for lookup (optional)"},"options":{"type":"array","description":"Options for select fields (optional)","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}}}}}
```

## The PaymentRailsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PaymentRailsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","required":["country","direction","rails"],"properties":{"country":{"type":"string","description":"Country code used in the query"},"currency":{"type":"string","description":"Currency code (from query parameter or first rail)"},"direction":{"type":"string","enum":["onramp","offramp"],"description":"Transaction direction"},"rails":{"type":"array","items":{"$ref":"#/components/schemas/Rails"},"description":"List of available payment rails"},"links":{"type":"object","additionalProperties":{"type":"string"},"description":"Related API endpoints"}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"Rails":{"type":"object","properties":{"slug":{"type":"string","description":"Payment rail slug identifier"},"name":{"type":"string","description":"Payment rail name"},"institution_required":{"type":"boolean","description":"Whether institution (bank) selection is required by the rail itself. In the current partner API, omission of `institution_id` is explicitly supported for `iban-sepa`, `nip-nigeria`, and `imps-neft-india` (which returns `false` and is routed by `ifsc_code` instead)."},"institution_lookup_key":{"type":"string","nullable":true,"description":"Lookup key for institution search, e.g., ifsc or sort_code"},"currencies":{"type":"array","items":{"type":"string"},"description":"List of supported fiat currency codes"},"settlement":{"type":"object","nullable":true,"description":"Settlement information","properties":{"speed":{"type":"string","enum":["INSTANT","SAME_DAY","NEXT_DAY","STANDARD"],"description":"Settlement speed"},"typical_minutes":{"type":"integer","description":"Typical settlement time in minutes"},"note":{"type":"string","nullable":true,"description":"Optional note about settlement"}}},"limits":{"type":"object","nullable":true,"description":"Transaction limits","properties":{"min_amount":{"type":"number","nullable":true,"description":"Minimum transaction amount"},"max_amount":{"type":"number","nullable":true,"description":"Maximum transaction amount (null = no limit)"},"max_per_transaction":{"type":"number","nullable":true,"description":"Maximum per transaction (null = no limit)"}}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PaymentField"},"description":"Required fields for payment details input. For a multi-format rail (see `formats`) this is a single best-effort field set kept for backward compatibility; the authoritative, institution-specific fields are in `formats`.\n"},"formats":{"type":"array","description":"Present only when a rail accepts more than one field-set (e.g. GHIPSS and EthSwitch accept a mobile-money format keyed on `phone_number` and a bank format keyed on `account_number`). The required field set depends on the chosen institution's type, so pick an institution from `/api/v1/supported/institutions`, match its `institution_type` to a format via `institution_types`, and submit that format's `fields`.\n","items":{"$ref":"#/components/schemas/RailFormat"}}}},"PaymentField":{"type":"object","properties":{"key":{"type":"string","description":"Field identifier/key"},"label":{"type":"string","description":"Human-readable field label"},"type":{"type":"string","description":"Field input type (text, number, select, etc.)"},"required":{"type":"boolean","description":"Whether this field is required"},"pattern":{"type":"string","description":"Regex pattern for validation (optional)"},"placeholder":{"type":"string","description":"Placeholder text for input (optional)"},"lookup":{"type":"boolean","description":"Whether field can be used for lookup (optional)"},"options":{"type":"array","description":"Options for select fields (optional)","items":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}}}}}},"RailFormat":{"type":"object","properties":{"id":{"type":"string","description":"Format identifier"},"name":{"type":"string","description":"Human-readable format name"},"institution_types":{"type":"array","items":{"type":"string"},"description":"Institution types this format applies to. Match the chosen institution's type to select the format."},"has_liquidity":{"type":"boolean","description":"Whether a vendor/provider can currently settle this format in the corridor. Computed only when the query names both `country` and `currency`; omitted otherwise, and when liquidity could not be determined (treat as unknown, not \"no\"). This reflects configured liquidity; live availability is confirmed at quote time.\n"},"beneficiary_type":{"type":"string","enum":["individual","business"],"description":"Present only for rails that distinguish an individual vs a business beneficiary. A `business` format shares its individual sibling's `institution_types` but collects a company's details. To use it, submit this format's `fields` AND set `\"beneficiary_type\": \"business\"` inside the create-payment-details `details` object. Omitting `\"beneficiary_type\"` in the request details defaults to the individual variant. A recipient destination is different: there the recipient's `recipient_kind` selects the format and any `beneficiary_type` you send is replaced by it.\n"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PaymentField"},"description":"Required fields for payment details input when paying out to an institution of this format's type."}}}}}}
```

## The InstitutionBranch object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"InstitutionBranch":{"type":"object","nullable":true,"properties":{"code":{"type":"string","description":"Branch code (e.g., IFSC, sort code)"},"name":{"type":"string","description":"Branch name"},"address":{"type":"string","description":"Branch address"}}}}}}
```

## The Institution object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"Institution":{"type":"object","properties":{"id":{"type":"string","description":"Institution identifier (slug) — pass this as `institution_id` when creating payment details"},"payment_method_id":{"type":"integer","format":"int64","description":"Numeric payment method id. Retail clients submit this (with `payment_network_id`) when saving a payment detail or creating a trade. Omitted for the `imps-neft-india` directory, which has no `payment_methods` rows."},"payment_network_id":{"type":"integer","format":"int64","description":"Numeric id of the queried rail (the `rail` query parameter), submitted alongside `payment_method_id`. Omitted for the `imps-neft-india` directory."},"name":{"type":"string","description":"Institution name"},"type":{"type":"string","description":"Broad institution category (e.g., BANK, WALLET)"},"institution_type":{"type":"string","description":"Fine-grained institution type slug (e.g. `mobile-money`, `mobile-wallets`, `traditional-banks`, `digital-banks`). On a multi-format rail, match this to the rail's `formats[].institution_types` to select the right field set."},"code":{"type":"string","description":"Corridor-specific institution code: the 4-letter IFSC bank prefix for `imps-neft-india`, the NIBSS code for `nip-nigeria`, the reference BIC for `iban-sepa`, etc. Omitted when the institution has no code. For SEPA the BIC is a reference identifier and may not be unique per institution — do not rely on it as a routing BIC."},"branch":{"$ref":"#/components/schemas/InstitutionBranch"},"supported_rails":{"type":"array","items":{"type":"string"},"description":"List of payment rail slugs this institution supports"}}},"InstitutionBranch":{"type":"object","nullable":true,"properties":{"code":{"type":"string","description":"Branch code (e.g., IFSC, sort code)"},"name":{"type":"string","description":"Branch name"},"address":{"type":"string","description":"Branch address"}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items"},"limit":{"type":"integer","description":"Items per page"},"offset":{"type":"integer","description":"Current offset"}}}}}}
```

## The InstitutionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"InstitutionsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","required":["institutions","pagination"],"properties":{"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"Institution":{"type":"object","properties":{"id":{"type":"string","description":"Institution identifier (slug) — pass this as `institution_id` when creating payment details"},"payment_method_id":{"type":"integer","format":"int64","description":"Numeric payment method id. Retail clients submit this (with `payment_network_id`) when saving a payment detail or creating a trade. Omitted for the `imps-neft-india` directory, which has no `payment_methods` rows."},"payment_network_id":{"type":"integer","format":"int64","description":"Numeric id of the queried rail (the `rail` query parameter), submitted alongside `payment_method_id`. Omitted for the `imps-neft-india` directory."},"name":{"type":"string","description":"Institution name"},"type":{"type":"string","description":"Broad institution category (e.g., BANK, WALLET)"},"institution_type":{"type":"string","description":"Fine-grained institution type slug (e.g. `mobile-money`, `mobile-wallets`, `traditional-banks`, `digital-banks`). On a multi-format rail, match this to the rail's `formats[].institution_types` to select the right field set."},"code":{"type":"string","description":"Corridor-specific institution code: the 4-letter IFSC bank prefix for `imps-neft-india`, the NIBSS code for `nip-nigeria`, the reference BIC for `iban-sepa`, etc. Omitted when the institution has no code. For SEPA the BIC is a reference identifier and may not be unique per institution — do not rely on it as a routing BIC."},"branch":{"$ref":"#/components/schemas/InstitutionBranch"},"supported_rails":{"type":"array","items":{"type":"string"},"description":"List of payment rail slugs this institution supports"}}},"InstitutionBranch":{"type":"object","nullable":true,"properties":{"code":{"type":"string","description":"Branch code (e.g., IFSC, sort code)"},"name":{"type":"string","description":"Branch name"},"address":{"type":"string","description":"Branch address"}}},"Pagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items"},"limit":{"type":"integer","description":"Items per page"},"offset":{"type":"integer","description":"Current offset"}}}}}}
```

## The SupportedPair object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SupportedPair":{"type":"object","properties":{"crypto_currency_code":{"type":"string","description":"Cryptocurrency code (e.g., USDC, BTC)"},"fiat_currency_code":{"type":"string","description":"Fiat currency code (e.g., USD, EUR)"},"type":{"type":"string","enum":["BUY","SELL"],"description":"Trading pair type - BUY (fiat to crypto) or SELL (crypto to fiat)"}}}}}}
```

## The SupportedPairsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SupportedPairsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupportedPair"}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"SupportedPair":{"type":"object","properties":{"crypto_currency_code":{"type":"string","description":"Cryptocurrency code (e.g., USDC, BTC)"},"fiat_currency_code":{"type":"string","description":"Fiat currency code (e.g., USD, EUR)"},"type":{"type":"string","enum":["BUY","SELL"],"description":"Trading pair type - BUY (fiat to crypto) or SELL (crypto to fiat)"}}}}}}
```

## The CreateUserResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreateUserResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"user_uuid":{"type":"string","format":"uuid","description":"Public UUID of the user. **Use this value in every subsequent call** — it is the\n`{user_uuid}` in `/partner/users/{user_uuid}/…`.\n"},"id":{"type":"string","format":"uuid","description":"The same value as `user_uuid`, kept for integrations written before that name\nexisted. Either can be read; they never differ.\n"},"email":{"type":"string","format":"email"},"kyc_status":{"type":"string","enum":["NOT_INITIATED","IN_PROGRESS","UNDER_REVIEW","VERIFIED","VERIFICATION_REJECTED"]},"wallet_type":{"$ref":"#/components/schemas/WalletType"},"wallet":{"$ref":"#/components/schemas/CustomerWalletSummary"},"created_at":{"type":"string","format":"date-time"}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"WalletType":{"type":"string","enum":["partner_wallet","external_wallet"],"default":"partner_wallet","description":"Whose address holds this customer's funds, fixed at creation.\n- `partner_wallet` — your partner wallet holds them and you sign (default, and every customer created before this field existed).\n- `external_wallet` — the customer's own EVM address holds them and the customer signs. Requires non-custodial mode.\n"},"CustomerWalletSummary":{"type":"object","nullable":true,"required":["address","status"],"description":"Present for `external_wallet` customers, `null` for `partner_wallet` ones.","properties":{"address":{"type":"string","nullable":true,"description":"The linked address in lower case, `null` until linked"},"status":{"type":"string","enum":["unlinked","linked"]}}}}}}
```

## The GetUserResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"GetUserResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"user_uuid":{"type":"string","format":"uuid","description":"Public UUID of the user. Use this value in all subsequent API calls."},"email":{"type":"string","format":"email"},"wallet_type":{"$ref":"#/components/schemas/WalletType"},"wallet":{"$ref":"#/components/schemas/CustomerWalletSummary"},"created_at":{"type":"string","format":"date-time"},"kyc":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_INITIATED","IN_PROGRESS","UNDER_REVIEW","VERIFIED","VERIFICATION_REJECTED"],"description":"Current partner-facing KYC status. `UNDER_REVIEW` means the customer is under\nmanual compliance review — not yet cleared, and unlike `IN_PROGRESS` (automated,\nusually a couple of minutes) it can take up to 24 hours. The internal review\nstate name is never exposed.\n"},"kyc_method":{"type":"string","enum":["direct_data","external_token","handoff"],"description":"KYC submission method used"},"first_name":{"type":"string","description":"User's first name from KYC data"},"last_name":{"type":"string","description":"User's last name from KYC data"},"country_code":{"type":"string","description":"User's country code (ISO 2-letter) from KYC data"},"rejection_reasons":{"type":"array","description":"Reasons from this partner customer's rejected verification session. Empty when not rejected or no reason is available. Also included as data.rejection_reasons by the verification-status endpoint; legacy provider_messages is retained there.","items":{"type":"string"}},"rejection_reason":{"type":"string","nullable":true,"description":"Reason for KYC rejection (if status is VERIFICATION_REJECTED)"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp for KYC status"}}},"fiat_account_issuance":{"type":"object","description":"Whether a fiat account can be opened for this customer, and what the bank is still\nshort of if not. It lives here because there is no second identity to register for\nan account: the gaps are gaps in this customer's KYC record.\n","properties":{"ready":{"type":"boolean","description":"True when `POST /api/v1/partner/fiat-accounts` will be accepted for this customer."},"missing_fields":{"type":"array","items":{"type":"string"},"description":"The fields the bank needs that the KYC record does not have, in the names\n`PATCH /api/v1/partner/users/{user_uuid}/kyc` takes: `address`, `city`,\n`postal_code`, `dob`, `id_number`, `id_type`.\n"}}},"payment_profiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"rail":{"type":"string"},"currency":{"type":"string"},"institution_name":{"type":"string","nullable":true},"institution_id":{"type":"string","nullable":true,"description":"Institution identifier (our internal slug)"},"details":{"type":"object","additionalProperties":true}}}}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"WalletType":{"type":"string","enum":["partner_wallet","external_wallet"],"default":"partner_wallet","description":"Whose address holds this customer's funds, fixed at creation.\n- `partner_wallet` — your partner wallet holds them and you sign (default, and every customer created before this field existed).\n- `external_wallet` — the customer's own EVM address holds them and the customer signs. Requires non-custodial mode.\n"},"CustomerWalletSummary":{"type":"object","nullable":true,"required":["address","status"],"description":"Present for `external_wallet` customers, `null` for `partner_wallet` ones.","properties":{"address":{"type":"string","nullable":true,"description":"The linked address in lower case, `null` until linked"},"status":{"type":"string","enum":["unlinked","linked"]}}}}}}
```

## The KYCSubmitDirectData object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"KYCSubmitDirectData":{"type":"object","required":["method","data"],"properties":{"method":{"type":"string","enum":["direct_data"]},"data":{"type":"object","required":["pii"],"properties":{"pii":{"type":"object","required":["first_name","last_name","country_code"],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"country_code":{"type":"string"},"dob":{"type":"string","format":"date","description":"Date of birth (YYYY-MM-DD). Optional, but when provided it must be a real date in the past and indicate an age of at least 18. A future, malformed, or under-18 date is rejected with HTTP 400 (see error responses below)."},"middle_name":{"type":"string"},"phone_number":{"type":"string","description":"E.164 format"},"id_number":{"type":"string","description":"Government identity/registry number. Enables the **NIN/BVN + selfie** verification option: instead of uploading an ID-document image, the customer proves identity with this number plus a live selfie (no ID photo). AiPrise validates the number against the national registry (NIN->NIMC, BVN->NIBSS) and face-matches the selfie against the registry photo. After this submission, upload only a `selfie` (document_type=selfie) to the documents endpoint - verification starts automatically. Supported for the registry number types listed under `id_type`, in the countries those registries cover."},"id_type":{"type":"string","description":"Registry type for `id_number`. For the NIN/BVN + selfie option it must be one of the listed registry types (image-only IDs such as passport/driver licence are NOT accepted - those use the ID-image flow). An unsupported/missing value returns `400 { \"error_key\": \"invalid_identity_number_type\" }`.","enum":["NIN","NIN_SLIP","BVN","NATIONAL_ID","VOTER_ID","TAX_ID","KENYA_KRA_PIN"]},"address":{"type":"string","description":"Street address"},"city":{"type":"string","description":"City. Required for EUR/AUD/GBP offramp (auto-populates into payment details)."},"postal_code":{"type":"string"}}}}}}}}}}
```

## The KYCSubmitExternalToken object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"KYCSubmitExternalToken":{"type":"object","required":["method","data"],"properties":{"method":{"type":"string","enum":["external_token"]},"data":{"type":"object","required":["provider"],"description":"Provider-specific fields:\n- SumSub: requires `token` (SumSub share token)\n- Persona: requires `inquiry_id` (Persona inquiry ID, e.g. inq_xxx)\n","properties":{"provider":{"type":"string","enum":["sumsub","persona"],"description":"KYC provider name"},"token":{"type":"string","description":"SumSub share token (required when provider=sumsub)"},"inquiry_id":{"type":"string","description":"Persona inquiry ID (required when provider=persona). This is the inq_xxx identifier returned by Persona when the inquiry was created."}}}}}}}}
```

## The KYCSubmitHandoff object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"KYCSubmitHandoff":{"type":"object","required":["method","data"],"properties":{"method":{"type":"string","enum":["handoff"]},"data":{"type":"object","properties":{"pii":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"country_code":{"type":"string"}}}}}}}}}}
```

## The KYCSubmitResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"KYCSubmitResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"kyc_status":{"type":"string","enum":["NOT_INITIATED","IN_PROGRESS","UNDER_REVIEW","VERIFIED","VERIFICATION_REJECTED"],"description":"A submission may asynchronously move to `UNDER_REVIEW` (manual compliance review,\nup to 24 hours) via the status endpoint and the `user.kyc.updated` webhook — distinct\nfrom `IN_PROGRESS` (automated, usually a couple of minutes). Treat both as not cleared.\n"},"message":{"type":"string"},"verification_url":{"type":"string","format":"uri","nullable":true,"description":"Verification URL (only returned for handoff method)"}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}}}}}
```

## The VerificationStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"VerificationStatusResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_INITIATED","PENDING_DOCUMENTS","IN_PROGRESS","UNDER_REVIEW","VERIFIED","FAILED","VERIFICATION_REJECTED"],"description":"Current verification status.\n\n- `NOT_INITIATED` — no verification started\n- `PENDING_DOCUMENTS` — awaiting customer document submission\n- `IN_PROGRESS` — automated verification underway (usually a couple of minutes); treat as not cleared yet\n- `UNDER_REVIEW` — under manual compliance review; the customer is being reviewed by our team and is NOT yet cleared. Unlike `IN_PROGRESS` (automated, usually a couple of minutes), this can take up to 24 hours. Keep polling; treat as not cleared.\n- `VERIFIED` — approved\n- `FAILED` — terminal error\n- `VERIFICATION_REJECTED` — completed with rejection\n"},"verification_url":{"type":"string","format":"uri","nullable":true,"description":"Verification URL (for handoff method)"},"verification_seconds_left":{"type":"integer","nullable":true,"description":"Seconds remaining for verification session (if applicable)"},"rejection_reasons":{"type":"array","description":"Reasons for this customer's rejected verification, matching the KYC webhook. Empty for other statuses or when no reason is available.","items":{"type":"string"}},"provider_messages":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Status messages or rejection reasons"}}}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}}}}}
```

## The CreatePaymentDetailsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreatePaymentDetailsRequest":{"description":"Conditional request schema for partner payment details. `institution_id` may be omitted for `iban-sepa`, `nip-nigeria`, and `imps-neft-india`.","oneOf":[{"$ref":"#/components/schemas/CreatePaymentDetailsRequestInstitutionOptional"},{"$ref":"#/components/schemas/CreatePaymentDetailsRequestInstitutionRequired"}]},"CreatePaymentDetailsRequestInstitutionOptional":{"allOf":[{"$ref":"#/components/schemas/CreatePaymentDetailsRequestBase"},{"type":"object","properties":{"rail":{"type":"string","enum":["iban-sepa","nip-nigeria","imps-neft-india"],"description":"Payment rail identifier for rails that support omission of `institution_id`"},"institution_id":{"type":"string","description":"Optional for `iban-sepa`, `nip-nigeria`, and `imps-neft-india`.\nFor `iban-sepa`/`nip-nigeria`, if omitted the backend assigns the generic `other-bank` payment method automatically.\nFor `imps-neft-india` it is ignored entirely (resolves to the generic `imps-or-neft-transfer` method); the bank is taken from `details.bank_name` + `details.ifsc_code`.\n"}}}]},"CreatePaymentDetailsRequestBase":{"type":"object","required":["currency","rail","details"],"properties":{"currency":{"type":"string","description":"ISO 3-letter fiat currency code (e.g., INR, EUR, USD)"},"rail":{"type":"string","description":"Payment rail identifier (e.g., \"upi-india\", \"iban-sepa\", \"imps-neft-india\")"},"details":{"type":"object","description":"Payment details object with fields specific to the payment network (e.g., account_number, vpa, iban, full_name)","additionalProperties":true},"country_code":{"type":"string","description":"Optional ISO 2-letter country code"}}},"CreatePaymentDetailsRequestInstitutionRequired":{"allOf":[{"$ref":"#/components/schemas/CreatePaymentDetailsRequestBase"},{"type":"object","required":["institution_id"],"properties":{"rail":{"type":"string","description":"Payment rail identifier for rails that require institution selection","not":{"enum":["iban-sepa","nip-nigeria","imps-neft-india"]}},"institution_id":{"type":"string","description":"Institution (payment method) identifier - our internal slug (e.g., \"wise\", \"hdfc-bank\", \"revolut\", \"uala\", \"banco-santander-argentina\").\nRequired for all rails except `iban-sepa`, `nip-nigeria`, and `imps-neft-india`.\nIf omitted for any other rail, the API returns a validation error.\nFor rails with multiple formats (e.g., CVU/CBU), the format is automatically determined based on the payment method type of this institution.\n"}}}]}}}}
```

## The CreatePaymentDetailsRequestBase object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreatePaymentDetailsRequestBase":{"type":"object","required":["currency","rail","details"],"properties":{"currency":{"type":"string","description":"ISO 3-letter fiat currency code (e.g., INR, EUR, USD)"},"rail":{"type":"string","description":"Payment rail identifier (e.g., \"upi-india\", \"iban-sepa\", \"imps-neft-india\")"},"details":{"type":"object","description":"Payment details object with fields specific to the payment network (e.g., account_number, vpa, iban, full_name)","additionalProperties":true},"country_code":{"type":"string","description":"Optional ISO 2-letter country code"}}}}}}
```

## The CreatePaymentDetailsRequestInstitutionOptional object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreatePaymentDetailsRequestInstitutionOptional":{"allOf":[{"$ref":"#/components/schemas/CreatePaymentDetailsRequestBase"},{"type":"object","properties":{"rail":{"type":"string","enum":["iban-sepa","nip-nigeria","imps-neft-india"],"description":"Payment rail identifier for rails that support omission of `institution_id`"},"institution_id":{"type":"string","description":"Optional for `iban-sepa`, `nip-nigeria`, and `imps-neft-india`.\nFor `iban-sepa`/`nip-nigeria`, if omitted the backend assigns the generic `other-bank` payment method automatically.\nFor `imps-neft-india` it is ignored entirely (resolves to the generic `imps-or-neft-transfer` method); the bank is taken from `details.bank_name` + `details.ifsc_code`.\n"}}}]},"CreatePaymentDetailsRequestBase":{"type":"object","required":["currency","rail","details"],"properties":{"currency":{"type":"string","description":"ISO 3-letter fiat currency code (e.g., INR, EUR, USD)"},"rail":{"type":"string","description":"Payment rail identifier (e.g., \"upi-india\", \"iban-sepa\", \"imps-neft-india\")"},"details":{"type":"object","description":"Payment details object with fields specific to the payment network (e.g., account_number, vpa, iban, full_name)","additionalProperties":true},"country_code":{"type":"string","description":"Optional ISO 2-letter country code"}}}}}}
```

## The CreatePaymentDetailsRequestInstitutionRequired object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreatePaymentDetailsRequestInstitutionRequired":{"allOf":[{"$ref":"#/components/schemas/CreatePaymentDetailsRequestBase"},{"type":"object","required":["institution_id"],"properties":{"rail":{"type":"string","description":"Payment rail identifier for rails that require institution selection","not":{"enum":["iban-sepa","nip-nigeria","imps-neft-india"]}},"institution_id":{"type":"string","description":"Institution (payment method) identifier - our internal slug (e.g., \"wise\", \"hdfc-bank\", \"revolut\", \"uala\", \"banco-santander-argentina\").\nRequired for all rails except `iban-sepa`, `nip-nigeria`, and `imps-neft-india`.\nIf omitted for any other rail, the API returns a validation error.\nFor rails with multiple formats (e.g., CVU/CBU), the format is automatically determined based on the payment method type of this institution.\n"}}}]},"CreatePaymentDetailsRequestBase":{"type":"object","required":["currency","rail","details"],"properties":{"currency":{"type":"string","description":"ISO 3-letter fiat currency code (e.g., INR, EUR, USD)"},"rail":{"type":"string","description":"Payment rail identifier (e.g., \"upi-india\", \"iban-sepa\", \"imps-neft-india\")"},"details":{"type":"object","description":"Payment details object with fields specific to the payment network (e.g., account_number, vpa, iban, full_name)","additionalProperties":true},"country_code":{"type":"string","description":"Optional ISO 2-letter country code"}}}}}}
```

## The PaymentProfile object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PaymentProfile":{"type":"object","properties":{"payment_details_id":{"type":"string","description":"Payment details ID. Use this value in offramp/onramp quote requests."},"rail":{"type":"string","description":"Payment rail identifier"},"currency":{"type":"string","description":"Fiat currency code"},"institution_name":{"type":"string","nullable":true,"description":"Institution (bank) name if applicable"},"institution_id":{"type":"string","nullable":true,"description":"Institution identifier (our internal slug)"},"details":{"type":"object","description":"Payment details (account number, VPA, IBAN, etc.)","additionalProperties":true}}}}}}
```

## The CreatePaymentDetailsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"CreatePaymentDetailsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentProfile"}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"PaymentProfile":{"type":"object","properties":{"payment_details_id":{"type":"string","description":"Payment details ID. Use this value in offramp/onramp quote requests."},"rail":{"type":"string","description":"Payment rail identifier"},"currency":{"type":"string","description":"Fiat currency code"},"institution_name":{"type":"string","nullable":true,"description":"Institution (bank) name if applicable"},"institution_id":{"type":"string","nullable":true,"description":"Institution identifier (our internal slug)"},"details":{"type":"object","description":"Payment details (account number, VPA, IBAN, etc.)","additionalProperties":true}}}}}}
```

## The GetPaymentDetailResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"GetPaymentDetailResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentProfile"}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"PaymentProfile":{"type":"object","properties":{"payment_details_id":{"type":"string","description":"Payment details ID. Use this value in offramp/onramp quote requests."},"rail":{"type":"string","description":"Payment rail identifier"},"currency":{"type":"string","description":"Fiat currency code"},"institution_name":{"type":"string","nullable":true,"description":"Institution (bank) name if applicable"},"institution_id":{"type":"string","nullable":true,"description":"Institution identifier (our internal slug)"},"details":{"type":"object","description":"Payment details (account number, VPA, IBAN, etc.)","additionalProperties":true}}}}}}
```

## The GetPaymentDetailsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"GetPaymentDetailsResponse":{"allOf":[{"$ref":"#/components/schemas/APIResponse"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentProfile"},"description":"List of all payment profiles for the user"}}}]},"APIResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"description":"Response data (structure varies by endpoint) or error information if success is false"}}},"PaymentProfile":{"type":"object","properties":{"payment_details_id":{"type":"string","description":"Payment details ID. Use this value in offramp/onramp quote requests."},"rail":{"type":"string","description":"Payment rail identifier"},"currency":{"type":"string","description":"Fiat currency code"},"institution_name":{"type":"string","nullable":true,"description":"Institution (bank) name if applicable"},"institution_id":{"type":"string","nullable":true,"description":"Institution identifier (our internal slug)"},"details":{"type":"object","description":"Payment details (account number, VPA, IBAN, etc.)","additionalProperties":true}}}}}}
```

## The SlippageTolerance object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SlippageTolerance":{"type":"object","properties":{"type":{"type":"string","enum":["percent","amount","fiat"],"description":"Tolerance type:\n- `percent` — percentage of the quoted rate (e.g., 1.5 = 1.5%)\n- `amount` — absolute fiat amount (e.g., 50.00 = 50 NGN)\n- `fiat` — alias of `amount`\n"},"value":{"type":"number","format":"double","description":"Tolerance value (percentage or fiat amount depending on type)"}}}}}}
```

## The LiquidityPair object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"LiquidityPair":{"type":"object","required":["crypto_currency_code","fiat_currency_code","trade_type","min_amount","max_amount","min_amount_usd","max_amount_usd","payment_methods"],"properties":{"crypto_currency_code":{"type":"string","description":"Cryptocurrency code (e.g. USDC, BTC)"},"fiat_currency_code":{"type":"string","description":"Fiat currency code (ISO 4217)"},"trade_type":{"type":"string","enum":["BUY","SELL"],"description":"Partner-facing trade direction.\n`SELL` — partner sells crypto and receives fiat (off-ramp).\n`BUY` — partner buys crypto by sending fiat (on-ramp).\n"},"min_amount":{"type":"number","format":"double","description":"Minimum fiat amount accepted across all eligible offers, in the pair's native fiat currency"},"max_amount":{"type":"number","format":"double","description":"Maximum fiat amount accepted across all eligible offers, in the pair's native fiat currency"},"min_amount_usd":{"type":"number","format":"double","description":"Minimum fiat amount converted to USD"},"max_amount_usd":{"type":"number","format":"double","description":"Maximum fiat amount converted to USD"},"payment_methods":{"type":"array","items":{"type":"string"},"description":"Deduplicated, alphabetically sorted list of payment method slugs available for this pair"}}}}}}
```

## The PartnerPriceEstimateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerPriceEstimateRequest":{"type":"object","required":["crypto_currency","fiat_currency"],"oneOf":[{"required":["crypto_amount"]},{"required":["fiat_amount"]}],"properties":{"crypto_currency":{"type":"string","description":"Cryptocurrency code (e.g., USDT, USDC)"},"fiat_currency":{"type":"string","description":"Target fiat currency code (e.g., NGN, USD, EUR)"},"crypto_amount":{"type":"string","description":"Crypto amount to estimate from. Provide exactly one of crypto_amount or fiat_amount."},"fiat_amount":{"type":"string","description":"Fiat amount to estimate from. Provide exactly one of crypto_amount or fiat_amount."},"payment_method_slug":{"type":"string","description":"Optional payment method slug filter to narrow routing"},"payment_network_slug":{"type":"string","description":"Optional payment network slug filter to narrow routing"},"provider_scope":{"type":"string","description":"Optional provider scope filter; defaults to all","enum":["all","licensed_only","p2p_only"]},"country_code":{"type":"string","description":"Optional ISO country code (alpha-2) used for fee/routing context"},"partner_fee_pct":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"Optional per-order markup you charge your end user, applied on the same crypto base\nas the platform fee (non-compounding). Percent units: `1` means 1%. Omitting the field\nfrom this request payload — or sending `0` — means no markup; the markup cannot be\nnegative. Fiat-anchored offramp orders have no cap — the deposit grows to cover the\nmarkup. Every other case hits a formula domain bound, not a business cap: onramp\nrejects `partner_fee_pct >= 100` (the withheld or grossed-up fee would consume the\nentire buyer amount, leaving nothing delivered); crypto-anchored offramp rejects it\nwhen the fee would consume the entire pinned deposit.\n\nNote: you send this value as a JSON **string**, but it round-trips as a JSON **number**\nin `fee_breakdown.partner_fee_pct` and in the webhook `data.partner_fee_pct` field —\ndon't parse those as strings.\n\n**Rejection reference:**\n\n| Rejection | `error.code` | HTTP status |\n|---|---|---|\n| `partner_fee_pct` is non-numeric, negative, `NaN`, or `Inf` | `INVALID_REQUEST` | 400 |\n| Onramp: fee would consume the entire buyer amount (`partner_fee_pct >= 100`) | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: fee would consume the entire pinned deposit | `INVALID_REQUEST` | 400 |\n| Fiat-anchored offramp: the computed fee is not a finite amount | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: the carved fee-exclusive gross falls outside the matched offer's min/max | `NO_OFFERS_AVAILABLE` | 409 |\n","default":"0"},"recipient_payout":{"type":"boolean","default":false,"description":"Off-ramp estimate only; the on-ramp estimate ignores it. `true` prices only on the licensed partners a third-party (recipient) payout can be matched to, so the estimate describes a payout to a recipient. It can only narrow the offers priced; the estimate still reserves nothing."},"exclude_delayed_settlement":{"type":"boolean","default":false,"description":"Off-ramp estimate only; the on-ramp estimate ignores it. `true` leaves delayed settlement (T+1) offers out of the price, so when no instant offer covers the amount the estimate answers `409 NO_OFFERS_AVAILABLE`. It changes this estimate only, not what a quote or an order matches."},"recipient_id":{"type":"string","format":"uuid","description":"Off-ramp estimate only. With `recipient_destination_id`, prices a payout to that destination of your recipient: on its own payment method, rail and country, as the quote prices it, so a fee a licensed partner charges for that bank is included. Give both or neither; naming them implies `recipient_payout`. Needs your API key. Errors: `400 INVALID_REQUEST` when only one is given, an id is not a UUID, the destination's currency is not `fiat_currency`, or `payment_method_slug`, `payment_network_slug` or `country_code` differ from the destination's (omit them); `401 UNAUTHORIZED` without a key, or with one that does not authenticate (see the operation's authentication); `404 RECIPIENT_NOT_FOUND` when the recipient or the destination is not yours; `422 THIRD_PARTY_CONTEXT_INVALID` when the destination is not active. The estimate reads the destination and binds nothing."},"recipient_destination_id":{"type":"string","format":"uuid","description":"Off-ramp estimate only. The destination of `recipient_id` the payout would go to; see `recipient_id`."}}}}}}
```

## The ExactPaymentMethodMatchingOffer object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"ExactPaymentMethodMatchingOffer":{"type":"object","description":"One route in the same crypto/fiat/network context that is reachable **only** by exact payment-method matching — a counterparty on this exact method, rather than anyone on the network. Quote with `payment_method_slug` and `payment_network_slug` set to these values to reach it.","properties":{"payment_method_slug":{"type":"string"},"payment_method_name":{"type":"string"},"payment_network_slug":{"type":"string"},"payment_network_name":{"type":"string"},"country_code":{"type":"string","description":"Omitted when the route was resolved without a country scope."},"country_name":{"type":"string","description":"Omitted with `country_code`."}}}}}}
```

## The PartnerPriceEstimateResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerPriceEstimateResponse":{"type":"object","properties":{"rate":{"type":"string","description":"Indicative crypto-to-fiat exchange rate"},"crypto_amount":{"type":"string","description":"Estimated total crypto amount — the fee-exclusive gross: the user's amount plus the platform\nfee. Partner-fee-exclusive, except for a crypto-anchored onramp estimate (request declares\n`crypto_amount`): there the amount is sized up so the delivered amount stays exact after the\npartner fee is withheld, so this field includes the markup. A crypto-anchored offramp\nestimate carves both fees out of the pinned deposit instead, so this field and\n`fee_breakdown.platform_fee` both shrink relative to a no-markup request, even though the\nmarkup itself stays out of this field. Every other case is unaffected — the markup is\nreported separately in `fee_breakdown.partner_fee`.\n\nOn-ramp: the end user would receive `crypto_amount − fee_breakdown.platform_fee −\nfee_breakdown.partner_fee` for a fiat-anchored estimate, or exactly this `crypto_amount` for a\ncrypto-anchored estimate. Off-ramp: the amount you would actually fund at initiation is\n`crypto_amount + fee_breakdown.partner_fee`.\n"},"fiat_amount":{"type":"string","description":"Estimated fiat amount"},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"},"payment_method_slug":{"type":"string","description":"Matched payment method slug used for estimate"},"payment_network_slug":{"type":"string","description":"Matched payment network slug used for estimate"},"provider_scope":{"type":"string","description":"Applied provider scope"},"is_indicative":{"type":"boolean","description":"True when response is an estimate and not a reserving quote"},"matching_type":{"type":"string","enum":["network","exact_payment_method"],"description":"How the priced offer matched. `network` — standard payment-network matching. `exact_payment_method` — the offer only matches a counterparty on one of the listed exact payment methods. Omitted when no offer was matched."},"network_matching_available":{"type":"boolean","description":"`true` when `matching_type` is `network`. `false` means this price is reachable only through exact payment-method matching."},"exact_payment_method_matching_offers":{"type":"array","description":"Routes in the same context that only exact payment-method matching can reach — the alternatives to the one this estimate priced. Omitted when there are none. It also travels under `error.details` on a `409 NO_OFFERS_AVAILABLE`, which is where it matters most: the refusal names the routes that would have worked.","items":{"$ref":"#/components/schemas/ExactPaymentMethodMatchingOffer"}},"delayed_settlement":{"type":"boolean","description":"Whether pricing at this amount would currently open a **delayed settlement (T+1)** order. Always present. Indicative, like the numbers: the estimate reserves nothing and the quote matches again, so the class can change either way before the quote. Read the class off the quote (`false` there is binding); the order response is final once a licensed partner has accepted the order. Sent with your credentials, the estimate checks whether Unigox has enabled delayed settlement for you and, until it has, prices instant offers only, as your quotes match. Sent without credentials it does not check, and can report `true` for an amount your quote would refuse."},"settlement_hours":{"type":"integer","nullable":true,"description":"The expected payout window the order would get, counted from the release: the licensed partner's target for the bank payment, not a guaranteed deadline. Rounded to the nearest whole hour and never below `1`. `null` on an instant estimate."},"source_of_funds_required":{"type":"boolean","description":"Whether the order this price would open needs a source-of-funds review before its release: `true` when the price is on a delayed settlement (T+1) offer and the order's USD equivalent (the fiat amount at the current USD rate, falling back to the crypto amount at the current USD rate) is at or above `source_of_funds_threshold_usd`, or cannot be computed. Always present; `false` on an instant estimate and on every on-ramp estimate. Indicative like the rest of the estimate: the order's own `source_of_funds_required` decides."},"source_of_funds_threshold_usd":{"type":"number","description":"The source-of-funds threshold in force, in USD. Present only when `delayed_settlement` is `true`; absent on an instant estimate and on every on-ramp estimate."}}},"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}},"ExactPaymentMethodMatchingOffer":{"type":"object","description":"One route in the same crypto/fiat/network context that is reachable **only** by exact payment-method matching — a counterparty on this exact method, rather than anyone on the network. Quote with `payment_method_slug` and `payment_network_slug` set to these values to reach it.","properties":{"payment_method_slug":{"type":"string"},"payment_method_name":{"type":"string"},"payment_network_slug":{"type":"string"},"payment_network_name":{"type":"string"},"country_code":{"type":"string","description":"Omitted when the route was resolved without a country scope."},"country_name":{"type":"string","description":"Omitted with `country_code`."}}}}}}
```

## The PartnerRecipientDestinationInput object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientDestinationInput":{"type":"object","required":["country_code","currency","rail","institution_id","details"],"properties":{"country_code":{"type":"string","minLength":2,"maxLength":2},"currency":{"type":"string","minLength":3,"maxLength":3},"rail":{"type":"string"},"institution_id":{"type":"string","description":"Institution identifier returned by the supported-institutions endpoint. Required on every rail, including the wallet rails that report `institution_required: false`: send `alipay` on `alipay-wallet` and `wechat-pay` on `wechat-wallet`."},"details":{"type":"object","additionalProperties":true,"description":"Rail-specific fields validated using the selected payment network configuration: the `fields` of the format `/api/v1/supported/payment-rails` advertises for this institution's type. On a rail with a business format, the recipient's `recipient_kind` selects the individual or business format; `beneficiary_type` sent here is replaced by it."}}}}}}
```

## The PartnerCreateRecipientRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerCreateRecipientRequest":{"type":"object","required":["recipient_name","recipient_country"],"properties":{"recipient_kind":{"type":"string","enum":["individual","business"],"default":"individual"},"recipient_name":{"type":"string"},"recipient_native_name":{"type":"string"},"recipient_country":{"type":"string","minLength":2,"maxLength":2},"recipient_id_type":{"type":"string"},"recipient_id_number":{"type":"string","writeOnly":true},"recipient_business_registration_number":{"type":"string","writeOnly":true}}}}}}
```

## The PartnerUpdateRecipientRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerUpdateRecipientRequest":{"type":"object","minProperties":1,"properties":{"recipient_name":{"type":"string"},"recipient_native_name":{"type":"string"},"recipient_country":{"type":"string","minLength":2,"maxLength":2},"recipient_id_type":{"type":"string"},"recipient_id_number":{"type":"string","writeOnly":true},"recipient_business_registration_number":{"type":"string","writeOnly":true}}}}}}
```

## The PartnerRecipient object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipient":{"type":"object","required":["id","kind","recipient_name","recipient_country","lifecycle","version","screening_status","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["individual","business"]},"recipient_name":{"type":"string"},"recipient_native_name":{"type":"string","nullable":true},"recipient_country":{"type":"string"},"recipient_id_type":{"type":"string","nullable":true},"recipient_id_number":{"type":"string","nullable":true,"description":"Masked partner-visible identity value; full value is never returned."},"recipient_business_registration_number":{"type":"string","nullable":true,"description":"Masked when returned."},"lifecycle":{"type":"string","enum":["draft","active","archived"]},"version":{"type":"integer","minimum":1},"screening_status":{"type":"string","enum":["pending","cleared","hit","manual_review"]},"screened_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerRecipientDestination object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientDestination":{"type":"object","required":["id","recipient_id","payment_method_id","payment_network_id","country_code","currency","version","lifecycle","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"payment_method_id":{"type":"integer","format":"int64"},"payment_network_id":{"type":"integer","format":"int64"},"country_code":{"type":"string","minLength":2,"maxLength":2},"currency":{"type":"string"},"details":{"type":"object","additionalProperties":true,"description":"The rail's own fields, as submitted. On reads, values that identify an account or a person are masked to last-4 (`account_number`, `bank_account_number`, `iban`, `card_number`, `id_number`, `national_id`, `tax_id`, `mobile_number`, `phone_number`, `msisdn`); everything else — names, `bank_name`, `province`, `branch`, routing codes, `beneficiary_type` — is returned in full so destinations stay distinguishable."},"version":{"type":"integer","minimum":1},"lifecycle":{"type":"string","enum":["active","archived"]},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerRecipientContext object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientContext":{"type":"object","required":["sender_id","recipient_id","recipient_destination_id","sender_recipient_relationship","purpose_of_payment","screening_status"],"properties":{"sender_id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"recipient_destination_id":{"type":"string","format":"uuid"},"sender_recipient_relationship":{"type":"string"},"purpose_of_payment":{"type":"string"},"purpose_details":{"type":"string"},"screening_status":{"type":"string"}}}}}}
```

## The PartnerComplianceCase object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerComplianceCase":{"type":"object","required":["case_id","status","risk_decision","requires_review"],"description":"The compliance record for a third-party payout. In v1 the controls run BEFORE the order is\ncreated, so a payout that fails one is rejected with an error rather than returned as a held\norder — see the error codes in the Third-party payouts guide.\n","properties":{"case_id":{"type":"string","format":"uuid","description":"Identifier of the compliance record — the payout's `quote_id`, so a partner and a Unigox\noperator refer to the same record.\n"},"status":{"type":"string","enum":["authorized"],"description":"v1 emits `authorized`; a rejected payout returns an error instead."},"risk_decision":{"type":"string","enum":["allow"],"description":"v1 emits `allow`; a blocking decision surfaces as an error, not a status."},"requires_review":{"type":"boolean","description":"Always false in v1. Operator review happens Unigox-side over the same record."}}}}}}
```

## The PartnerRecipientResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientResponse":{"type":"object","required":["recipient"],"properties":{"recipient":{"$ref":"#/components/schemas/PartnerRecipient"},"recipient_destination":{"allOf":[{"$ref":"#/components/schemas/PartnerRecipientDestination"}],"nullable":true}}},"PartnerRecipient":{"type":"object","required":["id","kind","recipient_name","recipient_country","lifecycle","version","screening_status","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["individual","business"]},"recipient_name":{"type":"string"},"recipient_native_name":{"type":"string","nullable":true},"recipient_country":{"type":"string"},"recipient_id_type":{"type":"string","nullable":true},"recipient_id_number":{"type":"string","nullable":true,"description":"Masked partner-visible identity value; full value is never returned."},"recipient_business_registration_number":{"type":"string","nullable":true,"description":"Masked when returned."},"lifecycle":{"type":"string","enum":["draft","active","archived"]},"version":{"type":"integer","minimum":1},"screening_status":{"type":"string","enum":["pending","cleared","hit","manual_review"]},"screened_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"}}},"PartnerRecipientDestination":{"type":"object","required":["id","recipient_id","payment_method_id","payment_network_id","country_code","currency","version","lifecycle","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"payment_method_id":{"type":"integer","format":"int64"},"payment_network_id":{"type":"integer","format":"int64"},"country_code":{"type":"string","minLength":2,"maxLength":2},"currency":{"type":"string"},"details":{"type":"object","additionalProperties":true,"description":"The rail's own fields, as submitted. On reads, values that identify an account or a person are masked to last-4 (`account_number`, `bank_account_number`, `iban`, `card_number`, `id_number`, `national_id`, `tax_id`, `mobile_number`, `phone_number`, `msisdn`); everything else — names, `bank_name`, `province`, `branch`, routing codes, `beneficiary_type` — is returned in full so destinations stay distinguishable."},"version":{"type":"integer","minimum":1},"lifecycle":{"type":"string","enum":["active","archived"]},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerRecipientListResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientListResponse":{"type":"object","required":["recipients","total","limit","offset"],"properties":{"recipients":{"type":"array","items":{"$ref":"#/components/schemas/PartnerRecipient"}},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":1},"offset":{"type":"integer","minimum":0}}},"PartnerRecipient":{"type":"object","required":["id","kind","recipient_name","recipient_country","lifecycle","version","screening_status","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["individual","business"]},"recipient_name":{"type":"string"},"recipient_native_name":{"type":"string","nullable":true},"recipient_country":{"type":"string"},"recipient_id_type":{"type":"string","nullable":true},"recipient_id_number":{"type":"string","nullable":true,"description":"Masked partner-visible identity value; full value is never returned."},"recipient_business_registration_number":{"type":"string","nullable":true,"description":"Masked when returned."},"lifecycle":{"type":"string","enum":["draft","active","archived"]},"version":{"type":"integer","minimum":1},"screening_status":{"type":"string","enum":["pending","cleared","hit","manual_review"]},"screened_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerRecipientDestinationsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerRecipientDestinationsResponse":{"type":"object","required":["recipient_destinations"],"properties":{"recipient_destinations":{"type":"array","items":{"$ref":"#/components/schemas/PartnerRecipientDestination"}}}},"PartnerRecipientDestination":{"type":"object","required":["id","recipient_id","payment_method_id","payment_network_id","country_code","currency","version","lifecycle","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"payment_method_id":{"type":"integer","format":"int64"},"payment_network_id":{"type":"integer","format":"int64"},"country_code":{"type":"string","minLength":2,"maxLength":2},"currency":{"type":"string"},"details":{"type":"object","additionalProperties":true,"description":"The rail's own fields, as submitted. On reads, values that identify an account or a person are masked to last-4 (`account_number`, `bank_account_number`, `iban`, `card_number`, `id_number`, `national_id`, `tax_id`, `mobile_number`, `phone_number`, `msisdn`); everything else — names, `bank_name`, `province`, `branch`, routing codes, `beneficiary_type` — is returned in full so destinations stay distinguishable."},"version":{"type":"integer","minimum":1},"lifecycle":{"type":"string","enum":["active","archived"]},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerQuoteRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerQuoteRequest":{"type":"object","required":["user_uuid","crypto_currency","fiat_currency"],"allOf":[{"oneOf":[{"required":["crypto_amount"]},{"required":["fiat_amount"]}]},{"oneOf":[{"required":["payment_details_id"]},{"required":["sender_id","recipient_id","recipient_destination_id","sender_recipient_relationship","purpose_of_payment"]}]}],"properties":{"user_uuid":{"type":"string","format":"uuid","description":"Public UUID of the end-user (returned by `POST /partner/users` as `id`)"},"payment_details_id":{"type":"integer","format":"int64","description":"Required for a self-payout. MUST be omitted for a third-party payout, which is routed by `recipient_destination_id`. Sending both is rejected with `400 INVALID_REQUEST` — the two modes are mutually exclusive and neither silently wins."},"sender_id":{"type":"string","format":"uuid","description":"Canonical KYC subject who is funding the third-party payout. Required for third-party\npayout and must equal the real sender represented by `user_uuid`.\n"},"recipient_id":{"type":"string","format":"uuid","description":"Partner-owned recipient returned by `POST /partner/recipients`."},"recipient_destination_id":{"type":"string","format":"uuid","description":"Active destination owned by `recipient_id`; replaces `payment_details_id` for third-party payout."},"sender_recipient_relationship":{"type":"string","minLength":1,"description":"Payment-level relationship between the real sender and recipient, for example `supplier` or `family`."},"purpose_of_payment":{"type":"string","minLength":1,"description":"Canonical payment purpose used for compliance and translated only at the vendor boundary."},"purpose_details":{"type":"string","description":"Optional invoice or free-text clarification of the payment purpose."},"crypto_currency":{"type":"string","description":"Cryptocurrency code (e.g., USDT, USDC)"},"crypto_amount":{"type":"string","description":"Amount of crypto to sell (standard units, e.g., \"100.00\" for 100 USDT).\nProvide exactly one of `crypto_amount` or `fiat_amount`.\nWhen provided, the order is **crypto-anchored** — exact crypto cost is guaranteed, fiat payout varies by rate at settlement.\n"},"fiat_amount":{"type":"string","description":"Exact fiat amount the recipient will receive (e.g., \"500000\" for 500,000 NGN).\nProvide exactly one of `crypto_amount` or `fiat_amount`.\nWhen provided, the order is **fiat-anchored** — exact fiat delivery is guaranteed, crypto cost may vary within a 1.20× safety bound.\nFor integer-minor-unit currencies (NGN, UGX, TZS, KES, GHS), must be a whole number.\n"},"fiat_currency":{"type":"string","description":"Target fiat currency code (e.g., NGN, USD, EUR)"},"rail":{"type":"string","description":"Optional rail hint; must be compatible with payment details if provided"},"route":{"type":"string","description":"Optional route hint; must be compatible with payment details if provided"},"provider_scope":{"type":"string","description":"Optional provider scope filter; defaults to all","enum":["all","licensed_only","p2p_only"]},"slippage_tolerance":{"allOf":[{"$ref":"#/components/schemas/SlippageTolerance"}],"description":"Optional. Maximum tolerated price movement between `/quote` and `/initiate`,\nand between `/initiate` and vendor acceptance. When omitted, the default is\n`percent` / `0` — any rate movement returns `PRICE_CHANGED_REQUOTE` and the\npartner must request a fresh quote. Set this to opt in to silent execution\nfor small market movements.\n"},"has_fiat_settlement_notification":{"type":"boolean","description":"When `true`, only match liquidity providers that send fiat settlement\nnotifications. Orders from these providers complete automatically when\nfiat is delivered. When omitted or `false`, all providers are eligible.\n"},"partner_fee_pct":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"Optional per-order markup you charge your end user, applied on the same crypto base\nas the platform fee (non-compounding). Percent units: `1` means 1%. Omitting the field\nfrom this request payload — or sending `0` — means no markup; the markup cannot be\nnegative. Fiat-anchored offramp orders have no cap — the deposit grows to cover the\nmarkup. Every other case hits a formula domain bound, not a business cap: onramp\nrejects `partner_fee_pct >= 100` (the withheld or grossed-up fee would consume the\nentire buyer amount, leaving nothing delivered); crypto-anchored offramp rejects it\nwhen the fee would consume the entire pinned deposit.\n\nNote: you send this value as a JSON **string**, but it round-trips as a JSON **number**\nin `fee_breakdown.partner_fee_pct` and in the webhook `data.partner_fee_pct` field —\ndon't parse those as strings.\n\n**Rejection reference:**\n\n| Rejection | `error.code` | HTTP status |\n|---|---|---|\n| `partner_fee_pct` is non-numeric, negative, `NaN`, or `Inf` | `INVALID_REQUEST` | 400 |\n| Onramp: fee would consume the entire buyer amount (`partner_fee_pct >= 100`) | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: fee would consume the entire pinned deposit | `INVALID_REQUEST` | 400 |\n| Fiat-anchored offramp: the computed fee is not a finite amount | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: the carved fee-exclusive gross falls outside the matched offer's min/max | `NO_OFFERS_AVAILABLE` | 409 |\n","default":"0"}}},"SlippageTolerance":{"type":"object","properties":{"type":{"type":"string","enum":["percent","amount","fiat"],"description":"Tolerance type:\n- `percent` — percentage of the quoted rate (e.g., 1.5 = 1.5%)\n- `amount` — absolute fiat amount (e.g., 50.00 = 50 NGN)\n- `fiat` — alias of `amount`\n"},"value":{"type":"number","format":"double","description":"Tolerance value (percentage or fiat amount depending on type)"}}}}}}
```

## The PartnerQuoteResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerQuoteResponse":{"type":"object","properties":{"quote_id":{"type":"string","format":"uuid","description":"Unique quote identifier — use this to initiate the order"},"anchor_type":{"type":"string","enum":["crypto","fiat"],"description":"Indicates which amount is guaranteed at settlement.\n- `crypto` — `crypto_amount` is exact; `fiat_amount` may vary by the rate at settlement.\n- `fiat` — `fiat_amount` is exact; `crypto_amount` may vary within a 1.20× safety bound.\n"},"rate":{"type":"string","description":"Crypto-to-fiat exchange rate at quote time"},"crypto_amount":{"type":"string","description":"Total crypto amount — the fee-exclusive gross: the sell amount plus the platform fee.\nPartner-fee-exclusive: your markup is reported separately in `fee_breakdown.partner_fee` and\nis not added here. This is not the total you fund: the amount you actually fund at initiation\nis `crypto_amount + fee_breakdown.partner_fee` (see the transfer authorization endpoint).\n"},"fiat_amount":{"type":"string","description":"Fiat amount the recipient receives"},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"},"payment_details_id":{"type":"integer","format":"int64","description":"Payment details ID used for this quote"},"payment_method_id":{"type":"integer","format":"int64","description":"Matched payment method ID"},"payment_network_id":{"type":"integer","format":"int64","description":"Matched payment network ID"},"matching_type":{"type":"string","enum":["network","exact_payment_method"],"description":"How the matched offer was reached. `network` — standard payment-network matching. `exact_payment_method` — the offer only matches a counterparty on one of the exact payment methods listed in `exact_payment_method_matching_offers`. Omitted when no offer was matched."},"network_matching_available":{"type":"boolean","description":"`true` when `matching_type` is `network`. `false` means this quote is reachable only through exact payment-method matching."},"exact_payment_method_matching_offers":{"type":"array","description":"Routes in the same context that only exact payment-method matching can reach — the alternatives to the one this quote matched. Omitted when there are none. It also travels under `error.details` on a `409 NO_OFFERS_AVAILABLE`, which is where it matters most: the refusal names the routes that would have worked. An absent key means none were found **or** the lookup failed; it is not a promise that no such route exists.","items":{"$ref":"#/components/schemas/ExactPaymentMethodMatchingOffer"}},"expires_at":{"type":"string","format":"date-time","description":"Quote expiration timestamp: 60 seconds from creation, in UTC (`Z`). Initiate before it, or request a fresh quote."},"has_fiat_settlement_notification":{"type":"boolean","description":"Whether the matched liquidity provider sends fiat settlement notifications.\nWhen `true`, the order will complete automatically when fiat is delivered\nto the recipient. When `false`, you must call `confirm-fiat-received`.\nYou can call `confirm-fiat-received` at any time regardless of this value.\n"},"recipient_context":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerRecipientContext"}],"nullable":true,"description":"Immutable canonical recipient snapshot for a third-party quote; absent for self-payout."},"delayed_settlement":{"type":"boolean","description":"Whether initiating this quote would open a **delayed settlement (T+1)** order: the crypto\nleaves escrow before the fiat is paid, instead of both legs completing together. Your\nrelease signature authorises that move; Unigox then sends the crypto to the licensed partner, and the\nfiat is expected within `settlement_hours` of that release (a target, not a deadline).\n**Always present.**\n\nNo parameter requests it. `provider_scope=licensed_only` leaves T+1 offers out, but it\nalso leaves out every other P2P offer, so use it only if that is what you want. A\ndelayed offer is considered only when no instant\noffer covers the amount, and only on orders whose crypto you hold — never on a widget\norder. It is also considered only once Unigox has enabled delayed settlement for you.\nDelayed settlement is switched on for your account by Unigox on request: tell us once\nyour integration can sign the release (Step 4 of the Delayed settlement (T+1)\nreference). It is a configuration change on our side, not an automatic consequence of\na signature. Until then your orders match instant offers only.\n\nThe class is kept with the quote. `false` here means the order can never be T+1,\nwhatever happens to the offer in the meantime. `true` means it will be T+1 unless the\norder ends up on an instant offer before a licensed partner accepts it (instant liquidity\nappeared by the time you initiate, or the order moved to an instant offer while it\nwaited), in which case the order is instant — the money arrives sooner than quoted. The\norder response says which, provisionally until a licensed partner accepts the order.\n"},"settlement_hours":{"type":"integer","nullable":true,"description":"The expected payout window, counted from the release — not from now. It is the licensed\npartner's target for the bank payment, not a guaranteed deadline: nothing happens\nautomatically when it passes, so present it to your customer as expected timing. Rounded to\nthe nearest whole hour and never below `1`. `null` on an instant quote.\n"}}},"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}},"ExactPaymentMethodMatchingOffer":{"type":"object","description":"One route in the same crypto/fiat/network context that is reachable **only** by exact payment-method matching — a counterparty on this exact method, rather than anyone on the network. Quote with `payment_method_slug` and `payment_network_slug` set to these values to reach it.","properties":{"payment_method_slug":{"type":"string"},"payment_method_name":{"type":"string"},"payment_network_slug":{"type":"string"},"payment_network_name":{"type":"string"},"country_code":{"type":"string","description":"Omitted when the route was resolved without a country scope."},"country_name":{"type":"string","description":"Omitted with `country_code`."}}},"PartnerRecipientContext":{"type":"object","required":["sender_id","recipient_id","recipient_destination_id","sender_recipient_relationship","purpose_of_payment","screening_status"],"properties":{"sender_id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"recipient_destination_id":{"type":"string","format":"uuid"},"sender_recipient_relationship":{"type":"string"},"purpose_of_payment":{"type":"string"},"purpose_details":{"type":"string"},"screening_status":{"type":"string"}}}}}}
```

## The PartnerInitiateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerInitiateRequest":{"type":"object","required":["quote_id"],"properties":{"quote_id":{"type":"string","format":"uuid","description":"Quote ID from the quote endpoint. Payment details are taken from the quote."},"reference_id":{"type":"string","description":"Optional partner-supplied external reference ID (e.g. your internal order ID). Stored on the order and echoed back in responses."}}}}}}
```

## The PartnerInitiateResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerInitiateResponse":{"type":"object","properties":{"order_id":{"type":"string","format":"uuid","description":"Unique order identifier for tracking"},"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"quote_id":{"type":"string","format":"uuid","description":"Quote ID that was consumed"},"reference_id":{"type":"string","nullable":true,"description":"Partner-supplied external reference ID (echoed from initiate request)"},"order_type":{"type":"string","enum":["offramp","onramp"],"description":"Direction of the order"},"amounts":{"$ref":"#/components/schemas/PartnerOrderAmounts"},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/TimelineEntry"}},"created_at":{"type":"string","format":"date-time"},"recipient_context":{"allOf":[{"$ref":"#/components/schemas/PartnerRecipientContext"}],"nullable":true},"compliance":{"allOf":[{"$ref":"#/components/schemas/PartnerComplianceCase"}],"nullable":true,"description":"Durable case in Unigox compliance review for a third-party payout."},"payout_via_own_account":{"type":"boolean","description":"`true` when this off-ramp will be paid through the customer's own fiat\naccount and then on to the bank you named. Omitted otherwise, never `false`. Read\n`own_account_payout_status` on the order to follow it.\n"}}},"PartnerOrderStatus":{"type":"string","description":"Order status.\n\n**Off-ramp statuses (crypto → fiat):**\n- `created` — order created, quote locked\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_crypto_transfer_authorization` — partner must authorize crypto transfer via EIP-712 signature\n- `crypto_transfer_authorization_pending` — authorization submitted, awaiting on-chain confirmation\n- `crypto_received` — crypto locked in escrow\n- `fiat_payment_started` — buyer submitted fiat payment proof\n- `fiat_payment_review_started` — the proof is under review\n- `dispute_started` — a dispute was raised on the order\n- `awaiting_fiat_received_confirmation` — waiting for partner to confirm fiat receipt\n- `fiat_received_confirmed`, `crypto_release_pending` — timeline vocabulary. They appear in\n  `timeline[].status`; no order reports either as its own `status`, and filtering on them\n  returns nothing\n- `completed` — order fully completed\n- `cancelled` — order cancelled\n- `failed` — terminal error\n- `price_changed_requote_needed` — slippage exceeded at initiation. Like\n  `awaiting_liquidity_provider`, it is reported before a liquidity provider has accepted\n  the order, and `GET /partner/orders?status=` returns the orders that report it\n\n**Delayed settlement (T+1) statuses:**\n\n> Both are unreachable for an ordinary order.\n\n- `settlement_in_progress` — crypto release has started or is confirmed; the order is not\n  yet resolved. This alone does not mean a bank payment has been sent\n- `returned` — the payout went out and the bank sent it back, with no new payout\n  authorization. The crypto is not refunded yet: Unigox arranges another payout attempt, or\n  refunds the crypto and the order reads `cancelled`. A payout the provider cancelled before\n  sending it is not a return\n\nPrecedence on a delayed order, in this order — more than one mark can be set at once:\n\n1. `delayed_settlement_fiat_paid_to_customer_at` set → `completed`\n2. else `delayed_settlement_crypto_refunded_to_customer_at` set → `cancelled`\n3. else `delayed_settlement_fiat_returned_by_bank_at` set **and**\n   `delayed_settlement_fiat_payout_authorized_by_admin_at` `null` → `returned`\n4. else, on a release status → `settlement_in_progress`\n5. before the release, the ordinary mapping applies — a funded delayed order awaiting release is\n   `crypto_received` like any other, and `next_action` is what tells them apart\n\nA return with a fresh authorization on top reads as `settlement_in_progress` (step 4).\n\n**On-ramp statuses (fiat → crypto):**\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_vendor_escrow_funding` — vendor accepted, funding escrow with crypto\n- `awaiting_fiat_transfer` — crypto locked in escrow; the partner pays the vendor and confirms payment sent (`fiat_funding_source: vendor_details`), or the customer transfers into their own fiat account (`own_account`)\n- `fiat_transfer_pending` — fiat payment confirmed, awaiting vendor confirmation of receipt\n- `completed` — vendor confirmed fiat received, crypto released to end-user wallet\n- `cancelled` — order cancelled\n- `failed` — escrow error\n\n**On-ramp send-out statuses (optional post-trade cross-chain transfer):**\n\n> After an on-ramp order reaches `completed`, the partner may optionally initiate a\n> **send-out** — a cross-chain transfer of the received crypto to a destination network\n> (e.g. XAI → Arbitrum). This is an additional flow and does not affect the core trade lifecycle.\n> The `completed` status reflects that the trade itself is done; send-out statuses track\n> the subsequent cross-chain transfer only.\n\n- `send_out_pending` — send-out initiated, cross-chain transfer in progress\n- `send_out_completed` — cross-chain transfer successfully delivered to destination\n- `send_out_failed` — cross-chain transfer failed; the on-ramp trade itself remains completed\n","enum":["created","awaiting_liquidity_provider","awaiting_crypto_transfer_authorization","crypto_transfer_authorization_pending","crypto_received","fiat_payment_started","fiat_payment_review_started","dispute_started","awaiting_fiat_received_confirmation","fiat_received_confirmed","crypto_release_pending","awaiting_vendor_escrow_funding","awaiting_fiat_transfer","fiat_transfer_pending","completed","cancelled","failed","price_changed_requote_needed","settlement_in_progress","returned","send_out_pending","send_out_completed","send_out_failed"]},"PartnerOrderAmounts":{"type":"object","properties":{"crypto_amount":{"type":"string","description":"Total crypto amount (standard units) — the fee-exclusive gross: the buy/sell amount plus the\nplatform fee. Partner-fee-exclusive, except for a crypto-anchored onramp order (originally\nquoted with `crypto_amount`): there the amount was sized up so the delivered amount stays\nexact after the partner fee is withheld, so this field includes the markup. A crypto-anchored\nofframp order carves both fees out of the pinned deposit instead, so this field and\n`fee_breakdown.platform_fee` both shrink relative to a no-markup request, even though the\nmarkup itself stays out of this field. Every other case is unaffected — the markup is\nreported separately in `fee_breakdown.partner_fee`.\n\nOn-ramp — what the end user receives: `crypto_amount − fee_breakdown.platform_fee −\nfee_breakdown.partner_fee` for a fiat-anchored order, or exactly this `crypto_amount` for a\ncrypto-anchored order (both fees are withheld at bridge send-out without changing this\nfield). Off-ramp — what the partner funds at transfer authorization:\n`crypto_amount + fee_breakdown.partner_fee`.\n"},"fiat_amount":{"type":"string","description":"Fiat amount the user receives"},"crypto_currency":{"type":"string","description":"Cryptocurrency code"},"fiat_currency":{"type":"string","description":"Fiat currency code"},"rate":{"type":"string","description":"Crypto-to-fiat exchange rate"}}},"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}},"TimelineEntry":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"timestamp":{"type":"string","format":"date-time","description":"When this status was reached"},"description":{"type":"string","description":"Human-readable description of the status change.\n\nOn a **delayed settlement (T+1)** order the release entry reads\n`Crypto released to the liquidity provider, ahead of the payout` under\n`settlement_in_progress`, not `Order completed`: the crypto leaving escrow is the middle of\nthat order's story, not its end. Seven more entries follow it —\n`Crypto transferred to the payout provider`, `Fiat payout authorized`,\n`Fiat payout submitted by the provider` and\n`Fiat payout cancelled by the provider before it was sent` (all `settlement_in_progress`),\n`Fiat paid to the customer` (`completed`), `Fiat returned by the bank` (`returned`) and\n`Crypto refunded to the customer` (`cancelled`). An ordinary order's timeline is unchanged,\nentry for entry.\n\nConsecutive entries are collapsed by status; on a delayed order they are collapsed by status\n**and** description, so the intermediate facts that all carry `settlement_in_progress` each\nkeep their own line.\n\nOnce a payment has come back, or the payout provider cancelled it before sending it, and a\nnew attempt followed, every attempt stays on the timeline and the approval, sending, paid,\nreturn and cancellation entries end in `(attempt N)`, for example\n`Fiat payout authorized (attempt 2)` or `Fiat paid to the customer (attempt 2)`. With a\nsingle attempt there is no suffix. `Crypto transferred to the payout provider` is read from\nthe order's timestamp and leaves the timeline when that timestamp is cleared.\n"}}},"PartnerRecipientContext":{"type":"object","required":["sender_id","recipient_id","recipient_destination_id","sender_recipient_relationship","purpose_of_payment","screening_status"],"properties":{"sender_id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"recipient_destination_id":{"type":"string","format":"uuid"},"sender_recipient_relationship":{"type":"string"},"purpose_of_payment":{"type":"string"},"purpose_details":{"type":"string"},"screening_status":{"type":"string"}}},"PartnerComplianceCase":{"type":"object","required":["case_id","status","risk_decision","requires_review"],"description":"The compliance record for a third-party payout. In v1 the controls run BEFORE the order is\ncreated, so a payout that fails one is rejected with an error rather than returned as a held\norder — see the error codes in the Third-party payouts guide.\n","properties":{"case_id":{"type":"string","format":"uuid","description":"Identifier of the compliance record — the payout's `quote_id`, so a partner and a Unigox\noperator refer to the same record.\n"},"status":{"type":"string","enum":["authorized"],"description":"v1 emits `authorized`; a rejected payout returns an error instead."},"risk_decision":{"type":"string","enum":["allow"],"description":"v1 emits `allow`; a blocking decision surfaces as an error, not a status."},"requires_review":{"type":"boolean","description":"Always false in v1. Operator review happens Unigox-side over the same record."}}}}}}
```

## The PartnerStatsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerStatsResponse":{"type":"object","properties":{"total_orders":{"type":"integer","description":"Every order you have, including ones no liquidity provider accepted yet."},"completed_orders":{"type":"integer","description":"Orders whose crypto was released or is being released. A delayed settlement (T+1) order counts only once its payment is recorded paid."},"volume_usd":{"type":"number","description":"Fiat volume of completed orders, in USD at each order's snapshotted rate."},"earned_usd":{"type":"number","description":"Your markup captured on completed orders, in USD."}}}}}}
```

## The PartnerOrderResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerOrderResponse":{"type":"object","properties":{"order_id":{"type":"string","format":"uuid","description":"Unique order identifier"},"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"next_action":{"type":"string","description":"The action the partner **must** perform to advance the order. The key is **absent**\nwhen no action is required at this stage — the order is waiting for the\ncounterparty or for an automated system step — and is never sent as `null`.\n\nPossible values:\n- `authorize_crypto_transfer` — partner must authorize escrow funding\n- `confirm_fiat_received` — partner must confirm they received the fiat payment\n- `request_new_quote` — price changed, partner must request a new quote\n- `update_kyc_address` — address fields are required for EUR/AUD/GBP payouts; see `action_required` for the endpoint and fields to submit\n- `authorize_refund` — the order ended without a payout and its crypto is still in escrow; only your\n  signature can send it back. Note that this appears on an order whose `status` is `cancelled`, which\n  is the one case where a terminal status still needs something from you\n- `deposit_to_user_account` — an on-ramp order with `fiat_funding_source: own_account` is waiting for the\n  customer to transfer the order's fiat amount into the fiat account issued to them. The transfer\n  itself confirms the payment; there is nothing to call. If the money is already on the account,\n  `pay-from-balance` is in `allowed_actions` and pays the order from it\n- `sign_settlement_consent` — a **delayed settlement (T+1)** order remains at `crypto_received`\n  and nobody has signed the release yet\n- `submit_source_of_funds` — consent is stored and a required source-of-funds case is\n  incomplete, including an existing case below the current threshold\n- `await_review` — consent is stored and the order is waiting for Unigox document review,\n  the licensed partner's payment check, or release processing. Do not submit another signature\n- absent — no required action (waiting for buyer or system). On a funded delayed order awaiting release\n  the key is absent when the order is held for review, or a payout of yours failed and a\n  refund is under way\n\nOnce consent_deadline_at has passed, these reads no longer request a consent signature,\neven if the order status has not changed yet.\nThe list (`GET /api/v1/partner/orders`) reads the consent from the order record and can show\n`await_review`, for up to two minutes, for a consent call that was cut off before your signature\nwas stored. After a\ntimeout, read the single order (`GET /api/v1/partner/orders/{order_id}`) before you decide\nwhether to send the signature again. If a lookup behind the T+1 hint fails, both reads fall\nback to `sign_settlement_consent`.\n","enum":["authorize_crypto_transfer","confirm_fiat_received","request_new_quote","update_kyc_address","authorize_refund","deposit_to_user_account","sign_settlement_consent","submit_source_of_funds","await_review"]},"action_required":{"type":"object","nullable":true,"description":"Present when the order needs partner intervention before it can proceed.\nContains machine-readable type, human-readable message, the API endpoint to call,\nand the fields to provide. Null/omitted when no action is needed.\n","required":["type","message"],"properties":{"type":{"type":"string","description":"Machine-readable action identifier"},"message":{"type":"string","description":"Human-readable explanation of what is needed and why"},"endpoint":{"type":"string","description":"API endpoint to call to resolve this action"},"fields":{"type":"array","description":"Fields the partner needs to provide","items":{"type":"object","required":["field","label"],"properties":{"field":{"type":"string","description":"API field name"},"label":{"type":"string","description":"Human-readable description of the field"}}}}}},"allowed_actions":{"type":"array","items":{"type":"string"},"description":"List of API actions the partner **can** perform at the current status. An action\nmay be present here even when `next_action` is absent — meaning it is optional.\n\nNotable case: `confirm-fiat-received` appears at both `crypto_received` and\n`awaiting_fiat_received_confirmation`. At `crypto_received` it is a **fast-track**:\nif you already know the fiat has arrived via your own systems, you can confirm\nimmediately. Otherwise, wait for the buyer's proof flow to complete — the order\nwill reach `awaiting_fiat_received_confirmation` automatically.\n\nStatus-to-actions mapping:\n- `created` → `[\"cancel\"]`\n- `awaiting_liquidity_provider` → `[\"cancel\"]`\n- `awaiting_crypto_transfer_authorization` → `[\"authorize-crypto-transfer\", \"cancel\"]`\n- `crypto_transfer_authorization_pending` → `[]` (the transfer is in flight; cancel is refused)\n- `crypto_received` → `[\"confirm-fiat-received\"]` (optional fast-track)\n- `fiat_payment_started` → `[\"confirm-fiat-received\"]` (optional fast-track after buyer proof submission)\n- `awaiting_fiat_received_confirmation` → `[\"confirm-fiat-received\"]` (required)\n- `fiat_received_confirmed`, `crypto_release_pending`, `completed`, `failed` → `[]`\n- `cancelled` → `[]`, **except** when the order's crypto is still sitting in escrow: then\n  `[\"authorize-refund\"]`. An off-ramp order that stops after funding — expired payment window,\n  declined payment proof, returned bank payment, dispute resolved for the seller — reads as\n  `cancelled` like every other stopped order, and the escrow is a 2-of-3 Safe your key is an\n  owner of. This is the only thing that tells the two apart, so poll it on `cancelled` orders\n  rather than assuming a cancelled order is finished with. `next_action` is\n  `authorize_refund` and `action_required` names the endpoint at the same time.\n\nOn-ramp orders with `fiat_funding_source: own_account` never offer `confirm-payment-sent`: the\ntransfer into the customer's own account is the confirmation. At `awaiting_fiat_transfer` they\noffer `[\"pay-from-balance\"]` instead, until the order's fiat has been collected. A `completed`\norder paid from the balance whose crypto hand-over has not finished also offers\n`[\"pay-from-balance\"]`: calling it again retries the hand-over and never takes the money twice.\n\nOn a funded **delayed settlement (T+1)** order awaiting release whose crypto you hold,\n`confirm-fiat-received` is removed — the endpoint behind it refuses a delayed order — and\n`[\"settlement-consent\", \"cancel\"]` take its place.\n\n`cancel` is available only while the order awaits release; the endpoint is the ordinary\n`POST /api/v1/partner/orders/{order_id}/cancel`.\n\nBoth are withdrawn once the consent is signed, and then answer\n`409 OPERATION_NOT_ALLOWED`. The list reads the consent from the order record, so a list row\ncan already show them withdrawn, for up to two minutes, for a consent call that was cut off\nbefore your signature was\nstored. After a timeout, read the single order (`GET /api/v1/partner/orders/{order_id}`)\nbefore you decide whether to send the signature again.\n\nOn a funded delayed order awaiting release that is **held** — Unigox holds it for a check, or a\npayout failed and a refund is under way — `next_action` is omitted and no consent is accepted.\n`confirm-fiat-received` is absent there too, because that endpoint refuses every delayed\norder. An `authorize-refund` that is genuinely owed still appears.\nCustody outranks the mapping above: on a **widget order** — one your customer created\nthrough the embedded widget under your `widgetKey` — this is `[]` at every status,\nbecause the crypto is the end user's and every action endpoint answers `404\nORDER_NOT_FOUND` for it.\n"},"fiat_funding_source":{"type":"string","enum":["vendor_details","own_account"],"description":"On-ramp orders only. Where the fiat for this order is paid:\n- `vendor_details` — to the vendor's bank account in `vendor_payment_details`; then call\n  `confirm-payment-sent`.\n- `own_account` — into the fiat account you issued to the customer, named by\n  `fiat_account_id`. There are no `vendor_payment_details` and no `confirm-payment-sent`:\n  the transfer landing on the customer's account is matched to the order by amount and the\n  order proceeds on its own.\n\nRead it on every order rather than assuming one or the other.\n"},"fiat_account_id":{"type":"string","format":"uuid","description":"On an `own_account` order: the fiat account the customer transfers into. The same id the\nFiat Accounts endpoints take, so the deposit that funds this order can be found on that\naccount's transactions carrying this order's id.\nOn an off-ramp with `payout_via_own_account: true`: the customer's fiat account the money\ngoes through, when it is one you can address by id; omitted otherwise.\n"},"payout_via_own_account":{"type":"boolean","description":"`true` on an off-ramp paid through the customer's own fiat account: the liquidity provider\npays the customer's account and Unigox then pays the money on to the bank you named, both in\nthe customer's name. EUR and GBP off-ramps to the customer's own `payment_details` are paid\nthis way wherever customer fiat accounts are active for your partner in that currency; when\nthey cannot be, the quote is refused (`FIAT_ACCOUNT_OPENING`, `FIAT_ACCOUNT_REQUIRED`,\n`FIAT_ACCOUNTS_NOT_ENABLED`) unless a liquidity provider that pays banks directly takes the\norder. Omitted on every other order, never `false`. If you do not call\n`confirm-fiat-received`, the order is confirmed once Unigox has matched the money on the\ncustomer's account. That payment into the account does not send\n`fiat_account.deposit.received`.\n"},"own_account_payout_status":{"type":"string","enum":["awaiting_credit","in_progress","sent_to_bank","under_review","held","left_on_account"],"description":"Off-ramp paid through the customer's own fiat account only (`payout_via_own_account: true`):\nwhere the onward payment, from that account to the bank you named, stands. `status` describes\nthe provider's payment into the customer's account, so an order can be `completed` while this\nstill says the money has not reached the bank.\n- `awaiting_credit` — nothing has landed on the customer's account for this order yet.\n- `in_progress` — the money landed; the onward payment is queued, being sent, or being retried.\n- `sent_to_bank` — the money was sent on to the bank you named.\n- `under_review` — the onward payment ended without a clear result; Unigox checks it.\n- `held` — the money is on the customer's account and is not moving on by itself; contact Unigox.\n- `left_on_account` — Unigox decided the money stays on the customer's account.\n\nOmitted on other orders, and when the state cannot be read at that moment.\n"},"crypto_transfer_authorization_seconds_left":{"type":"integer","format":"int64","nullable":true,"description":"Remaining seconds to authorize crypto transfer while order is in\n`awaiting_crypto_transfer_authorization` / `crypto_transfer_authorization_pending`.\n`null` for all other statuses.\n"},"amounts":{"$ref":"#/components/schemas/PartnerOrderAmounts"},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/TimelineEntry"},"description":"Chronological list of status changes"},"has_fiat_settlement_notification":{"type":"boolean","description":"Whether the matched liquidity provider sends fiat settlement notifications.\nWhen `true`, the order will complete automatically when fiat is delivered.\nWhen `false`, you must call `confirm-fiat-received`. You can call\n`confirm-fiat-received` at any time regardless of this value, except on a delayed\nsettlement (T+1) order, which refuses it. `false` on every order no liquidity provider\nhas accepted yet, T+1 included; a T+1 order reads `true` from its acceptance on.\n"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"order_type":{"type":"string","enum":["offramp","onramp"],"description":"Order type. Present on every order, including one no liquidity provider has accepted yet.\n- `offramp` — sell crypto for fiat\n- `onramp` — buy crypto with fiat\n"},"vendor_payment_details":{"type":"object","nullable":true,"description":"Vendor's payment details for the end-user to send fiat to.\nPresent only for on-ramp orders at `awaiting_fiat_transfer` status and beyond.\n","properties":{"payment_method_name":{"type":"string"},"payment_network_name":{"type":"string"},"details":{"type":"object","description":"Payment method-specific fields (e.g. account_number, phone)"}}},"payment_request":{"type":"boolean","nullable":true,"description":"`true` if the vendor uses payment request flow — the partner must call\n`submit-payer-details` before `confirm-payment-sent`.\n"},"send_out_tx_hash":{"type":"string","nullable":true,"description":"Destination-chain transaction hash after a send-out completes.\nPresent only for on-ramp orders with `send_out_completed` status.\n"},"payment_deadline_at":{"type":"string","format":"date-time","nullable":true,"description":"On-ramp only: the moment the order can be cancelled for want of the customer's fiat.\nTell the customer to pay before it. The order is cancelled shortly after it (`cancelled`,\n\"Payment window expired\"): on your next read of the order, and an `own_account` order\nwithin about 20 minutes even if nobody reads it. A transfer that arrives after this moment but before the cancellation may\nstill complete the order; that is possible, not guaranteed. One that arrives after the\ncancellation stays on the customer's account and can be used with `pay-from-balance` on a\nnew order. Extended along with the window.\nSet while the order is `awaiting_fiat_transfer`, `null` otherwise — and always `null`\non an off-ramp, and on an order held for manual handling (it does not expire). UTC.\n"},"recipient_context":{"allOf":[{"$ref":"#/components/schemas/PartnerRecipientContext"}],"nullable":true,"description":"Immutable third-party recipient context; absent for self-payout and on-ramp."},"compliance":{"allOf":[{"$ref":"#/components/schemas/PartnerComplianceCase"}],"nullable":true,"description":"Current durable compliance-case state for a third-party payout."},"delayed_settlement":{"type":"boolean","description":"Whether this order settles **T+1**: the crypto leaves escrow before the fiat is paid.\nYour release signature authorises it to leave and Unigox performs the release; the fiat\nis expected within `settlement_hours` of it (a target, not a deadline). Present on every\norder, on-ramp included, along\nwith the other T+1 fields below. T+1 timestamps and the window are null on instant\norders. The current numeric source-of-funds threshold is still returned.\n\nProvisional until a licensed partner accepts the order. While an order quoted T+1 waits for\none, it follows the offer the order is currently offered to, so it can change: it reads\n`false` between offers and on an instant offer. Once such an order stops waiting without\nbeing accepted (you cancelled it, or no licensed partner accepted it), it keeps `true`,\nwith `settlement_hours` `null`. Fixed from acceptance.\n"},"settlement_hours":{"type":"integer","nullable":true,"description":"The expected payout window, counted from the release — not from the order. It is the licensed partner's target for the bank payment, not a guaranteed deadline: nothing happens automatically when it passes. Rounded to the nearest whole hour and never below `1`. `null` on an instant order."},"consent_deadline_at":{"type":"string","format":"date-time","nullable":true,"description":"Funding time plus the consent window. After expiry, release is blocked and the expiry\nprocess starts the refund flow. Set while awaiting release, `null` otherwise.\n"},"payout_deadline_at":{"type":"string","format":"date-time","nullable":true,"description":"Release time plus the expected window; `settlement_hours` is that window rounded to whole\nhours. When the payment is expected by, not a deadline: the order does not change and no\nevent is sent when it passes. `null` until the crypto has left escrow.\n"},"delayed_settlement_crypto_sent_to_provider_at":{"type":"string","format":"date-time","nullable":true,"description":"The crypto left the licensed partner's wallet for the payout provider. Set at the latest when Unigox authorizes the bank payment. No refund of the crypto is possible while it is set. Cleared when Unigox withdraws a record made by mistake, which it can do only while no payment has been authorized, sent, paid or returned, and when it refunds the crypto after a returned payment."},"delayed_settlement_fiat_payout_authorized_by_admin_at":{"type":"string","format":"date-time","nullable":true,"description":"Unigox authorized the licensed partner to send the bank payment. Never set before `delayed_settlement_crypto_sent_to_provider_at`: the authorization sets that one too when it is still `null`. Cleared by a bank return, and when the payout provider cancels the payment before sending it; Unigox then authorizes a new attempt."},"delayed_settlement_fiat_payout_submitted_by_provider_at":{"type":"string","format":"date-time","nullable":true,"description":"Submission of the bank payment was recorded; recipient payment is not yet confirmed."},"delayed_settlement_fiat_paid_to_customer_at":{"type":"string","format":"date-time","nullable":true,"description":"The fiat reached the recipient. This is the real completion of a delayed order."},"delayed_settlement_fiat_returned_by_bank_at":{"type":"string","format":"date-time","nullable":true,"description":"The payout went out and the bank sent it back. Set together with clearing the paid, submitted and authorized marks. Mutually exclusive with `delayed_settlement_fiat_paid_to_customer_at`. A payment the payout provider cancelled before sending it is not a return and does not set it."},"delayed_settlement_crypto_refunded_to_customer_at":{"type":"string","format":"date-time","nullable":true,"description":"The crypto went back to the wallet that funded the escrow (yours, on an order whose crypto you hold) instead of being paid out. Reachable while `delayed_settlement_crypto_sent_to_provider_at` is `null`, or after a returned payment when Unigox gives the payout up; that refund clears `delayed_settlement_crypto_sent_to_provider_at`."},"source_of_funds_required":{"type":"boolean","description":"Whether review applies by amount or an existing source-of-funds case. Can stay true after approval or completion; use case status and next_action for required action. False for instant orders. Always present."},"source_of_funds_threshold_usd":{"type":"number","description":"Current configured source-of-funds threshold in USD, not a historical snapshot. Always present, including on instant orders. Current policy is USD 50,000 inclusive."},"settlement_refund_reason":{"type":"string","description":"Why a delayed order ended without a payout. Omitted — not empty — when the order has not\nended that way, or when none of the six applies; an absence means no reason was recorded\nand never stands in for one of them.\n\n- `refunded_after_release` — the crypto had been released to the licensed partner and\n  was sent back: before it reached the payout provider, or after a payment came back and\n  Unigox gave the payout up. No payment reached the customer; the order reads `cancelled`\n- `dossier_rejected` — a reviewer refused the source-of-funds case\n- `consent_window_expired` — the consent was never signed and the window ran out\n- `not_released_in_time` — the consent **was** signed and the window still ran out,\n  because Unigox did not release the crypto in time. This one is ours, not the\n  customer's\n- `cancelled_by_customer` — the order was cancelled on your side before release\n- `cancelled_by_licensed_partner` — the licensed partner declined the order before the\n  release was signed\n\nRead in that order: a refund after the release outranks a refusal, which outranks an\nexpired window, which outranks a cancellation.\n","enum":["refunded_after_release","dossier_rejected","consent_window_expired","not_released_in_time","cancelled_by_customer","cancelled_by_licensed_partner"]}}},"PartnerOrderStatus":{"type":"string","description":"Order status.\n\n**Off-ramp statuses (crypto → fiat):**\n- `created` — order created, quote locked\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_crypto_transfer_authorization` — partner must authorize crypto transfer via EIP-712 signature\n- `crypto_transfer_authorization_pending` — authorization submitted, awaiting on-chain confirmation\n- `crypto_received` — crypto locked in escrow\n- `fiat_payment_started` — buyer submitted fiat payment proof\n- `fiat_payment_review_started` — the proof is under review\n- `dispute_started` — a dispute was raised on the order\n- `awaiting_fiat_received_confirmation` — waiting for partner to confirm fiat receipt\n- `fiat_received_confirmed`, `crypto_release_pending` — timeline vocabulary. They appear in\n  `timeline[].status`; no order reports either as its own `status`, and filtering on them\n  returns nothing\n- `completed` — order fully completed\n- `cancelled` — order cancelled\n- `failed` — terminal error\n- `price_changed_requote_needed` — slippage exceeded at initiation. Like\n  `awaiting_liquidity_provider`, it is reported before a liquidity provider has accepted\n  the order, and `GET /partner/orders?status=` returns the orders that report it\n\n**Delayed settlement (T+1) statuses:**\n\n> Both are unreachable for an ordinary order.\n\n- `settlement_in_progress` — crypto release has started or is confirmed; the order is not\n  yet resolved. This alone does not mean a bank payment has been sent\n- `returned` — the payout went out and the bank sent it back, with no new payout\n  authorization. The crypto is not refunded yet: Unigox arranges another payout attempt, or\n  refunds the crypto and the order reads `cancelled`. A payout the provider cancelled before\n  sending it is not a return\n\nPrecedence on a delayed order, in this order — more than one mark can be set at once:\n\n1. `delayed_settlement_fiat_paid_to_customer_at` set → `completed`\n2. else `delayed_settlement_crypto_refunded_to_customer_at` set → `cancelled`\n3. else `delayed_settlement_fiat_returned_by_bank_at` set **and**\n   `delayed_settlement_fiat_payout_authorized_by_admin_at` `null` → `returned`\n4. else, on a release status → `settlement_in_progress`\n5. before the release, the ordinary mapping applies — a funded delayed order awaiting release is\n   `crypto_received` like any other, and `next_action` is what tells them apart\n\nA return with a fresh authorization on top reads as `settlement_in_progress` (step 4).\n\n**On-ramp statuses (fiat → crypto):**\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_vendor_escrow_funding` — vendor accepted, funding escrow with crypto\n- `awaiting_fiat_transfer` — crypto locked in escrow; the partner pays the vendor and confirms payment sent (`fiat_funding_source: vendor_details`), or the customer transfers into their own fiat account (`own_account`)\n- `fiat_transfer_pending` — fiat payment confirmed, awaiting vendor confirmation of receipt\n- `completed` — vendor confirmed fiat received, crypto released to end-user wallet\n- `cancelled` — order cancelled\n- `failed` — escrow error\n\n**On-ramp send-out statuses (optional post-trade cross-chain transfer):**\n\n> After an on-ramp order reaches `completed`, the partner may optionally initiate a\n> **send-out** — a cross-chain transfer of the received crypto to a destination network\n> (e.g. XAI → Arbitrum). This is an additional flow and does not affect the core trade lifecycle.\n> The `completed` status reflects that the trade itself is done; send-out statuses track\n> the subsequent cross-chain transfer only.\n\n- `send_out_pending` — send-out initiated, cross-chain transfer in progress\n- `send_out_completed` — cross-chain transfer successfully delivered to destination\n- `send_out_failed` — cross-chain transfer failed; the on-ramp trade itself remains completed\n","enum":["created","awaiting_liquidity_provider","awaiting_crypto_transfer_authorization","crypto_transfer_authorization_pending","crypto_received","fiat_payment_started","fiat_payment_review_started","dispute_started","awaiting_fiat_received_confirmation","fiat_received_confirmed","crypto_release_pending","awaiting_vendor_escrow_funding","awaiting_fiat_transfer","fiat_transfer_pending","completed","cancelled","failed","price_changed_requote_needed","settlement_in_progress","returned","send_out_pending","send_out_completed","send_out_failed"]},"PartnerOrderAmounts":{"type":"object","properties":{"crypto_amount":{"type":"string","description":"Total crypto amount (standard units) — the fee-exclusive gross: the buy/sell amount plus the\nplatform fee. Partner-fee-exclusive, except for a crypto-anchored onramp order (originally\nquoted with `crypto_amount`): there the amount was sized up so the delivered amount stays\nexact after the partner fee is withheld, so this field includes the markup. A crypto-anchored\nofframp order carves both fees out of the pinned deposit instead, so this field and\n`fee_breakdown.platform_fee` both shrink relative to a no-markup request, even though the\nmarkup itself stays out of this field. Every other case is unaffected — the markup is\nreported separately in `fee_breakdown.partner_fee`.\n\nOn-ramp — what the end user receives: `crypto_amount − fee_breakdown.platform_fee −\nfee_breakdown.partner_fee` for a fiat-anchored order, or exactly this `crypto_amount` for a\ncrypto-anchored order (both fees are withheld at bridge send-out without changing this\nfield). Off-ramp — what the partner funds at transfer authorization:\n`crypto_amount + fee_breakdown.partner_fee`.\n"},"fiat_amount":{"type":"string","description":"Fiat amount the user receives"},"crypto_currency":{"type":"string","description":"Cryptocurrency code"},"fiat_currency":{"type":"string","description":"Fiat currency code"},"rate":{"type":"string","description":"Crypto-to-fiat exchange rate"}}},"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}},"TimelineEntry":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"timestamp":{"type":"string","format":"date-time","description":"When this status was reached"},"description":{"type":"string","description":"Human-readable description of the status change.\n\nOn a **delayed settlement (T+1)** order the release entry reads\n`Crypto released to the liquidity provider, ahead of the payout` under\n`settlement_in_progress`, not `Order completed`: the crypto leaving escrow is the middle of\nthat order's story, not its end. Seven more entries follow it —\n`Crypto transferred to the payout provider`, `Fiat payout authorized`,\n`Fiat payout submitted by the provider` and\n`Fiat payout cancelled by the provider before it was sent` (all `settlement_in_progress`),\n`Fiat paid to the customer` (`completed`), `Fiat returned by the bank` (`returned`) and\n`Crypto refunded to the customer` (`cancelled`). An ordinary order's timeline is unchanged,\nentry for entry.\n\nConsecutive entries are collapsed by status; on a delayed order they are collapsed by status\n**and** description, so the intermediate facts that all carry `settlement_in_progress` each\nkeep their own line.\n\nOnce a payment has come back, or the payout provider cancelled it before sending it, and a\nnew attempt followed, every attempt stays on the timeline and the approval, sending, paid,\nreturn and cancellation entries end in `(attempt N)`, for example\n`Fiat payout authorized (attempt 2)` or `Fiat paid to the customer (attempt 2)`. With a\nsingle attempt there is no suffix. `Crypto transferred to the payout provider` is read from\nthe order's timestamp and leaves the timeline when that timestamp is cleared.\n"}}},"PartnerRecipientContext":{"type":"object","required":["sender_id","recipient_id","recipient_destination_id","sender_recipient_relationship","purpose_of_payment","screening_status"],"properties":{"sender_id":{"type":"string","format":"uuid"},"recipient_id":{"type":"string","format":"uuid"},"recipient_destination_id":{"type":"string","format":"uuid"},"sender_recipient_relationship":{"type":"string"},"purpose_of_payment":{"type":"string"},"purpose_details":{"type":"string"},"screening_status":{"type":"string"}}},"PartnerComplianceCase":{"type":"object","required":["case_id","status","risk_decision","requires_review"],"description":"The compliance record for a third-party payout. In v1 the controls run BEFORE the order is\ncreated, so a payout that fails one is rejected with an error rather than returned as a held\norder — see the error codes in the Third-party payouts guide.\n","properties":{"case_id":{"type":"string","format":"uuid","description":"Identifier of the compliance record — the payout's `quote_id`, so a partner and a Unigox\noperator refer to the same record.\n"},"status":{"type":"string","enum":["authorized"],"description":"v1 emits `authorized`; a rejected payout returns an error instead."},"risk_decision":{"type":"string","enum":["allow"],"description":"v1 emits `allow`; a blocking decision surfaces as an error, not a status."},"requires_review":{"type":"boolean","description":"Always false in v1. Operator review happens Unigox-side over the same record."}}}}}}
```

## The PartnerOrderAmounts object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerOrderAmounts":{"type":"object","properties":{"crypto_amount":{"type":"string","description":"Total crypto amount (standard units) — the fee-exclusive gross: the buy/sell amount plus the\nplatform fee. Partner-fee-exclusive, except for a crypto-anchored onramp order (originally\nquoted with `crypto_amount`): there the amount was sized up so the delivered amount stays\nexact after the partner fee is withheld, so this field includes the markup. A crypto-anchored\nofframp order carves both fees out of the pinned deposit instead, so this field and\n`fee_breakdown.platform_fee` both shrink relative to a no-markup request, even though the\nmarkup itself stays out of this field. Every other case is unaffected — the markup is\nreported separately in `fee_breakdown.partner_fee`.\n\nOn-ramp — what the end user receives: `crypto_amount − fee_breakdown.platform_fee −\nfee_breakdown.partner_fee` for a fiat-anchored order, or exactly this `crypto_amount` for a\ncrypto-anchored order (both fees are withheld at bridge send-out without changing this\nfield). Off-ramp — what the partner funds at transfer authorization:\n`crypto_amount + fee_breakdown.partner_fee`.\n"},"fiat_amount":{"type":"string","description":"Fiat amount the user receives"},"crypto_currency":{"type":"string","description":"Cryptocurrency code"},"fiat_currency":{"type":"string","description":"Fiat currency code"},"rate":{"type":"string","description":"Crypto-to-fiat exchange rate"}}}}}}
```

## The FeeBreakdown object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}}}}}
```

## The PartnerOrderStatus object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerOrderStatus":{"type":"string","description":"Order status.\n\n**Off-ramp statuses (crypto → fiat):**\n- `created` — order created, quote locked\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_crypto_transfer_authorization` — partner must authorize crypto transfer via EIP-712 signature\n- `crypto_transfer_authorization_pending` — authorization submitted, awaiting on-chain confirmation\n- `crypto_received` — crypto locked in escrow\n- `fiat_payment_started` — buyer submitted fiat payment proof\n- `fiat_payment_review_started` — the proof is under review\n- `dispute_started` — a dispute was raised on the order\n- `awaiting_fiat_received_confirmation` — waiting for partner to confirm fiat receipt\n- `fiat_received_confirmed`, `crypto_release_pending` — timeline vocabulary. They appear in\n  `timeline[].status`; no order reports either as its own `status`, and filtering on them\n  returns nothing\n- `completed` — order fully completed\n- `cancelled` — order cancelled\n- `failed` — terminal error\n- `price_changed_requote_needed` — slippage exceeded at initiation. Like\n  `awaiting_liquidity_provider`, it is reported before a liquidity provider has accepted\n  the order, and `GET /partner/orders?status=` returns the orders that report it\n\n**Delayed settlement (T+1) statuses:**\n\n> Both are unreachable for an ordinary order.\n\n- `settlement_in_progress` — crypto release has started or is confirmed; the order is not\n  yet resolved. This alone does not mean a bank payment has been sent\n- `returned` — the payout went out and the bank sent it back, with no new payout\n  authorization. The crypto is not refunded yet: Unigox arranges another payout attempt, or\n  refunds the crypto and the order reads `cancelled`. A payout the provider cancelled before\n  sending it is not a return\n\nPrecedence on a delayed order, in this order — more than one mark can be set at once:\n\n1. `delayed_settlement_fiat_paid_to_customer_at` set → `completed`\n2. else `delayed_settlement_crypto_refunded_to_customer_at` set → `cancelled`\n3. else `delayed_settlement_fiat_returned_by_bank_at` set **and**\n   `delayed_settlement_fiat_payout_authorized_by_admin_at` `null` → `returned`\n4. else, on a release status → `settlement_in_progress`\n5. before the release, the ordinary mapping applies — a funded delayed order awaiting release is\n   `crypto_received` like any other, and `next_action` is what tells them apart\n\nA return with a fresh authorization on top reads as `settlement_in_progress` (step 4).\n\n**On-ramp statuses (fiat → crypto):**\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_vendor_escrow_funding` — vendor accepted, funding escrow with crypto\n- `awaiting_fiat_transfer` — crypto locked in escrow; the partner pays the vendor and confirms payment sent (`fiat_funding_source: vendor_details`), or the customer transfers into their own fiat account (`own_account`)\n- `fiat_transfer_pending` — fiat payment confirmed, awaiting vendor confirmation of receipt\n- `completed` — vendor confirmed fiat received, crypto released to end-user wallet\n- `cancelled` — order cancelled\n- `failed` — escrow error\n\n**On-ramp send-out statuses (optional post-trade cross-chain transfer):**\n\n> After an on-ramp order reaches `completed`, the partner may optionally initiate a\n> **send-out** — a cross-chain transfer of the received crypto to a destination network\n> (e.g. XAI → Arbitrum). This is an additional flow and does not affect the core trade lifecycle.\n> The `completed` status reflects that the trade itself is done; send-out statuses track\n> the subsequent cross-chain transfer only.\n\n- `send_out_pending` — send-out initiated, cross-chain transfer in progress\n- `send_out_completed` — cross-chain transfer successfully delivered to destination\n- `send_out_failed` — cross-chain transfer failed; the on-ramp trade itself remains completed\n","enum":["created","awaiting_liquidity_provider","awaiting_crypto_transfer_authorization","crypto_transfer_authorization_pending","crypto_received","fiat_payment_started","fiat_payment_review_started","dispute_started","awaiting_fiat_received_confirmation","fiat_received_confirmed","crypto_release_pending","awaiting_vendor_escrow_funding","awaiting_fiat_transfer","fiat_transfer_pending","completed","cancelled","failed","price_changed_requote_needed","settlement_in_progress","returned","send_out_pending","send_out_completed","send_out_failed"]}}}}
```

## The TimelineEntry object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"TimelineEntry":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"timestamp":{"type":"string","format":"date-time","description":"When this status was reached"},"description":{"type":"string","description":"Human-readable description of the status change.\n\nOn a **delayed settlement (T+1)** order the release entry reads\n`Crypto released to the liquidity provider, ahead of the payout` under\n`settlement_in_progress`, not `Order completed`: the crypto leaving escrow is the middle of\nthat order's story, not its end. Seven more entries follow it —\n`Crypto transferred to the payout provider`, `Fiat payout authorized`,\n`Fiat payout submitted by the provider` and\n`Fiat payout cancelled by the provider before it was sent` (all `settlement_in_progress`),\n`Fiat paid to the customer` (`completed`), `Fiat returned by the bank` (`returned`) and\n`Crypto refunded to the customer` (`cancelled`). An ordinary order's timeline is unchanged,\nentry for entry.\n\nConsecutive entries are collapsed by status; on a delayed order they are collapsed by status\n**and** description, so the intermediate facts that all carry `settlement_in_progress` each\nkeep their own line.\n\nOnce a payment has come back, or the payout provider cancelled it before sending it, and a\nnew attempt followed, every attempt stays on the timeline and the approval, sending, paid,\nreturn and cancellation entries end in `(attempt N)`, for example\n`Fiat payout authorized (attempt 2)` or `Fiat paid to the customer (attempt 2)`. With a\nsingle attempt there is no suffix. `Crypto transferred to the payout provider` is read from\nthe order's timestamp and leaves the timeline when that timestamp is cleared.\n"}}},"PartnerOrderStatus":{"type":"string","description":"Order status.\n\n**Off-ramp statuses (crypto → fiat):**\n- `created` — order created, quote locked\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_crypto_transfer_authorization` — partner must authorize crypto transfer via EIP-712 signature\n- `crypto_transfer_authorization_pending` — authorization submitted, awaiting on-chain confirmation\n- `crypto_received` — crypto locked in escrow\n- `fiat_payment_started` — buyer submitted fiat payment proof\n- `fiat_payment_review_started` — the proof is under review\n- `dispute_started` — a dispute was raised on the order\n- `awaiting_fiat_received_confirmation` — waiting for partner to confirm fiat receipt\n- `fiat_received_confirmed`, `crypto_release_pending` — timeline vocabulary. They appear in\n  `timeline[].status`; no order reports either as its own `status`, and filtering on them\n  returns nothing\n- `completed` — order fully completed\n- `cancelled` — order cancelled\n- `failed` — terminal error\n- `price_changed_requote_needed` — slippage exceeded at initiation. Like\n  `awaiting_liquidity_provider`, it is reported before a liquidity provider has accepted\n  the order, and `GET /partner/orders?status=` returns the orders that report it\n\n**Delayed settlement (T+1) statuses:**\n\n> Both are unreachable for an ordinary order.\n\n- `settlement_in_progress` — crypto release has started or is confirmed; the order is not\n  yet resolved. This alone does not mean a bank payment has been sent\n- `returned` — the payout went out and the bank sent it back, with no new payout\n  authorization. The crypto is not refunded yet: Unigox arranges another payout attempt, or\n  refunds the crypto and the order reads `cancelled`. A payout the provider cancelled before\n  sending it is not a return\n\nPrecedence on a delayed order, in this order — more than one mark can be set at once:\n\n1. `delayed_settlement_fiat_paid_to_customer_at` set → `completed`\n2. else `delayed_settlement_crypto_refunded_to_customer_at` set → `cancelled`\n3. else `delayed_settlement_fiat_returned_by_bank_at` set **and**\n   `delayed_settlement_fiat_payout_authorized_by_admin_at` `null` → `returned`\n4. else, on a release status → `settlement_in_progress`\n5. before the release, the ordinary mapping applies — a funded delayed order awaiting release is\n   `crypto_received` like any other, and `next_action` is what tells them apart\n\nA return with a fresh authorization on top reads as `settlement_in_progress` (step 4).\n\n**On-ramp statuses (fiat → crypto):**\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_vendor_escrow_funding` — vendor accepted, funding escrow with crypto\n- `awaiting_fiat_transfer` — crypto locked in escrow; the partner pays the vendor and confirms payment sent (`fiat_funding_source: vendor_details`), or the customer transfers into their own fiat account (`own_account`)\n- `fiat_transfer_pending` — fiat payment confirmed, awaiting vendor confirmation of receipt\n- `completed` — vendor confirmed fiat received, crypto released to end-user wallet\n- `cancelled` — order cancelled\n- `failed` — escrow error\n\n**On-ramp send-out statuses (optional post-trade cross-chain transfer):**\n\n> After an on-ramp order reaches `completed`, the partner may optionally initiate a\n> **send-out** — a cross-chain transfer of the received crypto to a destination network\n> (e.g. XAI → Arbitrum). This is an additional flow and does not affect the core trade lifecycle.\n> The `completed` status reflects that the trade itself is done; send-out statuses track\n> the subsequent cross-chain transfer only.\n\n- `send_out_pending` — send-out initiated, cross-chain transfer in progress\n- `send_out_completed` — cross-chain transfer successfully delivered to destination\n- `send_out_failed` — cross-chain transfer failed; the on-ramp trade itself remains completed\n","enum":["created","awaiting_liquidity_provider","awaiting_crypto_transfer_authorization","crypto_transfer_authorization_pending","crypto_received","fiat_payment_started","fiat_payment_review_started","dispute_started","awaiting_fiat_received_confirmation","fiat_received_confirmed","crypto_release_pending","awaiting_vendor_escrow_funding","awaiting_fiat_transfer","fiat_transfer_pending","completed","cancelled","failed","price_changed_requote_needed","settlement_in_progress","returned","send_out_pending","send_out_completed","send_out_failed"]}}}}
```

## The RegisterWebhookRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"RegisterWebhookRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"HTTPS URL that will receive webhook events"}}}}}}
```

## The WebhookConfigResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookConfigResponse":{"type":"object","properties":{"url":{"type":"string","nullable":true,"description":"Currently configured webhook URL (null if not set)"},"enabled":{"type":"boolean","description":"Whether webhook delivery is active"}}}}}}
```

## The WebhookTestPingResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookTestPingResponse":{"type":"object","properties":{"delivered":{"type":"boolean","description":"Whether the test event was delivered successfully"},"http_status":{"type":"integer","nullable":true,"description":"HTTP status code returned by the webhook endpoint; `null` when it did not answer"},"error":{"type":"string","description":"Present when `delivered` is `false`","enum":["webhook endpoint answered non-2xx","webhook endpoint unreachable"]}}}}}}
```

## The WebhookEventPayload object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookEventPayload":{"type":"object","description":"Signed partner webhook envelope. The data shape depends on event_type.","properties":{"event_id":{"type":"string","description":"Unique event identifier for de-duplication"},"event_type":{"type":"string","description":"Event type. `order.status.changed` for a status transition, `order.refund.required` for an\norder whose crypto is stuck in escrow awaiting your signature, `order.own_account_payout.updated`\nfor the onward payment of an off-ramp paid through the customer's own fiat account (see the\nWebhooks section).\n","enum":["order.status.changed","order.refund.required","order.own_account_payout.updated","user.kyc.updated","fiat_account.updated","fiat_account.deposit.received","fiat_account.payment.sent","fiat_account.payment.updated","business_customer.kyb.updated","wallet.linked","wallet.deposit.received","wallet.withdrawal.status.changed"]},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the event was created"},"data":{"anyOf":[{"$ref":"#/components/schemas/PartnerWalletLinkedData"},{"$ref":"#/components/schemas/PartnerWalletDepositData"},{"type":"object","properties":{"order_id":{"type":"string","format":"uuid","description":"Partner order UUID"},"status":{"$ref":"#/components/schemas/PartnerOrderStatus"},"user_id":{"type":"string","format":"uuid","description":"`user_id` is the customer's `user_uuid` (from user creation)."},"crypto_amount":{"type":"string","description":"Total crypto amount including the platform fee. Partner-fee-exclusive, except for a\ncrypto-anchored onramp order: there the amount was sized up so the delivered amount\nstays exact after the partner fee is withheld, so this field includes the markup.\nEvery other case keeps the markup out — it's reported separately in `partner_fee`.\nFormatted with the shortest round-tripping representation (e.g. `\"101.5\"`, not\n`\"101.500000\"`) — parse it as a decimal, don't compare strings.\n"},"crypto_currency":{"type":"string","description":"Cryptocurrency code"},"partner_fee":{"type":"string","description":"Partner markup in crypto for this order (`\"0\"` when none was declared). Unlike\n`fee_breakdown.partner_fee` in the REST responses (which is padded to the token's\ndecimals), this field is formatted with the shortest round-tripping representation —\n`1.0` reports as `\"1\"`, not `\"1.00\"`. Parse it as a decimal, don't compare strings.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Partner markup percentage declared for this order (`1` means 1%; 0 when none)"},"fiat_amount":{"type":"string","description":"Fiat amount"},"fiat_currency":{"type":"string","description":"Fiat currency code"},"provider":{"type":"string","description":"Liquidity provider type","enum":["p2p","licensed"]},"payment_details_id":{"type":"string","description":"Payment details ID used for the order, as a string. An empty string (`\"\"`) when the order has none: on a third-party payout, which is routed by `recipient_destination_id`, it is always `\"\"`. On an order with `payout_via_own_account: true` it is the payment details you named, the bank the money is sent on to."},"payment_deadline_at":{"type":"string","format":"date-time","description":"`order.status.changed` for an on-ramp at `awaiting_fiat_transfer`: the same `payment_deadline_at` as the order. Omitted on every other event."},"payout_via_own_account":{"type":"boolean","description":"`true` on a partner API off-ramp paid through the customer's own fiat account: the provider pays the customer's account and Unigox sends the money on to the bank you named. Omitted on every other order, never `false`."},"own_account_payout_status":{"type":"string","enum":["awaiting_credit","in_progress","sent_to_bank","under_review","held","left_on_account"],"description":"`order.own_account_payout.updated` only: the state the onward payment reached (`sent_to_bank`, `held`, `under_review` or `left_on_account`)."},"user_uuid":{"type":"string","format":"uuid","description":"The customer's public UUID, on `order.own_account_payout.updated` and the fiat account events."},"fiat_account_id":{"type":"string","format":"uuid","description":"`order.own_account_payout.updated` and the fiat account events: the customer's fiat account. On `order.own_account_payout.updated` omitted when the account is not one you can address by id."},"amount":{"type":"string","description":"`order.own_account_payout.updated` and `fiat_account.deposit.received`: the fiat amount, as a decimal string with at least two decimals."},"currency":{"type":"string","description":"`order.own_account_payout.updated` and the fiat account events: the fiat currency code."},"delayed_settlement":{"type":"boolean","description":"**Delayed settlement (T+1) only.** Omitted entirely on any other order —\n`delayed_settlement` is `true` or absent, never `false`.\n\nEvery T+1 field here is omitted until it has a value. `delayed_settlement` and\n`settlement_hours` are on every `order.status.changed` event of a delayed order,\nincluding the ones before the release; `payout_deadline_at` from the release onwards\n(the release sends two `settlement_in_progress` events: one when it starts, without\n`payout_deadline_at`, and one when it is confirmed, with it);\nand each `delayed_settlement_*_at` timestamp while currently set. A bank return clears\nauthorization, submission and paid timestamps, the payout provider's cancellation of a\npayment it had not sent clears the authorization, and a withdrawn record of the crypto at\nthe payout provider, or a crypto refund after a return, clears that one, so later events\ncan omit earlier fields.\nAn absent key means not currently set (never recorded or cleared); nulls are omitted.\nRe-read the order to reconcile state. Deduplicate deliveries by event_id, not order_id.\n"},"settlement_hours":{"type":"integer","description":"The expected payout window, counted from the release: the licensed partner's target, not a guaranteed deadline. Rounded to the nearest whole hour and never below `1`."},"payout_deadline_at":{"type":"string","format":"date-time","description":"Release plus the expected window: when the payment is expected by, not a deadline. Absent until the crypto has left escrow."},"delayed_settlement_crypto_sent_to_provider_at":{"type":"string","format":"date-time","description":"The crypto left the licensed partner's wallet for the payout provider. No refund of the crypto is possible while it is set. Absent until it happens, and absent again if Unigox withdraws a record made by mistake or refunds the crypto after a returned payment."},"delayed_settlement_fiat_payout_authorized_by_admin_at":{"type":"string","format":"date-time","description":"Unigox authorized the licensed partner to send the bank payment. Absent until it happens. When the authorization also records the crypto reaching the payout provider, one event carries both. Absent again after a bank return, or after the payout provider cancelled the payment before sending it (that event keeps the order's status)."},"delayed_settlement_fiat_payout_submitted_by_provider_at":{"type":"string","format":"date-time","description":"Submission of the bank payment was recorded; recipient payment is not yet confirmed. Absent until it happens."},"delayed_settlement_fiat_paid_to_customer_at":{"type":"string","format":"date-time","description":"The fiat reached the recipient — the real completion of a delayed order. Absent until it happens."},"delayed_settlement_fiat_returned_by_bank_at":{"type":"string","format":"date-time","description":"The payout went out and the bank sent it back; the paid, submitted and authorized marks are cleared in the same statement, and Unigox then pays again or refunds the crypto. Absent until it happens."},"delayed_settlement_crypto_refunded_to_customer_at":{"type":"string","format":"date-time","description":"The crypto went back to the wallet that funded the escrow (yours, on an order whose crypto you hold) instead of being paid out, before it reached the payout provider or after a returned payment. Absent until it happens."}}}]}}},"PartnerWalletLinkedData":{"type":"object","required":["user_uuid","address","linked_at"],"description":"Data for wallet.linked, delivered in the signed partner webhook envelope.","properties":{"user_uuid":{"type":"string","format":"uuid","description":"Customer belonging to the receiving partner."},"address":{"type":"string","description":"Linked EVM address."},"linked_at":{"type":"string","format":"date-time","description":"UTC time at which the address was linked."}}},"PartnerWalletDepositData":{"type":"object","required":["deposit_id","user_uuid","address","chain_id","crypto_currency","token_address","amount","amount_atomic","source_chain_id","source_tx_hash","tx_hash","credited_at"],"description":"Data for wallet.deposit.received in the signed partner webhook envelope. Identifies a\ncompleted bridge credit to the customer's linked XAI wallet. Does not include a memo,\nmemo-lock ID or collection address. Amounts are strings and describe the XAI credit.\n","properties":{"deposit_id":{"type":"string","description":"Stable credited-payment identifier. Treat as opaque; deduplicate within your partner account and environment."},"user_uuid":{"type":"string","format":"uuid","description":"Customer belonging to the receiving partner."},"address":{"type":"string","description":"Linked customer wallet credited on XAI."},"chain_id":{"type":"string","enum":["660279"],"description":"XAI settlement chain ID as a decimal string."},"crypto_currency":{"type":"string","description":"Credited token symbol."},"token_address":{"type":"string","description":"Credited token's contract address on XAI."},"amount":{"type":"string","description":"Credited amount in whole-token units as a decimal string."},"amount_atomic":{"type":"string","description":"Same credited amount in the token's smallest units, as an integer string."},"source_chain_id":{"type":"string","description":"Source chain ID as a decimal string; empty if absent from the payment record."},"source_tx_hash":{"type":"string","description":"Source transaction identifier; empty if absent from the payment record."},"tx_hash":{"type":"string","description":"XAI settlement transaction hash; empty if absent from the payment record."},"credited_at":{"type":"string","format":"date-time","description":"UTC time the XAI settlement transaction was mined."}}},"PartnerOrderStatus":{"type":"string","description":"Order status.\n\n**Off-ramp statuses (crypto → fiat):**\n- `created` — order created, quote locked\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_crypto_transfer_authorization` — partner must authorize crypto transfer via EIP-712 signature\n- `crypto_transfer_authorization_pending` — authorization submitted, awaiting on-chain confirmation\n- `crypto_received` — crypto locked in escrow\n- `fiat_payment_started` — buyer submitted fiat payment proof\n- `fiat_payment_review_started` — the proof is under review\n- `dispute_started` — a dispute was raised on the order\n- `awaiting_fiat_received_confirmation` — waiting for partner to confirm fiat receipt\n- `fiat_received_confirmed`, `crypto_release_pending` — timeline vocabulary. They appear in\n  `timeline[].status`; no order reports either as its own `status`, and filtering on them\n  returns nothing\n- `completed` — order fully completed\n- `cancelled` — order cancelled\n- `failed` — terminal error\n- `price_changed_requote_needed` — slippage exceeded at initiation. Like\n  `awaiting_liquidity_provider`, it is reported before a liquidity provider has accepted\n  the order, and `GET /partner/orders?status=` returns the orders that report it\n\n**Delayed settlement (T+1) statuses:**\n\n> Both are unreachable for an ordinary order.\n\n- `settlement_in_progress` — crypto release has started or is confirmed; the order is not\n  yet resolved. This alone does not mean a bank payment has been sent\n- `returned` — the payout went out and the bank sent it back, with no new payout\n  authorization. The crypto is not refunded yet: Unigox arranges another payout attempt, or\n  refunds the crypto and the order reads `cancelled`. A payout the provider cancelled before\n  sending it is not a return\n\nPrecedence on a delayed order, in this order — more than one mark can be set at once:\n\n1. `delayed_settlement_fiat_paid_to_customer_at` set → `completed`\n2. else `delayed_settlement_crypto_refunded_to_customer_at` set → `cancelled`\n3. else `delayed_settlement_fiat_returned_by_bank_at` set **and**\n   `delayed_settlement_fiat_payout_authorized_by_admin_at` `null` → `returned`\n4. else, on a release status → `settlement_in_progress`\n5. before the release, the ordinary mapping applies — a funded delayed order awaiting release is\n   `crypto_received` like any other, and `next_action` is what tells them apart\n\nA return with a fresh authorization on top reads as `settlement_in_progress` (step 4).\n\n**On-ramp statuses (fiat → crypto):**\n- `awaiting_liquidity_provider` — order initiated, waiting for vendor acceptance\n- `awaiting_vendor_escrow_funding` — vendor accepted, funding escrow with crypto\n- `awaiting_fiat_transfer` — crypto locked in escrow; the partner pays the vendor and confirms payment sent (`fiat_funding_source: vendor_details`), or the customer transfers into their own fiat account (`own_account`)\n- `fiat_transfer_pending` — fiat payment confirmed, awaiting vendor confirmation of receipt\n- `completed` — vendor confirmed fiat received, crypto released to end-user wallet\n- `cancelled` — order cancelled\n- `failed` — escrow error\n\n**On-ramp send-out statuses (optional post-trade cross-chain transfer):**\n\n> After an on-ramp order reaches `completed`, the partner may optionally initiate a\n> **send-out** — a cross-chain transfer of the received crypto to a destination network\n> (e.g. XAI → Arbitrum). This is an additional flow and does not affect the core trade lifecycle.\n> The `completed` status reflects that the trade itself is done; send-out statuses track\n> the subsequent cross-chain transfer only.\n\n- `send_out_pending` — send-out initiated, cross-chain transfer in progress\n- `send_out_completed` — cross-chain transfer successfully delivered to destination\n- `send_out_failed` — cross-chain transfer failed; the on-ramp trade itself remains completed\n","enum":["created","awaiting_liquidity_provider","awaiting_crypto_transfer_authorization","crypto_transfer_authorization_pending","crypto_received","fiat_payment_started","fiat_payment_review_started","dispute_started","awaiting_fiat_received_confirmation","fiat_received_confirmed","crypto_release_pending","awaiting_vendor_escrow_funding","awaiting_fiat_transfer","fiat_transfer_pending","completed","cancelled","failed","price_changed_requote_needed","settlement_in_progress","returned","send_out_pending","send_out_completed","send_out_failed"]}}}}
```

## The PartnerOnRampQuoteRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerOnRampQuoteRequest":{"type":"object","required":["user_uuid","fiat_currency","crypto_currency"],"oneOf":[{"required":["fiat_amount"]},{"required":["crypto_amount"]}],"properties":{"user_uuid":{"type":"string","format":"uuid","description":"Public UUID of the end-user (returned by `POST /partner/users` as `id`)"},"fiat_amount":{"type":"string","description":"Fiat amount the end-user will send. Provide exactly one of fiat_amount or crypto_amount."},"crypto_amount":{"type":"string","description":"Crypto amount to receive. Provide exactly one of fiat_amount or crypto_amount."},"fiat_currency":{"type":"string","description":"Source fiat currency code (ISO 4217)"},"crypto_currency":{"type":"string","description":"Target cryptocurrency code (e.g., USDT, USDC)"},"payment_method_slug":{"type":"string","description":"Optional payment method slug to narrow routing"},"payment_network_slug":{"type":"string","description":"Optional payment network slug to narrow routing"},"provider_scope":{"type":"string","description":"Optional provider scope filter; defaults to all","enum":["all","licensed_only","p2p_only"]},"country_code":{"type":"string","description":"Optional ISO 2-letter country code for fee/routing context"},"partner_fee_pct":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"Optional per-order markup you charge your end user, applied on the same crypto base\nas the platform fee (non-compounding). Percent units: `1` means 1%. Omitting the field\nfrom this request payload — or sending `0` — means no markup; the markup cannot be\nnegative. Fiat-anchored offramp orders have no cap — the deposit grows to cover the\nmarkup. Every other case hits a formula domain bound, not a business cap: onramp\nrejects `partner_fee_pct >= 100` (the withheld or grossed-up fee would consume the\nentire buyer amount, leaving nothing delivered); crypto-anchored offramp rejects it\nwhen the fee would consume the entire pinned deposit.\n\nNote: you send this value as a JSON **string**, but it round-trips as a JSON **number**\nin `fee_breakdown.partner_fee_pct` and in the webhook `data.partner_fee_pct` field —\ndon't parse those as strings.\n\n**Rejection reference:**\n\n| Rejection | `error.code` | HTTP status |\n|---|---|---|\n| `partner_fee_pct` is non-numeric, negative, `NaN`, or `Inf` | `INVALID_REQUEST` | 400 |\n| Onramp: fee would consume the entire buyer amount (`partner_fee_pct >= 100`) | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: fee would consume the entire pinned deposit | `INVALID_REQUEST` | 400 |\n| Fiat-anchored offramp: the computed fee is not a finite amount | `INVALID_REQUEST` | 400 |\n| Crypto-anchored offramp: the carved fee-exclusive gross falls outside the matched offer's min/max | `NO_OFFERS_AVAILABLE` | 409 |\n","default":"0"}}}}}}
```

## The PartnerOnRampQuoteResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerOnRampQuoteResponse":{"type":"object","properties":{"quote_id":{"type":"string","format":"uuid","description":"Unique quote identifier — use this to initiate the order"},"rate":{"type":"string","description":"Fiat-to-crypto exchange rate (fiat units per 1 crypto unit)"},"crypto_amount":{"type":"string","description":"Total crypto amount for the order — the end-user's amount plus the platform fee.\nPartner-fee-exclusive on a fiat-anchored quote (request declared `fiat_amount`): the markup\nis reported separately in `fee_breakdown.partner_fee` and is not added here — the end user\nreceives `crypto_amount − fee_breakdown.platform_fee − fee_breakdown.partner_fee`, withheld\nfrom this amount at bridge send-out. On a crypto-anchored quote (request declared\n`crypto_amount`), the trade is sized up so this field includes the markup, and the end user\nreceives exactly the requested `crypto_amount`, unchanged by the markup.\n"},"fiat_amount":{"type":"string","description":"Fiat amount the end-user sends"},"fee_breakdown":{"$ref":"#/components/schemas/FeeBreakdown"},"payment_method_slug":{"type":"string","description":"Matched payment method slug used for this quote"},"payment_network_slug":{"type":"string","description":"Matched payment network slug used for this quote"},"expires_at":{"type":"string","format":"date-time","description":"Quote expiration timestamp (60 seconds from creation)"}}},"FeeBreakdown":{"type":"object","description":"Transparent breakdown of all fee components (amounts in crypto)","properties":{"platform_fee":{"type":"string","description":"Platform fee in crypto"},"platform_fee_pct":{"type":"number","format":"double","description":"Platform fee as a percentage"},"partner_fee":{"type":"string","description":"Your markup in crypto, computed from the `partner_fee_pct` you declared on the\nquote/estimate request, on the same base as the platform fee. `0` when no markup was declared.\n"},"partner_fee_pct":{"type":"number","format":"double","description":"Your markup percentage as declared on the request (`1` means 1%); `0` when none."},"total_fee":{"type":"string","description":"Total fee in crypto (platform_fee + partner_fee)"},"fiat_rail_fee":{"type":"string","description":"What the payout rail itself charges, in the order's **fiat** currency — every field above\nis in crypto. It is the gap between `rate × crypto_amount` and the money that actually\nmoves on the bank or wallet rail, and it is already reflected in `fiat_amount`.\n\nDeliberately **not** summed into `total_fee`: that is a crypto figure, and adding a fiat\namount to it would produce a number that means nothing. Reconciling a payout, add this to\n`fiat_amount` to get the gross the rate implies.\n\nAlways present; `\"0.00\"` on a rail that charges nothing.\n"},"fiat_rail_fee_currency":{"type":"string","description":"The currency `fiat_rail_fee` is denominated in, so a breakdown read on its own is never ambiguous about which of the order's two currencies a fee is in. Omitted when there is no rail fee to denominate."},"payout_base_rate":{"type":"string","description":"Optional on payout estimates and quotes. The conversion rate before the licensed partner's costs and margin, in fiat per crypto, when that licensed partner publishes it, for instant and T+1 offers. It lets you show the recipient amount and one combined fee without charging the fee twice: divide `fiat_amount` by this rate and round half up to the crypto's precision; the rest of `crypto_amount` is the combined fee. A separate partner markup stays separate. Omitted when the rate is not known or is out of date; its absence does not mean there is no margin. This is not the all-in rate; that is `rate`."}}}}}}
```

## The SubmitPayerDetailsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"SubmitPayerDetailsRequest":{"type":"object","description":"Submit the payer's payment details for a `payment_request` on-ramp order.\nProvide exactly one of `payment_details_id` (saved profile) or `payment_details` (inline object).\n","oneOf":[{"required":["payment_details_id"],"properties":{"payment_details_id":{"type":"integer","format":"int64","description":"ID of a previously saved payment profile for the end-user"}}},{"required":["payment_details"],"properties":{"payment_details":{"type":"object","required":["payment_method_id","payment_network_id","details"],"properties":{"payment_method_id":{"type":"integer","format":"int64","description":"Payment method ID"},"payment_network_id":{"type":"integer","format":"int64","description":"Payment network ID"},"details":{"type":"object","description":"Payer's account details (fields depend on payment method)","additionalProperties":true},"country_code":{"type":"string","description":"Optional ISO 2-letter country code"}}}}}]}}}}
```

## The BusinessCustomer object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessCustomer":{"type":"object","description":"A company you onboarded through KYB, and where its KYB stands.","properties":{"id":{"type":"string","description":"The business customer id. Every route below takes it."},"reference":{"type":"string"},"status":{"type":"string","description":"The KYB status. Accounts can be issued once it is `approved`.","enum":["not_started","in_progress","submitted","automated_review","manual_review","additional_information_required","resubmitted","approved","rejected"]},"can_open_accounts":{"type":"boolean","description":"`true` when the KYB is approved."},"kyb_type":{"type":"string","enum":["standard","extended"]},"action_owner":{"type":"string","description":"Who the case is waiting on."},"action_type":{"type":"string"},"action_reason":{"type":"string"},"external_ref":{"type":"string","description":"Your own reference, as sent on create."},"company":{"type":"object","properties":{"legal_name":{"type":"string"},"trade_name":{"type":"string"},"country_of_incorporation":{"type":"string"},"registration_number":{"type":"string"},"email":{"type":"string"}}},"invitation_status":{"type":"string"},"invitation_expires_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"decided_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completeness_percent":{"type":"number","description":"How much of the questionnaire is filled in. Present on the single read."},"information_requests":{"type":"array","description":"What the company still has to provide. Present on the single read.","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"note":{"type":"string"},"deadline":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"}}}},"identity_verifications":{"type":"array","description":"Each person's identity check. Present on the single read.","items":{"type":"object","properties":{"person_id":{"type":"string"},"full_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"ownership_percent":{"type":"number","nullable":true},"status":{"type":"string"},"verification_url":{"type":"string","description":"The person's own identity-check link, to resend if they lost it."},"initiated_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}}}}}}}}
```

## The BusinessCustomerCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessCustomerCreateRequest":{"type":"object","required":["representative_email"],"properties":{"legal_name":{"type":"string"},"trade_name":{"type":"string"},"country_of_incorporation":{"type":"string","description":"ISO 3166-1 alpha-2."},"registration_number":{"type":"string"},"incorporation_date":{"type":"string","format":"date"},"representative_email":{"type":"string","format":"email","description":"The link is emailed here, and only this person can open it."},"external_ref":{"type":"string","maxLength":128,"description":"Your own reference for this company."},"kyb_type":{"type":"string","enum":["standard","extended"]},"invitation_expiry_days":{"type":"integer","minimum":1,"maximum":90,"description":"How long the onboarding link stays valid. Left out, the link does not expire."}}}}}}
```

## The BusinessOnboardingLink object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessOnboardingLink":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":"Null when the link does not expire."}}}}}}
```

## The BusinessCustomerListResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessCustomerListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"business_customers":{"type":"array","items":{"$ref":"#/components/schemas/BusinessCustomer"}},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"has_more":{"type":"boolean"}}}}},"BusinessCustomer":{"type":"object","description":"A company you onboarded through KYB, and where its KYB stands.","properties":{"id":{"type":"string","description":"The business customer id. Every route below takes it."},"reference":{"type":"string"},"status":{"type":"string","description":"The KYB status. Accounts can be issued once it is `approved`.","enum":["not_started","in_progress","submitted","automated_review","manual_review","additional_information_required","resubmitted","approved","rejected"]},"can_open_accounts":{"type":"boolean","description":"`true` when the KYB is approved."},"kyb_type":{"type":"string","enum":["standard","extended"]},"action_owner":{"type":"string","description":"Who the case is waiting on."},"action_type":{"type":"string"},"action_reason":{"type":"string"},"external_ref":{"type":"string","description":"Your own reference, as sent on create."},"company":{"type":"object","properties":{"legal_name":{"type":"string"},"trade_name":{"type":"string"},"country_of_incorporation":{"type":"string"},"registration_number":{"type":"string"},"email":{"type":"string"}}},"invitation_status":{"type":"string"},"invitation_expires_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"decided_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completeness_percent":{"type":"number","description":"How much of the questionnaire is filled in. Present on the single read."},"information_requests":{"type":"array","description":"What the company still has to provide. Present on the single read.","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"note":{"type":"string"},"deadline":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"}}}},"identity_verifications":{"type":"array","description":"Each person's identity check. Present on the single read.","items":{"type":"object","properties":{"person_id":{"type":"string"},"full_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"ownership_percent":{"type":"number","nullable":true},"status":{"type":"string"},"verification_url":{"type":"string","description":"The person's own identity-check link, to resend if they lost it."},"initiated_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}}}}}}}}
```

## The BusinessCustomerResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessCustomerResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"business_customer":{"$ref":"#/components/schemas/BusinessCustomer"}}}}},"BusinessCustomer":{"type":"object","description":"A company you onboarded through KYB, and where its KYB stands.","properties":{"id":{"type":"string","description":"The business customer id. Every route below takes it."},"reference":{"type":"string"},"status":{"type":"string","description":"The KYB status. Accounts can be issued once it is `approved`.","enum":["not_started","in_progress","submitted","automated_review","manual_review","additional_information_required","resubmitted","approved","rejected"]},"can_open_accounts":{"type":"boolean","description":"`true` when the KYB is approved."},"kyb_type":{"type":"string","enum":["standard","extended"]},"action_owner":{"type":"string","description":"Who the case is waiting on."},"action_type":{"type":"string"},"action_reason":{"type":"string"},"external_ref":{"type":"string","description":"Your own reference, as sent on create."},"company":{"type":"object","properties":{"legal_name":{"type":"string"},"trade_name":{"type":"string"},"country_of_incorporation":{"type":"string"},"registration_number":{"type":"string"},"email":{"type":"string"}}},"invitation_status":{"type":"string"},"invitation_expires_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"decided_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completeness_percent":{"type":"number","description":"How much of the questionnaire is filled in. Present on the single read."},"information_requests":{"type":"array","description":"What the company still has to provide. Present on the single read.","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"note":{"type":"string"},"deadline":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"}}}},"identity_verifications":{"type":"array","description":"Each person's identity check. Present on the single read.","items":{"type":"object","properties":{"person_id":{"type":"string"},"full_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"ownership_percent":{"type":"number","nullable":true},"status":{"type":"string"},"verification_url":{"type":"string","description":"The person's own identity-check link, to resend if they lost it."},"initiated_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}}}}}}}}
```

## The BusinessCustomerCreateResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessCustomerCreateResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"business_customer":{"$ref":"#/components/schemas/BusinessCustomer"},"onboarding_link":{"$ref":"#/components/schemas/BusinessOnboardingLink"}}}}},"BusinessCustomer":{"type":"object","description":"A company you onboarded through KYB, and where its KYB stands.","properties":{"id":{"type":"string","description":"The business customer id. Every route below takes it."},"reference":{"type":"string"},"status":{"type":"string","description":"The KYB status. Accounts can be issued once it is `approved`.","enum":["not_started","in_progress","submitted","automated_review","manual_review","additional_information_required","resubmitted","approved","rejected"]},"can_open_accounts":{"type":"boolean","description":"`true` when the KYB is approved."},"kyb_type":{"type":"string","enum":["standard","extended"]},"action_owner":{"type":"string","description":"Who the case is waiting on."},"action_type":{"type":"string"},"action_reason":{"type":"string"},"external_ref":{"type":"string","description":"Your own reference, as sent on create."},"company":{"type":"object","properties":{"legal_name":{"type":"string"},"trade_name":{"type":"string"},"country_of_incorporation":{"type":"string"},"registration_number":{"type":"string"},"email":{"type":"string"}}},"invitation_status":{"type":"string"},"invitation_expires_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"decided_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"completeness_percent":{"type":"number","description":"How much of the questionnaire is filled in. Present on the single read."},"information_requests":{"type":"array","description":"What the company still has to provide. Present on the single read.","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"note":{"type":"string"},"deadline":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"}}}},"identity_verifications":{"type":"array","description":"Each person's identity check. Present on the single read.","items":{"type":"object","properties":{"person_id":{"type":"string"},"full_name":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"ownership_percent":{"type":"number","nullable":true},"status":{"type":"string"},"verification_url":{"type":"string","description":"The person's own identity-check link, to resend if they lost it."},"initiated_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}}}}},"BusinessOnboardingLink":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":"Null when the link does not expire."}}}}}}
```

## The BusinessOnboardingLinkResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessOnboardingLinkResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"onboarding_link":{"$ref":"#/components/schemas/BusinessOnboardingLink"}}}}},"BusinessOnboardingLink":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":"Null when the link does not expire."}}}}}}
```

## The BusinessFiatAccount object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessFiatAccount":{"type":"object","properties":{"id":{"type":"string","description":"The account id, `business_<n>`."},"holder_type":{"type":"string","enum":["business"]},"business_customer_id":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["active","closed"]},"holder_name":{"type":"string","description":"The company the account was issued for."},"bank_holder_name":{"type":"string","description":"The holder name the bank has on file, which payers see. Can differ from `holder_name`."},"bank_name":{"type":"string"},"iban":{"type":"string"},"account_number":{"type":"string"},"sort_code":{"type":"string"},"bic":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}},"balance_known":{"type":"boolean","description":"`false` when the bank could not be read just now; `balances` is then empty, not zero."},"details_live":{"type":"boolean","description":"`false` when the bank details could not be read just now and only stored fields are shown."},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The BusinessFiatAccountCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessFiatAccountCreateRequest":{"type":"object","required":["currency"],"properties":{"currency":{"type":"string"},"issuer_country":{"type":"string","description":"ISO 3166-1 alpha-2 jurisdiction to issue in. Defaults per currency."},"allow_duplicate":{"type":"boolean","description":"Open a second account in a currency the company already holds."}}}}}}
```

## The BusinessFiatAccountListResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessFiatAccountListResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"fiat_accounts":{"type":"array","items":{"$ref":"#/components/schemas/BusinessFiatAccount"}}}}}},"BusinessFiatAccount":{"type":"object","properties":{"id":{"type":"string","description":"The account id, `business_<n>`."},"holder_type":{"type":"string","enum":["business"]},"business_customer_id":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["active","closed"]},"holder_name":{"type":"string","description":"The company the account was issued for."},"bank_holder_name":{"type":"string","description":"The holder name the bank has on file, which payers see. Can differ from `holder_name`."},"bank_name":{"type":"string"},"iban":{"type":"string"},"account_number":{"type":"string"},"sort_code":{"type":"string"},"bic":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}},"balance_known":{"type":"boolean","description":"`false` when the bank could not be read just now; `balances` is then empty, not zero."},"details_live":{"type":"boolean","description":"`false` when the bank details could not be read just now and only stored fields are shown."},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The BusinessFiatAccountResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessFiatAccountResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"fiat_account":{"$ref":"#/components/schemas/BusinessFiatAccount"},"currency_mismatch":{"type":"boolean","description":"On issue only. The bank opened the account in a different currency than asked."}}}}},"BusinessFiatAccount":{"type":"object","properties":{"id":{"type":"string","description":"The account id, `business_<n>`."},"holder_type":{"type":"string","enum":["business"]},"business_customer_id":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["active","closed"]},"holder_name":{"type":"string","description":"The company the account was issued for."},"bank_holder_name":{"type":"string","description":"The holder name the bank has on file, which payers see. Can differ from `holder_name`."},"bank_name":{"type":"string"},"iban":{"type":"string"},"account_number":{"type":"string"},"sort_code":{"type":"string"},"bic":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}},"balance_known":{"type":"boolean","description":"`false` when the bank could not be read just now; `balances` is then empty, not zero."},"details_live":{"type":"boolean","description":"`false` when the bank details could not be read just now and only stored fields are shown."},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The OperatingBalanceLine object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"OperatingBalanceLine":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string","description":"Decimal string. What can be spent now."}}}}}}
```

## The OperatingAccountResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"OperatingAccountResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"operating_account":{"type":"object","properties":{"fiat_balances":{"type":"array","items":{"$ref":"#/components/schemas/OperatingBalanceLine"}},"crypto_balances":{"type":"array","items":{"$ref":"#/components/schemas/OperatingBalanceLine"}}}}}}}},"OperatingBalanceLine":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string","description":"Decimal string. What can be spent now."}}}}}}
```

## The BusinessLedgerResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessLedgerResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["bank_transfer","conversion","internal_transfer","crypto_transfer","fee","other"]},"amount":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"balance_after":{"type":"string"},"counterparty_name":{"type":"string"},"counterparty_iban":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}},"page":{"type":"integer"},"has_more":{"type":"boolean"}}}}}}}}
```

## The BusinessPaymentsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessPaymentsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["incoming","outgoing","other"]},"amount":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"rail":{"type":"string"},"counterparty_name":{"type":"string"},"counterparty_iban":{"type":"string"},"counterparty_bic":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"page":{"type":"integer"},"has_more":{"type":"boolean"}}}}}}}}
```

## The BusinessTransferRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessTransferRequest":{"type":"object","properties":{"amount":{"type":"string","description":"Decimal string. Leave out to move the whole available balance in `currency`."},"currency":{"type":"string"}}}}}}
```

## The BusinessFundRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessFundRequest":{"type":"object","required":["amount"],"properties":{"amount":{"type":"string","description":"Decimal string."},"currency":{"type":"string"},"description":{"type":"string","description":"The reference the bank records."}}}}}}
```

## The BusinessTransferResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"BusinessTransferResponse":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"transfer":{"type":"object","properties":{"fiat_account_id":{"type":"string"},"direction":{"type":"string","enum":["to_partner","from_partner"]},"amount":{"type":"string"},"currency":{"type":"string"},"status":{"type":"string","enum":["completed"]},"replayed":{"type":"boolean","description":"`true` when this answer came from an earlier request with the same key."},"idempotency_key":{"type":"string"}}}}}}}}}}
```

## The WebhookTestRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookTestRequest":{"type":"object","description":"Optional body of `POST /api/v1/partner/webhooks/test`. Omit it to send `ping`.","properties":{"event_type":{"type":"string","enum":["ping","order.status.changed","fiat_account.deposit.received","fiat_account.payment.sent","fiat_account.payment.updated","business_customer.kyb.updated"],"description":"The event to send a sample of. Empty or omitted is `ping`."},"holder_type":{"type":"string","enum":["retail","business"],"description":"For `fiat_account.deposit.received` only: the retail (default) or business account\nsample. `business` is also accepted for the `fiat_account.payment.*` events, which\nexist only on business accounts.\n"}}}}}}
```

## The WebhookEvent object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookEvent":{"type":"object","description":"One event as it was signed and sent (`event_id`, `event_type`, `created_at`, `data`), with\n`delivery` added. `data` is the event's own payload; see each event type.\n","properties":{"event_id":{"type":"string"},"event_type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"data":{"type":"object","additionalProperties":true},"delivery":{"$ref":"#/components/schemas/WebhookEventDelivery"}}},"WebhookEventDelivery":{"type":"object","description":"How the delivery of one event stands.","properties":{"status":{"type":"string","enum":["pending","in_progress","delivered","failed"],"description":"`pending`: waiting for its (next) attempt. `in_progress`: being sent now.\n`delivered`: your endpoint answered 2xx. `failed`: no more attempts, or never sent\n(see `failure_reason`).\n"},"attempts":{"type":"integer","description":"Delivery attempts made so far (reset to 0 by redeliver)."},"delivered_at":{"type":"string","format":"date-time","nullable":true,"description":"When your endpoint last accepted it."},"last_http_status":{"type":"integer","nullable":true,"description":"Your endpoint's HTTP status on the last attempt; null when there was no answer."},"failure_reason":{"type":"string","nullable":true,"enum":["webhook_disabled","webhook_url_not_set","http_error","network_error","delivery_failed",null],"description":"Why the last attempt did not succeed. `webhook_disabled` / `webhook_url_not_set`: the\nevent was never sent because of your webhook settings. `http_error`: your endpoint\nanswered non-2xx (see `last_http_status`). `network_error`: no answer (connect, TLS,\ntimeout). Null when delivered, or when requeued and not yet attempted.\n"}}}}}}
```

## The WebhookEventDelivery object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookEventDelivery":{"type":"object","description":"How the delivery of one event stands.","properties":{"status":{"type":"string","enum":["pending","in_progress","delivered","failed"],"description":"`pending`: waiting for its (next) attempt. `in_progress`: being sent now.\n`delivered`: your endpoint answered 2xx. `failed`: no more attempts, or never sent\n(see `failure_reason`).\n"},"attempts":{"type":"integer","description":"Delivery attempts made so far (reset to 0 by redeliver)."},"delivered_at":{"type":"string","format":"date-time","nullable":true,"description":"When your endpoint last accepted it."},"last_http_status":{"type":"integer","nullable":true,"description":"Your endpoint's HTTP status on the last attempt; null when there was no answer."},"failure_reason":{"type":"string","nullable":true,"enum":["webhook_disabled","webhook_url_not_set","http_error","network_error","delivery_failed",null],"description":"Why the last attempt did not succeed. `webhook_disabled` / `webhook_url_not_set`: the\nevent was never sent because of your webhook settings. `http_error`: your endpoint\nanswered non-2xx (see `last_http_status`). `network_error`: no answer (connect, TLS,\ntimeout). Null when delivered, or when requeued and not yet attempted.\n"}}}}}}
```

## The WebhookEventPage object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookEventPage":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEvent"}},"since":{"type":"string","format":"date-time","description":"The lower bound this page was read from (the default is shown when you sent none)."},"has_more":{"type":"boolean","description":"More events match beyond this page."},"next_cursor":{"type":"string","nullable":true,"description":"Pass as `cursor` for the next page. Set on every non-empty page."}}},"WebhookEvent":{"type":"object","description":"One event as it was signed and sent (`event_id`, `event_type`, `created_at`, `data`), with\n`delivery` added. `data` is the event's own payload; see each event type.\n","properties":{"event_id":{"type":"string"},"event_type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"data":{"type":"object","additionalProperties":true},"delivery":{"$ref":"#/components/schemas/WebhookEventDelivery"}}},"WebhookEventDelivery":{"type":"object","description":"How the delivery of one event stands.","properties":{"status":{"type":"string","enum":["pending","in_progress","delivered","failed"],"description":"`pending`: waiting for its (next) attempt. `in_progress`: being sent now.\n`delivered`: your endpoint answered 2xx. `failed`: no more attempts, or never sent\n(see `failure_reason`).\n"},"attempts":{"type":"integer","description":"Delivery attempts made so far (reset to 0 by redeliver)."},"delivered_at":{"type":"string","format":"date-time","nullable":true,"description":"When your endpoint last accepted it."},"last_http_status":{"type":"integer","nullable":true,"description":"Your endpoint's HTTP status on the last attempt; null when there was no answer."},"failure_reason":{"type":"string","nullable":true,"enum":["webhook_disabled","webhook_url_not_set","http_error","network_error","delivery_failed",null],"description":"Why the last attempt did not succeed. `webhook_disabled` / `webhook_url_not_set`: the\nevent was never sent because of your webhook settings. `http_error`: your endpoint\nanswered non-2xx (see `last_http_status`). `network_error`: no answer (connect, TLS,\ntimeout). Null when delivered, or when requeued and not yet attempted.\n"}}}}}}
```

## The WebhookErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"WebhookErrorResponse":{"type":"object","description":"The error shape the partner webhook endpoints answer with.","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}}
```

## The PartnerErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"PartnerErrorResponse":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code. Possible values:\n- `QUOTE_EXPIRED` — quote TTL has passed; for a customer withdrawal, also the customer's forwarder nonce moved or another withdrawal has not executed yet (request a new quote)\n- `QUOTE_NOT_FOUND` — quote ID does not exist\n- `QUOTE_ALREADY_USED` — quote was already consumed by initiate. `details.order_id` names the order it created, so a retried initiate whose first response was lost can continue with that order\n- `PRICE_CHANGED_REQUOTE` — price changed beyond slippage tolerance, partner should request a new quote\n- `ORDER_NOT_FOUND` — order ID does not exist or belongs to another partner\n- `NO_OFFERS_AVAILABLE` — no vendor offers for the requested pair\n- `INVALID_REQUEST` — malformed request or missing fields\n- `INVALID_PAYMENT_DETAILS` — payment details not found or invalid\n- `RAIL_ROUTE_MISMATCH` — rail or route does not match payment details (self-payout only; on a third-party payout a mismatched `rail` is `THIRD_PARTY_CONTEXT_INVALID`)\n- `UNAUTHORIZED` — authentication failed\n- `INTERNAL_ERROR` — unexpected server error\n- `INVALID_STATUS` — order is not in the correct status for the requested action\n- `TRANSACTOR_ERROR` — (502) the transaction could not be submitted, although the signed request passed every check, or a refund could not be executed; retry\n- `INSUFFICIENT_BALANCE` — the funding wallet (your partner wallet, or the `external_wallet` customer's address) lacks tokens for the escrow or withdrawal\n- `OPERATION_NOT_ALLOWED` — action is not permitted for the current order state\n- `KYC_NOT_CLEARED` — the customer is not KYC-cleared for this transaction; `error.details.kyc_status` carries their current partner-facing status\n- `FEATURE_NOT_ENABLED` — non-custodial mode is not switched on for your partner account\n- `WALLET_NOT_LINKED` — the `external_wallet` customer has no linked address yet\n- `WALLET_ALREADY_LINKED` — the customer is already linked, the address is linked to another of your customers, or Unigox holds it for an account (a Unigox app wallet, your partner wallet, an escrow) or uses it itself\n- `WALLET_TYPE_MISMATCH` — the call does not apply to this customer's `wallet_type`\n- `INVALID_SIGNATURE` — a wallet challenge signature does not recover to the address, or the message was altered\n- `CHALLENGE_EXPIRED` — no wallet challenge was issued, it is older than 10 minutes, already used, or replaced by a newer one\n- `CUSTOMER_NOT_FOUND` / `WITHDRAWAL_NOT_FOUND` — unknown customer or withdrawal on the customer wallet routes\n- `ADDRESS_CAP_REACHED` — allocating would take the customer past the deposit-address limit for that chain type\n- `BALANCE_UNAVAILABLE` / `DEPOSIT_ADDRESSES_UNAVAILABLE` — a dependency did not answer; safe to retry\n- `AMOUNT_TOO_LOW` — (422) too small to bridge to the destination chain: the bridge refused it (`error.details.reason`), or its fee would exceed 2% (`error.details.bridge_fee`, `estimated_minimum_amount`, `max_fee_pct`)\n- `SENDER_IDENTITY_REQUIRED` — the payout corridor settles consumer-to-consumer and the customer's record cannot name them as the remitter; `error.details.kyc_fields` lists what to send to `PATCH /partner/users/{user_uuid}/kyc`, and `error.details.field_limits` carries the rail's length ceiling on any listed field that has one\n- `RECIPIENT_NOT_FOUND` — (404) the recipient endpoints, and an estimate naming such a recipient or destination: no recipient (or destination) with that id belongs to your partner account, or it was archived. A quote answers the same case `422 THIRD_PARTY_CONTEXT_INVALID`\n- `RECIPIENT_SERVICE_UNAVAILABLE` — (503) the recipient endpoints: the recipient directory could not be reached; retry with backoff\n- `THIRD_PARTY_CONTEXT_INVALID` — (422) the sender, recipient or destination of a third-party payout cannot be used, including a `rail` that is not the destination's and a destination currency that is not `fiat_currency`; the message says which\n- `THIRD_PARTY_RAIL_NOT_SUPPORTED` — (409) the currency is open to recipient payouts, but not over the rail the destination settles on\n- `THIRD_PARTY_PAYOUT_AGENT_NOT_READY` — (409) recipient payouts are switched off on our side; no order is created and the quote stays valid\n- `THIRD_PARTY_RELATIONSHIP_NOT_SUPPORTED` — (422) the rail refuses that beneficiary (a Chinese wallet pays `self` or `family` only)\n- `THIRD_PARTY_SENDER_COUNTRY_NOT_SUPPORTED` — (422) the rail refuses money sent from the country on the customer's verified identity\n- `THIRD_PARTY_PAYOUT_UNDER_REVIEW` — (422, initiate) compliance put the payout in review\n- `THIRD_PARTY_PAYOUT_DECLINED` — (422, initiate) compliance refused the payout\n\nFiat account endpoints (`/partner/fiat-accounts/config` and the `/partner/users/{user_uuid}`\n`identity`, `identification` and `fiat-accounts` routes) answer with their own codes, each\ndescribed on the response that returns it: `FIAT_ACCOUNT_NOT_FOUND`,\n`ACCOUNT_HOLDER_NOT_FOUND`, `ACCOUNT_NOT_PROVISIONED`, `CUSTOMER_NOT_FOUND`,\n`CUSTOMER_NOT_VERIFIED`, `CLIENT_NOT_APPROVED`, `HOLDER_REGISTRATION_IN_PROGRESS`,\n`IDENTIFICATION_MISSING`, `IDENTIFICATION_ALREADY_LINKED`, `INVALID_DOCUMENT_TYPE`,\n`POSTAL_CODE_REQUIRED`, `INVALID_POSTAL_CODE`, `MISSING_FIELDS`, `PRODUCT_NOT_ACTIVATED`,\n`ISSUANCE_NOT_GRANTED`, `ISSUANCE_DISABLED`, `PROVISIONING_IN_PROGRESS`,\n`UNSUPPORTED_CURRENCY`, `UNSUPPORTED_ISSUER_COUNTRY`, `CURRENCY_NOT_PERMITTED`,\n`CURRENCY_NOT_PRICED`, `RECORD_FAILED`, `BANKING_ERROR`, `BANKING_UNAVAILABLE`.\n\nBusiness customer endpoints (`/partner/business-customers`) can also answer\n`KYB_UNAVAILABLE` or `SERVICE_UNAVAILABLE` (5xx): try again shortly.\n\nThis list is not closed: codes are added as endpoints grow. Treat a code you do not recognise\nas an error of the kind its HTTP status says, rather than rejecting the response.\n"},"message":{"type":"string","description":"Human-readable error message"},"details":{"type":"object","nullable":true,"additionalProperties":true,"description":"Additional context (e.g., quoted_rate, current_rate for slippage errors)"}}}}}}}}
```

## The FiatAccountConfigResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatAccountConfigResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether you may use fiat accounts at all."},"issues_accounts":{"type":"boolean","description":"Whether you may OPEN accounts, as opposed to only reading the ones you have.\n"},"disabled_reason":{"type":"string","description":"Why the product is unavailable. Present only when `enabled` is false."},"currencies":{"type":"array","items":{"type":"string"},"description":"ISO 4217 currencies an account may be denominated in."},"issuers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Currency to issuing jurisdictions (ISO 3166-1 alpha-2), default first."}}}}}}}}
```

## The FiatAccountCreateRequest object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatAccountCreateRequest":{"type":"object","required":["user_uuid","currency"],"properties":{"user_uuid":{"type":"string","format":"uuid","description":"One of your customers, KYC-verified by Unigox."},"currency":{"type":"string","description":"One of `config.currencies`."},"issuer_country":{"type":"string","description":"ISO 3166-1 alpha-2, one of `config.issuers[currency]`. Omitted, the currency's default\njurisdiction is used.\n"},"postal_code":{"type":"string","description":"Only needed when the chosen jurisdiction requires one and the customer's KYC record has\nnone. Sent here, it is written onto that KYC record.\n"}}}}}}
```

## The FiatAccount object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatAccount":{"type":"object","description":"One issued account. The pay-in fields appear once `status` is `active`, and only the ones\nthe account's rail uses.\n\nNothing here names the bank or banking platform Unigox routes through. `bank_name` and\n`bic` describe the account a payer sends money to, which is different — those are for the\ncustomer to see.\n","properties":{"fiat_account_id":{"type":"string","format":"uuid","description":"The account's id, and the only one. It is what every `/fiat-accounts/{fiat_account_id}`\nroute takes, what a webhook names the account by, and what an order funded from this\naccount carries.\n"},"user_uuid":{"type":"string","format":"uuid","description":"The customer who holds the account."},"currency":{"type":"string"},"issuer_country":{"type":"string","description":"The jurisdiction the account was issued in."},"status":{"type":"string","enum":["pending","active","failed","closed"],"description":"`pending` — being opened, no pay-in details yet, do not send the customer to it.\n`active` — ready, and the pay-in details below are on this response.\n`failed` — the bank refused; this account will not become usable.\n`closed` — retired; its history stays readable and new deposits will not credit it.\n"},"created":{"type":"boolean","description":"On the issue response only: whether THIS request opened the account. `false` means it\nalready existed and is being handed back.\n"},"iban":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"bic":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"account_number":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"sort_code":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"iban_last4":{"type":"string","description":"List views, where the full identifier does not travel."},"account_number_last4":{"type":"string","description":"List views of a sterling account."},"bank_name":{"type":"string","description":"The bank to show the customer."},"holder_name":{"type":"string","description":"The name the account is held in."},"balances":{"type":"array","description":"Single-account view only.","items":{"$ref":"#/components/schemas/FiatBalance"}},"balances_unavailable":{"type":"boolean","description":"Single-account view only. True when the balance read failed — the balances are reported\nas unavailable rather than as zero.\n"},"created_at":{"type":"string","format":"date-time"}}},"FiatBalance":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}}}}
```

## The FiatBalance object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatBalance":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}}}}
```

## The FiatAccountResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatAccountResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/FiatAccount"}}},"FiatAccount":{"type":"object","description":"One issued account. The pay-in fields appear once `status` is `active`, and only the ones\nthe account's rail uses.\n\nNothing here names the bank or banking platform Unigox routes through. `bank_name` and\n`bic` describe the account a payer sends money to, which is different — those are for the\ncustomer to see.\n","properties":{"fiat_account_id":{"type":"string","format":"uuid","description":"The account's id, and the only one. It is what every `/fiat-accounts/{fiat_account_id}`\nroute takes, what a webhook names the account by, and what an order funded from this\naccount carries.\n"},"user_uuid":{"type":"string","format":"uuid","description":"The customer who holds the account."},"currency":{"type":"string"},"issuer_country":{"type":"string","description":"The jurisdiction the account was issued in."},"status":{"type":"string","enum":["pending","active","failed","closed"],"description":"`pending` — being opened, no pay-in details yet, do not send the customer to it.\n`active` — ready, and the pay-in details below are on this response.\n`failed` — the bank refused; this account will not become usable.\n`closed` — retired; its history stays readable and new deposits will not credit it.\n"},"created":{"type":"boolean","description":"On the issue response only: whether THIS request opened the account. `false` means it\nalready existed and is being handed back.\n"},"iban":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"bic":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"account_number":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"sort_code":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"iban_last4":{"type":"string","description":"List views, where the full identifier does not travel."},"account_number_last4":{"type":"string","description":"List views of a sterling account."},"bank_name":{"type":"string","description":"The bank to show the customer."},"holder_name":{"type":"string","description":"The name the account is held in."},"balances":{"type":"array","description":"Single-account view only.","items":{"$ref":"#/components/schemas/FiatBalance"}},"balances_unavailable":{"type":"boolean","description":"Single-account view only. True when the balance read failed — the balances are reported\nas unavailable rather than as zero.\n"},"created_at":{"type":"string","format":"date-time"}}},"FiatBalance":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}}}}
```

## The FiatAccountListResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatAccountListResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"fiat_accounts":{"type":"array","items":{"$ref":"#/components/schemas/FiatAccount"}}}}}},"FiatAccount":{"type":"object","description":"One issued account. The pay-in fields appear once `status` is `active`, and only the ones\nthe account's rail uses.\n\nNothing here names the bank or banking platform Unigox routes through. `bank_name` and\n`bic` describe the account a payer sends money to, which is different — those are for the\ncustomer to see.\n","properties":{"fiat_account_id":{"type":"string","format":"uuid","description":"The account's id, and the only one. It is what every `/fiat-accounts/{fiat_account_id}`\nroute takes, what a webhook names the account by, and what an order funded from this\naccount carries.\n"},"user_uuid":{"type":"string","format":"uuid","description":"The customer who holds the account."},"currency":{"type":"string"},"issuer_country":{"type":"string","description":"The jurisdiction the account was issued in."},"status":{"type":"string","enum":["pending","active","failed","closed"],"description":"`pending` — being opened, no pay-in details yet, do not send the customer to it.\n`active` — ready, and the pay-in details below are on this response.\n`failed` — the bank refused; this account will not become usable.\n`closed` — retired; its history stays readable and new deposits will not credit it.\n"},"created":{"type":"boolean","description":"On the issue response only: whether THIS request opened the account. `false` means it\nalready existed and is being handed back.\n"},"iban":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"bic":{"type":"string","description":"Euro (SEPA) accounts. Pay-in detail."},"account_number":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"sort_code":{"type":"string","description":"Sterling (Faster Payments) accounts. Pay-in detail."},"iban_last4":{"type":"string","description":"List views, where the full identifier does not travel."},"account_number_last4":{"type":"string","description":"List views of a sterling account."},"bank_name":{"type":"string","description":"The bank to show the customer."},"holder_name":{"type":"string","description":"The name the account is held in."},"balances":{"type":"array","description":"Single-account view only.","items":{"$ref":"#/components/schemas/FiatBalance"}},"balances_unavailable":{"type":"boolean","description":"Single-account view only. True when the balance read failed — the balances are reported\nas unavailable rather than as zero.\n"},"created_at":{"type":"string","format":"date-time"}}},"FiatBalance":{"type":"object","properties":{"currency":{"type":"string"},"available":{"type":"string"},"pending":{"type":"string"},"total":{"type":"string"}}}}}}
```

## The FiatTransaction object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatTransaction":{"type":"object","description":"One movement of money on a fiat account.","properties":{"transaction_id":{"type":"string","description":"The transaction's id, and the id a deposit webhook names it by."},"type":{"type":"string","enum":["credit"],"description":"`credit` — money arrived on the account. v1 is receive-only, so this is the only value.\n"},"amount":{"type":"string"},"currency":{"type":"string"},"order_id":{"type":"string","nullable":true,"description":"The on-ramp order this credit funded, or `null` when it matched no order and simply\nstays on the account.\n"},"description":{"type":"string","description":"What the payer sent the transfer with, when it carried anything."},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The FiatTransactionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Unigox API Gateway","version":"1.0.0"},"components":{"schemas":{"FiatTransactionsResponse":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/FiatTransaction"}},"has_more":{"type":"boolean","description":"Whether another page exists after this one."}}}}},"FiatTransaction":{"type":"object","description":"One movement of money on a fiat account.","properties":{"transaction_id":{"type":"string","description":"The transaction's id, and the id a deposit webhook names it by."},"type":{"type":"string","enum":["credit"],"description":"`credit` — money arrived on the account. v1 is receive-only, so this is the only value.\n"},"amount":{"type":"string"},"currency":{"type":"string"},"order_id":{"type":"string","nullable":true,"description":"The on-ramp order this credit funded, or `null` when it matched no order and simply\nstays on the account.\n"},"description":{"type":"string","description":"What the payer sent the transfer with, when it carried anything."},"created_at":{"type":"string","format":"date-time"}}}}}}
```
