--- title: "Create an order" method: POST path: "/trading/orders" tags: ["Trading"] --- # Create an order `POST /trading/orders` ## Request - Base URL: `https://api.fireblocks.io/v1` - URL: `https://api.fireblocks.io/v1/trading/orders` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Create an order to buy or sell an asset. If no source is given, an external source will be use. Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor. For detailed information about error codes and troubleshooting, please refer to our [API Error Codes documentation](https://developers.fireblocks.com/reference/api-error-codes). ## Headers - `Idempotency-Key` string ## Request body - CreateOrderRequest - `via` union, required - AccountAccess - `type` 'PROVIDER_ACCOUNT', required: Indicates this uses account-based access - `providerId` string: The ID of the provider - `accountId` string, required: The ID of the account - DirectAccess - `type` 'PROVIDER', required: Indicates this uses direct provider access - `providerId` string, required: The ID of the provider - `executionRequestDetails` union, required: Order execution details - MarketExecutionRequestDetails - `type` 'MARKET', required: Order type for market orders - `side` 'BUY' | 'SELL', required: BUY: receive base / pay quote; SELL: give base / receive quote. - `baseAmount` string, required: Amount in baseAssetId. BUY = base amount to receive; SELL = base amount to sell. - `baseAssetId` string, required: The asset you receive on BUY / give on SELL. - `baseAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `quoteAssetId` string, required: Counter asset used to pay/receive - `quoteAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - QuoteExecutionWithRequoteRequestDetails - `type` 'QUOTE', required: Order type for quote orders - `quoteId` string, required: Quote ID for quote orders - `reQuote` union - MarketRequoteRequestDetails - `type` 'MARKET', required: Indicates that the order should be re-quoted if the original quote is expired. This will lead to a market order. - RetryRequoteRequestDetails - `type` 'RETRY', required: Indicates that the order should be re-quoted if the original quote is expired, trying to match the original quote. - `count` integer, required: If quote is expired, how many times to re-generate new quotes to try having the order executed as in the original quote. - `slippageBps` integer: Slippage tolerance in basis points (bps) for quote orders - 1 is 0.01% and 10000 is 100% - LimitExecutionRequestDetails - `type` 'LIMIT', required: Order type for limit orders - `price` string, required: Limit price for the order - `timeInForce` TimeInForce, required: Fill-or-kill - the order must be filled in full at the limit price immediately, or not at all. - `type` 'FOK', required: Discriminator for the fill-or-kill time-in-force type. - `side` 'BUY' | 'SELL', required: BUY: receive base / pay quote; SELL: give base / receive quote. - `baseAmount` string, required: Amount in baseAssetId. BUY = base amount to receive; SELL = base amount to sell. - `baseAssetId` string, required: The asset you receive on BUY / give on SELL. - `baseAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `quoteAssetId` string, required: Counter asset used to pay/receive - `quoteAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `settlement` union, required: Settlement configuration for the order - PrefundedSettlement - `type` 'PREFUNDED', required - `destinationAccount` union, required - InternalReference - `type` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'UNMANAGED_WALLET' | 'FIAT_ACCOUNT' | 'CONNECTED_ACCOUNT', required - `accountId` string, required - OneTimeAddressReference - `type` 'ONE_TIME_ADDRESS', required - `address` string, required - `tag` string - DVPSettlement: Source/Destination accounts for the quote (must have for defi quotes) - `type` 'DVP', required - `sourceAccount` union, required - PlatformAccount - `type` 'VAULT_ACCOUNT' | 'CONNECTED_ACCOUNT' | 'FIAT_ACCOUNT', required - `accountId` string, required - ExternalAccount - `type` 'EXTERNAL', required - `senderInformation` union: Additional data for the external account, depending on the type used. - ExternalAccountMobileMoney - … - ExternalAccountLocalBankAfrica - … - `destinationAccount` union, required - InternalReference - `type` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'UNMANAGED_WALLET' | 'FIAT_ACCOUNT' | 'CONNECTED_ACCOUNT', required - `accountId` string, required - OneTimeAddressReference - `type` 'ONE_TIME_ADDRESS', required - `address` string, required - `tag` string - PostTradeSettlement: Nothing moves on-platform; settlement happens bilaterally, provider-side, after execution. - `type` 'POST_TRADE', required - `participantsIdentification` ParticipantsIdentification: KYC/AML participant identification - `originator` union - PersonalIdentification - `externalReferenceId` string, required - `entityType` 'INDIVIDUAL', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `fullName` object, required - `firstName` string, required - `lastName` string, required - `dateOfBirth` string, date, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `idNumber` string: Deprecated. Use identificationDocuments instead. - `idType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `additionalIdNumber` string: Deprecated. Use identificationDocuments instead. - `additionalIdType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `nationality` string: The ISO-3166 Alpha-2 country code representing the individual's nationality. - `identificationDocuments` PersonalIdentificationDocument[]: List of identification documents for the individual. - `id` string: The identification document number. - `type` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `expirationDate` string, date: The expiration date of the identification document. - BusinessIdentification - `externalReferenceId` string, required - `entityType` 'BUSINESS', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `businessName` string, required - `registrationNumber` string, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `dateOfRegistration` string, date: The date the business was registered. - `countryOfRegistration` string: The ISO-3166 Alpha-2 country code where the business is registered. - `beneficiary` union - PersonalIdentification - `externalReferenceId` string, required - `entityType` 'INDIVIDUAL', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `fullName` object, required - `firstName` string, required - `lastName` string, required - `dateOfBirth` string, date, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `idNumber` string: Deprecated. Use identificationDocuments instead. - `idType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `additionalIdNumber` string: Deprecated. Use identificationDocuments instead. - `additionalIdType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `nationality` string: The ISO-3166 Alpha-2 country code representing the individual's nationality. - `identificationDocuments` PersonalIdentificationDocument[]: List of identification documents for the individual. - `id` string: The identification document number. - `type` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `expirationDate` string, date: The expiration date of the identification document. - BusinessIdentification - `externalReferenceId` string, required - `entityType` 'BUSINESS', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `businessName` string, required - `registrationNumber` string, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `dateOfRegistration` string, date: The date the business was registered. - `countryOfRegistration` string: The ISO-3166 Alpha-2 country code where the business is registered. - `sourceOfFunds` SourceOfFunds: Information about the source and purpose of the funds being transacted. Used by providers that require additional context for compliance and reporting. Provide this field when the provider manifest indicates it is required. - `reasonForPayment` 'INVOICE_PAYMENT' | 'SERVICES_PAYMENT' | 'SOFTWARE_PAYMENT' | 'IMPORTED_GOODS_PAYMENT' | 'TRAVEL_SERVICES' | 'TRANSFER_TO_OWN_ACCOUNT' | 'LOAN_REPAYMENT' | 'PAYROLL' | 'PROPERTY_RENTAL' | 'INFORMATION_SERVICE_CHARGES' | 'ADVERTISING_AND_PUBLIC_RELATIONS' | 'INTELLECTUAL_PROPERTY_FEES' | 'FINANCIAL_SERVICE_FEES' | 'ADVISORY_AND_TECHNICAL_FEES' | 'REPRESENTATIVE_OFFICE_EXPENSES' | 'TAX_PAYMENT' | 'GOODS_TRANSPORTATION_FEES' | 'CONSTRUCTION_EXPENSES' | 'INSURANCE_PREMIUM' | 'GENERAL_GOODS_TRADE' | 'INSURANCE_CLAIMS_PAYMENT' | 'FAMILY_REMITTANCE' | 'EDUCATION_EXPENSES' | 'MEDICAL_TREATMENT' | 'DONATIONS' | 'MUTUAL_FUND_INVESTMENT' | 'CURRENCY_EXCHANGE' | 'ADVANCE_GOODS_PAYMENT' | 'MERCHANT_SETTLEMENT' | 'REPATRIATION_FUND_SETTLEMENT' | 'CORPORATE_INVESTMENT' | 'INTER_COMPANY_TRANSFER' | 'OFFICE_OPERATING_EXPENSES': The reason or purpose of the payment. Used by providers (e.g. CPN) that require a categorical reason for cross-border payment compliance and reporting. Optional at the API level; runtime enforcement is handled by the calling service against the provider's requirements. - `customerInternalReferenceId` string: Internal reference ID for the customer - `note` string: Optional note for the order ## Response `202` Order creation response - OrderDetails - `id` string, required - `via` union, required: Response-only counterpart of AccessType. Used by the `via` field of response schemas (Quote, Rate, OrderDetails, OrderSummary — and therefore QuoteOffer, RateOffer and Offer) so that the PROVIDER variant can expose `subProviders` without that field ever becoming reachable from a request body. Request schemas (CreateOrderRequest.via) keep using AccessType. - AccountAccessResponse - `type` 'PROVIDER_ACCOUNT', required: Indicates this uses account-based access - `providerId` string: The ID of the provider - `accountId` string, required: The ID of the account - DirectAccessResponse: Response-only counterpart of DirectAccess. Adds the server-populated `subProviders` field. Never use this schema in a request body — requests must keep using DirectAccess (via AccessType). - `type` 'PROVIDER', required: Indicates this uses direct provider access - `providerId` string, required: The ID of the provider - `subProviders` string[]: The underlying providers or tools that this direct-access route is composed of, in execution order. Response-only: this field is populated by the server and is never accepted from client requests. - `status` 'CREATED' | 'AWAITING_PAYMENT' | 'AWAITING_INFORMATION' | 'PENDING_USER_ACTION' | 'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'FAILED', required - `createdAt` string, date-time, required - `updatedAt` string, date-time - `receipt` union - BlockchainTransfer - `type` 'BLOCKCHAIN' - `txHash` string: The hash of the transaction on the blockchain. - `amount` string, required: The amount of the transaction. - FiatTransfer - `type` 'FIAT' - `amount` string, required: The amount of the fiat transfer. - `referenceId` string: The reference ID for the fiat transfer. - `generalFees` Fee[] - union - object - `feeType` 'ORDER' | 'NETWORK' | 'SPREAD' | 'REBATE', required: The type of fee, such as ORDER, NETWORK, or SPREAD. ORDER - Fee for executing the order. NETWORK - Fee for network transactions. SPREAD - Fee for the difference between buy and sell prices. REBATE - Negative fee returned to the user as a reward or incentive. - `assetId` string, required: The asset identifier for the fee. - `amountType` 'FIXED', required: The type of amount for the fee, indicating a fixed amount. - `amount` string, required: The fixed amount of the fee - object - `feeType` 'ORDER' | 'NETWORK' | 'SPREAD' | 'REBATE', required: The type of fee, such as ORDER, NETWORK, or SPREAD. ORDER - Fee for executing the order. NETWORK - Fee for network transactions. SPREAD - Fee for the difference between buy and sell prices. REBATE - Negative fee returned to the user as a reward or incentive. - `assetId` string, required: The asset identifier for the fee. - `amountType` 'BPS', required - `amount` number, required: Fee in basis points (1 = 0.01%, 10000 = 100%) - `executionSteps` OrderExecutionStep[], required - `type` 'APPROVE' | 'PERMIT' | 'CONTRACT_CALL' | 'EXECUTE' | 'SETTLEMENT' | 'DELIVERY', required - `status` 'WAITING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required - `fee` union - object - `feeType` 'ORDER' | 'NETWORK' | 'SPREAD' | 'REBATE', required: The type of fee, such as ORDER, NETWORK, or SPREAD. ORDER - Fee for executing the order. NETWORK - Fee for network transactions. SPREAD - Fee for the difference between buy and sell prices. REBATE - Negative fee returned to the user as a reward or incentive. - `assetId` string, required: The asset identifier for the fee. - `amountType` 'FIXED', required: The type of amount for the fee, indicating a fixed amount. - `amount` string, required: The fixed amount of the fee - object - `feeType` 'ORDER' | 'NETWORK' | 'SPREAD' | 'REBATE', required: The type of fee, such as ORDER, NETWORK, or SPREAD. ORDER - Fee for executing the order. NETWORK - Fee for network transactions. SPREAD - Fee for the difference between buy and sell prices. REBATE - Negative fee returned to the user as a reward or incentive. - `assetId` string, required: The asset identifier for the fee. - `amountType` 'BPS', required - `amount` number, required: Fee in basis points (1 = 0.01%, 10000 = 100%) - `txId` string - `txHash` string - `error` 'INTERNAL_ERROR' | 'QUOTE_EXPIRED' | 'INSUFFICIENT_OUTPUT_AMOUNT' | 'INSUFFICIENT_FUNDS' | 'LAST_TRANSACTION_FAILED' | 'SWAP_APPROVAL_FAILED' | 'PROVIDER_EXECUTION_ERROR' - `executionResponseDetails` union, required - MarketExecutionResponseDetails - `type` 'MARKET', required: Order type for market orders - `side` 'BUY' | 'SELL', required: BUY: receive base / pay quote; SELL: give base / receive quote. - `baseAmount` string, required: Amount to convert - `baseAssetId` string, required: Source asset identifier - `baseAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `quoteAssetId` string, required: Target asset identifier - `quoteAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - QuoteExecutionWithRequoteResponseDetails - `type` 'QUOTE', required: Order type for quote orders - `quoteId` string, required: Quote ID for quote orders - `quoteAmount` string, required: Quote amount for quote orders - `side` 'BUY' | 'SELL', required: BUY: receive base / pay quote; SELL: give base / receive quote. - `baseAmount` string, required: Amount to convert - `baseAssetId` string, required: Source asset identifier - `baseAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `quoteAssetId` string, required: Target asset identifier - `quoteAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `reQuote` union - MarketRequoteRequestDetails - `type` 'MARKET', required: Indicates that the order should be re-quoted if the original quote is expired. This will lead to a market order. - RetryRequoteRequestDetails - `type` 'RETRY', required: Indicates that the order should be re-quoted if the original quote is expired, trying to match the original quote. - `count` integer, required: If quote is expired, how many times to re-generate new quotes to try having the order executed as in the original quote. - `slippageBps` integer: Slippage tolerance in basis points (bps) for quote orders - 1 is 0.01% and 10000 is 100% - LimitExecutionResponseDetails - `type` 'LIMIT', required: Order type for limit orders - `price` string, required: Limit price for the order - `timeInForce` TimeInForce, required: Fill-or-kill - the order must be filled in full at the limit price immediately, or not at all. - `type` 'FOK', required: Discriminator for the fill-or-kill time-in-force type. - `side` 'BUY' | 'SELL', required: BUY: receive base / pay quote; SELL: give base / receive quote. - `baseAmount` string, required: Amount to convert - `baseAssetId` string, required: Source asset identifier - `baseAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `quoteAssetId` string, required: Target asset identifier - `quoteAssetRail` 'BLOCKCHAIN' | 'INTERNAL' | 'SWIFT' | 'IBAN' | 'US_WIRE' | 'ACH' | 'SEPA' | 'SPEI' | 'PIX' | 'LBT' | 'MOMO' | 'CHAPS' | 'PAYID' | 'INTERAC' | 'INTERNAL_TRANSFER' | 'CIPS' | 'NEQUI' | 'FPS_UK' | 'FPS_HK' | 'INSTA_PAY' | 'PESONET': Transfer rail: * **BLOCKCHAIN** - Transfer over the public blockchain * **INTERNAL** - Internal transfer within the same account (e.g. sub-accounts or same api key) * **SWIFT** - International wire transfer * **IBAN** - International Bank Account Number transfer * **US_WIRE** - Domestic wire transfer within the United States (e.g. FedWire) * **ACH** - Automated Clearing House transfer, typically takes longer but not as expensive as wire transfers * **SEPA** - Euro transfers within the SEPA zone * **SPEI** - Mexican interbank electronic payment system * **PIX** - Brazilian instant payment system * **LBT** - Local bank transfers * **MOMO** - Mobile money transfers (e.g. M-Pesa) * **CHAPS** - The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for transactions in the United Kingdom * **PAYID** - PayID payment identifier system (Australia) * **INTERAC** - Interac electronic funds transfer (Canada) * **INTERNAL_TRANSFER** - Internal transfer between accounts * **CIPS** - Cross-Border Interbank Payment System (China) * **NEQUI** - Nequi mobile payment (Colombia) * **FPS_UK** - UK Faster Payments (GBP) * **FPS_HK** - Hong Kong Faster Payment System (HKD) * **INSTA_PAY** - InstaPay instant payment (Philippines) * **PESONET** - PesoNet batch payment (Philippines) - `settlement` union, required: Settlement configuration for the order - PrefundedSettlement - `type` 'PREFUNDED', required - `destinationAccount` union, required - InternalReference - `type` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'UNMANAGED_WALLET' | 'FIAT_ACCOUNT' | 'CONNECTED_ACCOUNT', required - `accountId` string, required - OneTimeAddressReference - `type` 'ONE_TIME_ADDRESS', required - `address` string, required - `tag` string - DVPSettlement: Source/Destination accounts for the quote (must have for defi quotes) - `type` 'DVP', required - `sourceAccount` union, required - PlatformAccount - `type` 'VAULT_ACCOUNT' | 'CONNECTED_ACCOUNT' | 'FIAT_ACCOUNT', required - `accountId` string, required - ExternalAccount - `type` 'EXTERNAL', required - `senderInformation` union: Additional data for the external account, depending on the type used. - ExternalAccountMobileMoney - … - ExternalAccountLocalBankAfrica - … - `destinationAccount` union, required - InternalReference - `type` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'UNMANAGED_WALLET' | 'FIAT_ACCOUNT' | 'CONNECTED_ACCOUNT', required - `accountId` string, required - OneTimeAddressReference - `type` 'ONE_TIME_ADDRESS', required - `address` string, required - `tag` string - PostTradeSettlement: Nothing moves on-platform; settlement happens bilaterally, provider-side, after execution. - `type` 'POST_TRADE', required - `participantsIdentification` ParticipantsIdentification: KYC/AML participant identification - `originator` union - PersonalIdentification - `externalReferenceId` string, required - `entityType` 'INDIVIDUAL', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `fullName` object, required - `firstName` string, required - `lastName` string, required - `dateOfBirth` string, date, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `idNumber` string: Deprecated. Use identificationDocuments instead. - `idType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `additionalIdNumber` string: Deprecated. Use identificationDocuments instead. - `additionalIdType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `nationality` string: The ISO-3166 Alpha-2 country code representing the individual's nationality. - `identificationDocuments` PersonalIdentificationDocument[]: List of identification documents for the individual. - `id` string: The identification document number. - `type` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `expirationDate` string, date: The expiration date of the identification document. - BusinessIdentification - `externalReferenceId` string, required - `entityType` 'BUSINESS', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `businessName` string, required - `registrationNumber` string, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `dateOfRegistration` string, date: The date the business was registered. - `countryOfRegistration` string: The ISO-3166 Alpha-2 country code where the business is registered. - `beneficiary` union - PersonalIdentification - `externalReferenceId` string, required - `entityType` 'INDIVIDUAL', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `fullName` object, required - `firstName` string, required - `lastName` string, required - `dateOfBirth` string, date, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `idNumber` string: Deprecated. Use identificationDocuments instead. - `idType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `additionalIdNumber` string: Deprecated. Use identificationDocuments instead. - `additionalIdType` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `nationality` string: The ISO-3166 Alpha-2 country code representing the individual's nationality. - `identificationDocuments` PersonalIdentificationDocument[]: List of identification documents for the individual. - `id` string: The identification document number. - `type` 'NIN_SLIP_CARD' | 'BVN' | 'ID_CARD' | 'ID_BOOK' | 'NATIONAL_ID' | 'ALIEN_CARD' | 'PASSPORT' | 'ECOWAS_CARD' | 'RWANDA_CARD' | 'DRIVERS_LICENSE' | 'RESIDENT_CARD' | 'VOTER_ID' | 'HEALTH_INSURANCE_ID' | 'GHANA_CARD' | 'REFUGEE_ID' | 'SSNIT' | 'NON_CITIZEN_ID' | 'NATIONAL_REGISTRATION_CARD': Type of identification document. Acceptable values are: - 'NIN_SLIP_CARD': National Identification Number (NIN) Slip Card - temporary identification card issued in Nigeria - 'BVN': Bank Verification Number - unique identity number for bank account holders in Nigeria - 'ID_CARD': General national identity card - 'ID_BOOK': Identity book or booklet format identification document - 'NATIONAL_ID': National identity document issued by government authorities - 'ALIEN_CARD': Alien registration card for foreign nationals - 'PASSPORT': International travel document and proof of identity - 'ECOWAS_CARD': Economic Community of West African States identification card - 'RWANDA_CARD': Rwandan national identification card - 'DRIVERS_LICENSE': Driver's license or driving permit - 'RESIDENT_CARD': Resident permit or permanent resident card - 'VOTER_ID': Voter identification card used for electoral registration - 'HEALTH_INSURANCE_ID': Health insurance identification card - 'GHANA_CARD': Ghana Card - national identification card issued in Ghana - 'REFUGEE_ID': Refugee identification document - 'SSNIT': Social Security and National Insurance Trust ID - social security number in Ghana - 'NON_CITIZEN_ID': Identification document for non-citizens or foreign residents - 'NATIONAL_REGISTRATION_CARD': National registration card issued by national registration authority - `expirationDate` string, date: The expiration date of the identification document. - BusinessIdentification - `externalReferenceId` string, required - `entityType` 'BUSINESS', required - `participantRelationshipType` 'FirstParty' | 'SecondParty' | 'ThirdParty', required - `businessName` string, required - `registrationNumber` string, required - `postalAddress` PostalAddress, required - `streetName` string, required - `buildingNumber` string, required - `postalCode` string, required - `city` string, required - `subdivision` string, required - `district` string, required - `country` string, required - `email` string, email - `phone` string: Mobile phone number in E.164 format - `dateOfRegistration` string, date: The date the business was registered. - `countryOfRegistration` string: The ISO-3166 Alpha-2 country code where the business is registered. - `paymentInstructions` PaymentInstructions[]: Payment instructions for the order, the client can use one of these to pay the order. - union - BlockchainDestination - `type` 'BLOCKCHAIN', required: The type of destination. Use "BLOCKCHAIN" for blockchain address destinations. - `address` BlockchainAddress, required: The blockchain address information. - `blockchainAddress` string, required: The blockchain address. - `tag` string: The tag of the blockchain address. It is used to identify the address in the blockchain. It is optional. - object - `type` 'IBAN', required - `address` IbanAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `iban` string, required - `referenceId` string - object - `type` 'SWIFT', required - `address` SwiftAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `swiftCode` string, required - `routingNumber` string, required: Routing number identifying the bank account. - `referenceId` string - object - `type` 'ACH', required - `address` AchAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string: Name of the bank. - `bankAccountNumber` string, required: The bank account number for the ACH transfer. - `routingNumber` string, required: Routing number identifying the bank account. - `accountType` 'CHECKING' | 'SAVINGS', required: Type of the bank account. - `referenceId` string - object - `type` 'WIRE', required - `address` USWireAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string: Name of the bank. - `bankAccountNumber` string, required: The bank account number for the wire transfer. - `routingNumber` string, required: Routing number identifying the bank account. - `bankAddress` BankAddress: Address of the bank. - `streetName` string - `buildingNumber` string - `postalCode` string - `city` string - `subdivision` string - `district` string - `country` string - `referenceId` string - object - `type` 'SPEI', required - `address` SpeiAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string: Name of the bank. - `bankAccountNumber` string, required: The bank account number for the SPEI transfer. - `referenceId` string - object - `type` 'SEPA', required - `address` SEPAAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `iban` string, required - `bic` string: Bank Identifier Code (SWIFT/BIC) - `bankName` string - `bankBranch` string - `bankAddress` string - `purposeCode` string: ISO purpose code for the transfer - `taxId` string: Beneficiary tax identification number - `referenceId` string - object - `type` 'PIX', required - `address` PixAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `pixKey` string, required - `keyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM', required - `bankName` string - `bankCode` string - `qrCode` string: The QR code to be used for the transfer - `expirationDate` string: The expiration date of the QR code - `referenceId` string - object - `type` 'LOCAL_BANK_TRANSFER', required - `address` LocalBankTransferAfricaAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `accountNumber` string, required - `bankName` string, required: Name of the bank - `bankCode` string, required: Internal bank identifier - `successPaymentInstructionRedirectUrl` string: The URL to redirect to after the payment instruction is successful - `paymentRedirect` PaymentRedirect: URL returned by the provider that the end user will be redirected to in order to complete the payment on the bank/mobile provider page. After completion, the bank/mobile provider redirects the end user back to successRedirectUrl (provided in the RAMP request) - `url` string: URL to redirect to - `expiresAt` string: Expiration date of the redirect - `referenceId` string - object - `type` 'MOBILE_MONEY', required - `address` MobileMoneyAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `mobilePhoneNumber` string, required: Mobile phone number in E.164 format - `provider` 'm-pesa' | 'airtel' | 'mtn' | 'tigo' | 'orange', required: Mobile money provider - `beneficiaryDocumentId` string: Beneficiary document identification (may be required) - `beneficiaryRelationship` string: Relationship to beneficiary for AML purposes - `successPaymentInstructionRedirectUrl` string: The URL to redirect to after the payment instruction is successful - `paymentRedirect` PaymentRedirect: URL returned by the provider that the end user will be redirected to in order to complete the payment on the bank/mobile provider page. After completion, the bank/mobile provider redirects the end user back to successRedirectUrl (provided in the RAMP request) - `url` string: URL to redirect to - `expiresAt` string: Expiration date of the redirect - `referenceId` string - object - `type` 'EUROPEAN_SEPA', required - `address` EuropeanSEPAAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `iban` string, required - `bic` string - `bankName` string - `bankBranch` string - `bankAddress` string - `purposeCode` string - `taxId` string - `referenceId` string - object - `type` 'CHAPS', required - `address` ChapsAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `sortCode` string, required: UK bank sort code (format XX-XX-XX) - `accountNumber` string, required: UK bank account number - `bankName` string: Name of the bank - `bankAccountCountry` string, required: CHAPS bank account holder name - `bankAccountHolderName` string, required: CHAPS bank account holder name - `referenceId` string - object - `type` 'INTERAC', required - `address` InteracAddress, required: When true, funds are deposited directly into the recipient's bank account without a security question. When false, a security question and answer are required to complete the transfer - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `recipientHandle` RecipientHandle, required - `type` 'EMAIL', required - `value` string, required: The value of the recipient handle - `message` string: The message to be sent to the recipient - `autoDeposit` boolean, required: Whether to automatically deposit the funds into the account - `securityQuestion` string: The security question to be used for the security answer - `securityAnswer` string: The security answer to be used for the security question - `referenceId` string - object - `type` 'PAYID', required - `address` PayidAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `value` string, required: The PayID identifier (email, phone, ABN, or organization ID) - `type` 'EMAIL', required: The type of PayID being used - `bsb` string: Bank State Branch (BSB) number (6 digits, format XXX-XXX) - `accountNumber` string: Australian bank account number - `referenceId` string - object - `type` 'INTERNAL_TRANSFER', required - `address` InternalTransferAddress - `externalAccountId` string: The provider's identifier for the external account. This enables the user to fund the account externally (outside of Fireblocks) if needed. - `accountId` string, required: The Fireblocks account ID where the user should deposit the funds. - `referenceId` string - object - `type` 'CIPS', required: The transfer rail type for the destination - `address` CipsAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string, required: Name of the recipient's bank - `bankCountry` string, required: ISO 3166-1 alpha-2 country code of the bank - `swiftCode` string, required: SWIFT/BIC code of the recipient bank - `accountNumber` string, required: Recipient bank account number - `referenceId` string: Optional payment reference - object - `type` 'NEQUI', required: The transfer rail type for the destination - `address` NequiAddress, required - `phone` string, required: Recipient phone number in E.164 format - `referenceId` string - object - `type` 'FPS_UK', required: The transfer rail type for the destination - `address` FpsUkAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `accountNumber` string, required: UK bank account number - `sortCode` string, required: UK sort code (format XX-XX-XX) - `referenceId` string - object - `type` 'FPS_HK', required: The transfer rail type for the destination - `address` FpsHkAddress, required - `recipientLegalName` string: Full legal name of the recipient - `accountNumber` string: Recipient bank account number - `bankCode` string: Hong Kong bank code - `phone` string: Recipient phone number in E.164 format - `email` string: Recipient email address - `fpsId` string: Hong Kong FPS identifier - `referenceId` string - object - `type` 'INSTA_PAY', required: The transfer rail type for the destination - `address` InstaPayAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string, required: Name of the recipient's bank or wallet (e.g. BDO, BPI, GCash, Maya) - `accountNumber` string, required: Recipient bank account or wallet number - `referenceId` string - object - `type` 'PESONET', required: The transfer rail type for the destination - `address` PesonetAddress, required - `accountHolder` AccountHolderDetails, required - `name` string, required: Full name of the account holder. - `city` string - `country` string: Country code, as specified in ISO 3166-1 alpha-2. - `subdivision` string: Country administrative subdivision, as specified in ISO 3166-2. - `address` string: Account holder street address. - `postalCode` string - `bankName` string, required: Name of the recipient's bank - `accountNumber` string, required: Recipient bank account number - `referenceId` string - `createdBy` string, required: The ID of the user who created the order - `customerInternalReferenceId` string: Internal reference ID for the customer - `note` string: Optional note for the Order - `expiresAt` string, date-time - `failure` Failure - `reason` 'INSUFFICIENT_FUNDS' | 'UNKNOWN_REASON' | 'INITIATE_PAYMENT_FAILURE' | 'POLICY_REJECTION' | 'TRANSACTION_FAILED' | 'ACCOUNT_NOT_ACTIVE' | 'ACCOUNT_NOT_FOUND' | 'BAD_REQUEST' | 'QUOTE_NOT_READY' | 'INVALID_DATA' | 'UNSUPPORTED_CONVERSION' | 'UNSUPPORTED_RAMP_METHOD' | 'REFUNDED' | 'FAILED_BY_PROVIDER' | 'ORDER_EXPIRED' | 'TRANSACTION_CANCELLED' | 'TRANSACTION_REJECTED' | 'TRANSACTION_BLOCKED' | 'PROVIDER_INTERNAL_ERROR' | 'UNSUPPORTED_SOURCE_ASSET' | 'UNSUPPORTED_DESTINATION_ASSET' | 'AMOUNT_BELOW_MINIMUM' | 'AMOUNT_ABOVE_MAXIMUM' | 'PII_MISSING' | 'EXTERNAL_SOURCE_NOT_SUPPORTED' | 'UNSUPPORTED_REGION' | 'DESTINATION_NOT_WHITELISTED' | 'MISSING_DESTINATION_DETAILS' | 'MISSING_WORKSPACE_DETAILS' | 'CREDIT_LIMIT_EXCEEDED' | 'QUOTE_EXPIRED' | 'DESK_REJECTED' | 'REQUOTE_WORSE_PRICE' | 'FOK_KILLED', required ## Other responses - `400`: Bad request: invalid input parameters, malformed request body, or validation failure. - `401`: Unauthorized. Missing / invalid JWT token in Authorization header. - `403`: Forbidden: insufficient permissions, disabled feature, or restricted access. - `429`: Rate limit exceeded: slow down and retry later. - `5XX`: Internal error while processing the request. - `default`: Error Response --- [API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)