{"openapi":"3.1.0","info":{"title":"Withdraw API","version":"@VERSION@","description":"Facilitates the transfer (on-ramp) of funds out of the CFX network and back into traditional finance system.\n\nWithdrawals can be made from wallets of verified identities (see the Identity API) into bank accounts in CFX supported countries.\n\nCFX off-ramps continue to expand. Please contact your CFX account representative should you have enquiries about a particular country or mechanism.","contact":{"name":"API Owner","email":"api@cfxlabs.com"}},"components":{"securitySchemes":{"ApiKeyAuth":{"name":"x-api-key","type":"apiKey","in":"header"},"ApiSecretAuth":{"name":"x-api-secret","type":"apiKey","in":"header"}},"schemas":{}},"paths":{"/v1/withdrawal/ach/authorize":{"post":{"summary":"Create Ach Debit Authorization","tags":["ACH","x-internal"],"description":"This endpoint is used to create an ACH Debit authorization for an Entity.\n\nSupplied with the required parameters, this endpoint will debit the given ledger account and wait for the debit entry from the debit to be returned by the bank.\n\nOnce the debit entry is confirmed, the system will finalize the withdrawal and send a webhook to the configured URL.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targetAmount","achId","walletId","organizationId","paymentInstrumentId"],"properties":{"targetAmount":{"type":"number","description":"Amount that will be debited from the bank account. This amount must match the amount of the debit entry that is returned by the bank."},"achId":{"type":"string","description":"The ID of the ACH debit authorization. This must match the achId field of the corresponding debit entry that is returned by the bank.\n\nThe ID must be unique, and effectively acts as an idempotency key. If an authorization bearing an identical achId already exists, the system will return an error."},"walletId":{"type":"string","description":"The ID of the ledger account that will be debited. Must be owned by the same entity as the payment instrument."},"organizationId":{"type":"string","description":"The Organization that initiated the ach debit withdrawal. this organization must be the same as the one that owns the walletId and the paymentInstrumentId."},"paymentInstrumentId":{"type":"string","description":"This payment instrument represents the bank account where the funds will be debited to.\n\nIts owner must be the same as the one of the walletId (i.e. if the walletId is a customer wallet, the provided Payment Instrument must be owned by the customer entity).\n\nLikewise, if the walletId is a payment instrument wallet (i.e a moveusd account that is owned by an entity, not a customer), the paymentInstrument must be owned by the same entity.\n            "}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/blockchain/{id}":{"get":{"summary":"Get Blockchain Withdrawal","tags":["BLOCKCHAIN"],"parameters":[{"schema":{"type":"string"},"example":"wd_t7wBX8BbHy55nHxjxtSqs","in":"path","name":"id","required":true,"description":"Unique identifier for the blockchain withdrawal"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","type","entityId","quoteId","source","target","status","receipt","fees","createdAt","updatedAt","history"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"entityId":{"type":"string"},"quoteId":{"type":"string"},"source":{"type":"object","required":["amount","accountId","currency"],"properties":{"amount":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}},"target":{"type":"object","required":["amount","paymentInstrumentId","currency"],"properties":{"amount":{"type":"string"},"paymentInstrumentId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD.SOL"]}}},"status":{"type":"string"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string"}}},{"type":"null"}]},"fees":{"type":"array","items":{"type":"object","required":["receiver","type","amount","currency"],"properties":{"receiver":{"type":"string"},"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"history":{"type":"array","items":{"type":"object","required":["id","status","receipt","createdAt"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string"}}},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_METHOD"]},"message":{"type":"string"}},"title":"INVALID_METHOD","description":"Withdrawal Is Not a Blockchain Withdrawal"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"Blockchain Withdrawal Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"Blockchain Withdrawal Not Found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/blockchain/quote":{"post":{"summary":"Create Blockchain Withdrawal Quote","tags":["BLOCKCHAIN"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceAmount","sourceLedgerAccountId","targetWalletPaymentInstrumentId"],"properties":{"sourceAmount":{"type":"number","description":"Amount of MoveUSD to withdraw","example":100},"sourceLedgerAccountId":{"type":"string","description":"Unique identifier for the ledger account to debit","example":"redwal_1a2b3c4d5e6f7g8h9i0j"},"targetWalletPaymentInstrumentId":{"type":"string","description":"Unique identifier for the target wallet payment instrument to withdraw to","example":"pi_R0Td23dw42124dsf"},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","enum":["ip"],"example":"ip"},"lat":{"type":"number","description":"Latitude of the device","example":37.851},"long":{"type":"number","description":"Longitude of the device","example":-96.822}},"description":"Location of the device submitting transacting with the CFX network"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","type","entityId","source","target","status","fees","createdAt","expiresAt"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"entityId":{"type":"string"},"source":{"type":"object","required":["amount","accountId","currency"],"properties":{"amount":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}},"target":{"type":"object","required":["amount","paymentInstrumentId","currency"],"properties":{"amount":{"type":"string"},"paymentInstrumentId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD.SOL"]}}},"status":{"type":"string"},"fees":{"type":"array","items":{"type":"object","required":["receiver","type","amount","currency"],"properties":{"receiver":{"type":"string"},"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}}},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INSUFFICIENT_FUNDS"]},"message":{"type":"string"}},"title":"INSUFFICIENT_FUNDS","description":"Source account has insufficient funds"}]}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/blockchain/quote/{id}":{"get":{"summary":"Get Blockchain Withdrawal quote","tags":["BLOCKCHAIN","x-internal"],"parameters":[{"schema":{"type":"string"},"example":"wdqt_t7wBX8BbHy23saMMsd2","in":"path","name":"id","required":true,"description":"Unique identifier for the blockchain withdrawal quote"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","type","entityId","source","target","status","fees","createdAt","expiresAt"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"entityId":{"type":"string"},"source":{"type":"object","required":["amount","accountId","currency"],"properties":{"amount":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}},"target":{"type":"object","required":["amount","paymentInstrumentId","currency"],"properties":{"amount":{"type":"string"},"paymentInstrumentId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD.SOL"]}}},"status":{"type":"string"},"fees":{"type":"array","items":{"type":"object","required":["receiver","type","amount","currency"],"properties":{"receiver":{"type":"string"},"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}}},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_METHOD"]},"message":{"type":"string"}},"title":"INVALID_METHOD","description":"Withdrawal Quote Is Not A Blockchain Withdrawal Quote"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"Blockchain Withdrawal Quote Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"Blockchain Withdrawal Quote Not Found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/blockchain/quote/{id}/accept":{"post":{"summary":"Accept Blockchain Withdrawal quote","tags":["BLOCKCHAIN"],"parameters":[{"schema":{"type":"string"},"example":"wdqt_t7wBX8BbHy23saMMsd2","in":"path","name":"id","required":true,"description":"Unique identifier for the blockchain withdrawal quote"},{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","type","entityId","quoteId","source","target","status","receipt","fees","createdAt","updatedAt","history"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"entityId":{"type":"string"},"quoteId":{"type":"string"},"source":{"type":"object","required":["amount","accountId","currency"],"properties":{"amount":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}},"target":{"type":"object","required":["amount","paymentInstrumentId","currency"],"properties":{"amount":{"type":"string"},"paymentInstrumentId":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD.SOL"]}}},"status":{"type":"string"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string"}}},{"type":"null"}]},"fees":{"type":"array","items":{"type":"object","required":["receiver","type","amount","currency"],"properties":{"receiver":{"type":"string"},"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string","enum":["MOVEUSD"]}}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"history":{"type":"array","items":{"type":"object","required":["id","status","receipt","createdAt"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"receipt":{"anyOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string"}}},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_ACTIVE"]},"message":{"type":"string"}},"title":"NOT_ACTIVE","description":"Quote is expired or accepted"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_METHOD"]},"message":{"type":"string"}},"title":"INVALID_METHOD","description":"Invalid quote type to accept"}]}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"Blockchain Withdrawal Quote Not Found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"Blockchain Withdrawal Quote Not Found"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/estimate":{"get":{"summary":"Get Withdrawal Estimate","tags":["Estimate"],"description":"Get an estimate for a Withdrawal on the CFX network.\n\nSupply either `sourceAmount` (the amount to be debited from wallet) or `targetAmountAfterFees` (the amount to arrive at the destination) to receive an estimate.\n\nNote this endpoint is purely for the estimation of withdrawal amounts and fees.\nThe actual withdrawal is actioned via other withdrawal endpoints which facilitate the creation of a binding withdrawal quote and capturing explicit acceptance.","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"},{"schema":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"in":"query","name":"country","required":true,"description":"The country of the target bank account"},{"schema":{"type":"string","enum":["USDC","MOVEUSD"]},"in":"query","name":"sourceCurrency","required":true,"description":"The source currency funding the withdrawal"},{"schema":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"]},"in":"query","name":"targetCurrency","required":true,"description":"The target currency in which the withdrawal will be delivered"},{"schema":{"type":"number"},"example":100.5,"in":"query","name":"sourceAmount","required":false,"description":"The source amount for the withdrawal, which corresponds to what amount will be deducted from the nominated wallet"},{"schema":{"type":"number"},"example":100.5,"in":"query","name":"targetAmountAfterFees","required":false,"description":"The target amount for the withdrawal, which corresponds to what amount will be received by the payment instrument"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["country","sourceCurrency","targetCurrency","sourceAmount","methods"],"properties":{"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries","description":"The country of the target bank account"},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency in which the withdrawal will be delivered"},"sourceAmount":{"type":"number","deprecated":true,"description":"The source amount for the withdrawal, which corresponds to what amount will be deducted from the nominated wallet","example":100.5},"methods":{"type":"array","items":{"anyOf":[{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_ACH"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"US_ACH"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_INSTANT"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"US_INSTANT"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"SWIFT_WIRE"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"US_WIRE"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["ACH_PULL"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"ACH DEBIT"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["sourceAmount","targetAmount","sourceAmountAfterFees","targetAmountAfterFees","fees"],"properties":{"sourceAmount":{"type":"number","description":"Amount of the source currency associated with the withdrawal","examples":[100]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate amount of the target currency associated with the withdrawal","examples":[1712.13]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate amount of the source currency after fees have been extracted","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Amount of the source currency after fees have been extracted","examples":[1712.13]},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}},{"type":"object","required":["withdrawalType"],"properties":{"withdrawalType":{"type":"string","enum":["bank","momo"]}}}],"title":"AF_WITHDRAWAL"}]}}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/quote":{"post":{"summary":"Create Quote","tags":["Quote"],"description":"Generate a quote for Withdrawal on the CFX network.\n\nThe Get Estimate endpoint provides a non-binding estimate for a withdrawal transaction.\n\nThis Create Quote generates a binding quote, which includes an unsigned Solana transaction facilitating the transfer of funds from the nominated user wallet into a CFX withdrawal wallet.\n\nSupply either `sourceAmount` (the amount to be debited from wallet) or `targetAmountAfterFees` (the amount to arrive at the destination) to receive a quote.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["paymentInstrumentId","sourceCurrency","targetCurrency","wallet"],"properties":{"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"type":"object","properties":{}},{"type":"object","required":["country"],"properties":{"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]}}}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["paymentInstrumentId","sourceCurrency","targetCurrency","wallet"],"properties":{"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"type":"object","properties":{}},{"type":"object","required":["country"],"properties":{"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]}}}]}]}]}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/quote/{id}/accept":{"post":{"summary":"Accept Quote","tags":["Quote"],"description":"Accepts a withdrawal quote for execution.\n\nThis endpoint confirms acceptance of a quote previously generated by the Create Quote endpoint.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"type":"object","required":["signedTransaction"],"properties":{"signedTransaction":{"type":"string","description":"A signed Solana transaction that when submitted to the blockchain will transfer funds from the user wallet to fund the withdrawal"}}}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"type":"object","required":["signedTransaction"],"properties":{"signedTransaction":{"type":"string","description":"A signed Solana transaction that when submitted to the blockchain will transfer funds from the user wallet to fund the withdrawal"}}}]}]}}}},"parameters":[{"schema":{"type":"string"},"example":"wdqt_rU9eQh&j2dkiI9yrwVC7s","in":"path","name":"id","required":true,"description":"A unique identifier for a withdrawal quote"},{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/quote/{id}/reject":{"post":{"summary":"Reject Quote","tags":["Quote"],"description":"Rejects a withdrawal quote.","parameters":[{"schema":{"type":"string"},"example":"wdqt_rU9eQh&j2dkiI9yrwVC7s","in":"path","name":"id","required":true,"description":"A unique identifier for a withdrawal quote"},{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","example":"wdqt_rU9eQh&j2dkiI9yrwVC7s"}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/quote/{id}":{"get":{"summary":"Get Withdrawal Quote","tags":["Quote"],"description":"Retrieves a specific withdrawal quote.","parameters":[{"schema":{"type":"string"},"example":"wdqt_rU9eQh&j2dkiI9yrwVC7s","in":"path","name":"id","required":true,"description":"A unique identifier for a withdrawal quote"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/wire-drawdown/authorize":{"post":{"summary":"Create Wire Drawdown Authorization","tags":["Wire Drawdowns","x-internal"],"description":"This endpoint is used to Authorize a wire drawdown for a particular account.\n\nSupplied with the required parameters, this endpoint will debit the given ledger account and wait for the debit entry from the pull to be returned by the bank.\n\nOnce the debit entry is confirmed, the system will finalize the withdrawal and send a webhook to the configured URL.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targetAmount","drawdownId","wirePaymentInstrumentId","sourceAccountId"],"properties":{"targetAmount":{"type":"number","description":"Amount that will be debited from the bank account. This amount must match the amount of the debit entry that is returned by the bank."},"drawdownId":{"type":"string","description":"The ID of the wire drawdown authorization.\n\nThe ID must be unique, and effectively acts as an idempotency key. If an authorization bearing an identical drawdownId already exists, the system will return an error."},"wirePaymentInstrumentId":{"type":"string","description":"The US_WIRE payment instrument for the target bank account you will be drawing down to"},"sourceAccountId":{"type":"string","description":"The ID of the ledger account that will be debited. This wallet must be owned by the same entity as the payment instrument."}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Idempotency-Key","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["MISSING_IDEMPOTENCY_KEY"]},"message":{"type":"string"}},"title":"MISSING_IDEMPOTENCY_KEY","description":"Missing required idempotency key header"},{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}]}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"409":{"description":"A duplicate request with this idempotency key is already in progress","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_IN_PROGRESS"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_IN_PROGRESS","description":"A duplicate request with this idempotency key is already in progress"}}}},"422":{"description":"Another request with this idempotency key was made using a different body","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},"message":{"type":"string"}},"title":"IDEMPOTENCY_KEY_REUSED","description":"Another request with this idempotency key was made using a different body"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/{id}":{"get":{"summary":"Get Withdrawal","tags":["Withdrawal"],"description":"Retrieve details associated with a specific withdrawal.","parameters":[{"schema":{"type":"string"},"example":"wd_t7wBX8BbHy55nHxjxtSqs","in":"path","name":"id","required":true,"description":"Unique identifier for a withdrawal"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]}]}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal":{"get":{"summary":"Search Withdrawal","tags":["Withdrawal"],"description":"Search for Withdrawals for a given `identityId` or `organizationId`.\nThe `identityId` or `organizationId` query parameters are mandatory. Withdrawals can be further filtered by populating the `status` request parameters.\n\nThe status parameter can either be set using a single value (eg `COMPLETED`) or by providing a comma separated list (eg `COMPLETED,PENDING`)","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"},{"schema":{"type":"string","pattern":"^(CREATED|PENDING|COMPLETED|FAILED|RETURNED)(,(CREATED|PENDING|COMPLETED|FAILED|RETURNED))*$"},"example":"PENDING,CREATED","in":"query","name":"status","required":false,"description":"Comma separated list of withdrawal states to filter on"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"allOf":[{"type":"object","required":["id","status","createdAt","quote"],"properties":{"id":{"type":"string","description":"A unique ID for the withdrawal","examples":["wd_t7wBX8BbHy55nHxjxtSqs"]},"status":{"type":"string","enum":["CREATED","PENDING","COMPLETED","FAILED","RETURNED"],"description":"Status of the withdrawal"},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}},"returnId":{"type":"string","description":"A unique receipt ID for a returned withdrawal","examples":["25gUChCsRPN83mZu2RqaBj1VNaJCZLAgxrxxb5e1DcqLkXXXYjwotwJgFFafSuCpzr9CuRz5xg1GFiEXRYqHAkNF"]},"createdAt":{"type":"string","description":"The datetime the withdrawal instance was created","examples":["2023-10-23T06:20:04.366+00:00"]},"quote":{"anyOf":[{"allOf":[{"type":"object","required":["identityId"],"properties":{"identityId":{"type":"string","description":"Identity ID associated with the deposit request","examples":["id_VfsdSMtd8UdgxCgTnz0tm"]}},"title":"Individual"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]},{"allOf":[{"type":"object","required":["organizationId"],"properties":{"organizationId":{"type":"string","description":"Organization ID associated with the deposit request","examples":["org_RD2of9vs3XFodUSd8T5hW"]}},"title":"Organization"},{"anyOf":[{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"anyOf":[{"type":"object","required":["methodId","achId"],"properties":{"methodId":{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},"achId":{"type":"string"}},"title":"ACH DEBIT"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]}},"title":"US Instant"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]}},"title":"MX SPEI"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},"speed":{"anyOf":[{"type":"string","enum":["same-day"]},{"type":"string","enum":["next-day"]}],"description":"ACH settlement speed. Defaults to next-day if not specified.","examples":["same-day"]}},"title":"US ACH"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["SWIFT_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"SWIFT Wire"},{"type":"object","required":["methodId","purpose"],"properties":{"methodId":{"type":"string","enum":["US_WIRE"]},"senderMessage":{"type":"string","description":"Message from the sender to the beneficiary"},"beneficiaryReference":{"type":"string","description":"The reference to the beneficiary"},"purpose":{"type":"object","oneOf":[{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["EMPLOYEE"]},"scopeOfServices":{"type":"string"}},"title":"EMPLOYEE"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["CONTRACTOR"]},"scopeOfServices":{"type":"string"}},"title":"CONTRACTOR"},{"type":"object","required":["type","scopeOfServices"],"properties":{"type":{"type":"string","enum":["VENDOR"]},"scopeOfServices":{"type":"string"}},"title":"VENDOR"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["LANDLORD"]}},"title":"LANDLORD"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["TRANSFER_TO_SUBSIDIARY"]},"details":{"type":"string"}},"title":"TRANSFER_TO_SUBSIDIARY"},{"type":"object","required":["type","details"],"properties":{"type":{"type":"string","enum":["OTHER"]},"details":{"type":"string"},"website":{"type":"string"},"linkedin":{"type":"string"}},"title":"OTHER"}],"discriminator":{"propertyName":"type"}}},"title":"US Wire"},{"allOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]}}},{"type":"object","required":["country","withdrawalType"],"properties":{"channelId":{"type":"string","description":"The selected channel ID the user wants to run this transaction on, if not provided it will try to use the channel attached to the instruments network. If there is more than one channel attached one is required to be passed","examples":["4242b0d6-354d-4194-94c3-643ff444f282"]},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"withdrawalType":{"type":"string","enum":["bank","momo"]},"reason":{"type":"string","enum":["gift","bills","groceries","travel","health","entertainment","housing","school/fees","other"]},"kyc":{"type":"object","required":["name","country","phone","address","dob","email","idNumber","idType"],"properties":{"name":{"type":"string","description":"Full name of the user"},"country":{"type":"string","enum":["US","MX","KE","TG"],"title":"Withdrawal Countries"},"phone":{"type":"string","description":"Phone number with country prefix","examples":["+2348123456789"]},"address":{"type":"string","description":"Address of the user","examples":["123 Main St, Lagos, Nigeria"]},"dob":{"type":"string","description":"Date of birth in mm/dd/yyyy format"},"email":{"type":"string"},"idNumber":{"type":"string","description":"Number for the corresponding ID type"},"idType":{"type":"string","description":"ID type that is being used for KYC. Nigeria requires both National ID Number and BVN","examples":["national_id","passport"]}}}}}],"title":"AF MOMO + BANK"},{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]}},"title":"Wire Drawdown"}]},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}]}]},{"allOf":[{"type":"object","required":["id","paymentInstrumentId","status","sourceCurrency","targetCurrency","createdAt","wallet"],"properties":{"id":{"type":"string","description":"A unique identifier for a withdrawal quote","examples":["wdqt_rU9eQh&j2dkiI9yrwVC7s"]},"paymentInstrumentId":{"type":"string","description":"Unique identifier for the payment instrument associated with the withdrawal","examples":["pi_R0ThCHzs(j3FLTmONjYiS"]},"status":{"type":"string","enum":["ACTIVE","EXPIRED","ACCEPTED","REJECTED"]},"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"],"description":"The source currency funding the withdrawal"},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"],"description":"The target currency of the withdrawal"},"createdAt":{"type":"string","description":"Datetime the withdrawal quote was created","examples":["2023-10-23T06:20:04.366+00:00"]},"wallet":{"anyOf":[{"type":"object","required":["address","blockchain"],"properties":{"address":{"type":"string","description":"Blockchain address or account"},"blockchain":{"type":"string","description":"The blockchain upon which this address is associated","examples":["SOLANA"],"enum":["SOLANA"]}},"title":"Blockchain Wallet","description":"Blockchain wallet where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["PAYMENT_INSTRUMENT"]},"id":{"type":"string"}},"title":"Payment Instrument","description":"Wallet payment instrument where withdrawal funds will be sourced"},{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["LEDGER_ACCOUNT"]},"id":{"type":"string"}},"title":"Ledger Account","description":"Ledger account where withdrawal funds will be sourced"}]},"metadata":{"type":"object","description":"Metadata associated with the withdrawal quote (eg marketing data)","additionalProperties":{}},"deviceIpAddress":{"type":"string","description":"IP address of the device initiating the withdrawal"},"deviceLocation":{"type":"object","required":["source","lat","long"],"properties":{"source":{"type":"string","description":"The source data for the location capture","examples":["ip"],"enum":["ip"]},"lat":{"type":"number","description":"Latitude of the device","examples":[37.851]},"long":{"type":"number","description":"Longitude of the device","examples":[-96.822]}},"description":"Location of the device submitting transacting with the CFX network"}}},{"allOf":[{"type":"object","required":["methodId","sourceLedgerAccountId"],"properties":{"methodId":{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},"sourceLedgerAccountId":{"type":"string","description":"The ID of the source ledger account"}}},{"type":"object","required":["expiresAt","sourceAmount","sourceAmountAfterFees","targetAmount","targetAmountAfterFees","unsignedWithdrawalTransaction","fees"],"properties":{"providerQuoteId":{"type":"string","description":"Unique identifier provided by a CFX network provider"},"expiresAt":{"type":"string","description":"Datetime the withdrawal quote expires","examples":["2023-10-23T06:20:04.366+00:00"]},"sourceAmount":{"type":"number","description":"Source amount of the withdrawal quote","examples":[100]},"sourceAmountAfterFees":{"type":"number","deprecated":true,"description":"Approximate equivalent source amount after fees are deducted","examples":[99]},"targetAmount":{"type":"number","deprecated":true,"description":"Approximate target amount before fees are deducted","examples":[1855.32]},"targetAmountAfterFees":{"type":"number","description":"Equivalent target amount after fees are deducted","examples":[1851.12]},"unsignedWithdrawalTransaction":{"type":"string","description":"An unsigned Solana transaction associated with the withdrawal quote (base64 encoded buffer)"},"fees":{"type":"array","items":{"type":"object","required":["fee","type"],"properties":{"fee":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["USDC","MOVEUSD"]}}},"type":{"type":"string","enum":["CFX_FIXED_FEE","CFX_VARIABLE_FEE_PCT","PROVIDER_FIXED_FEE","PROVIDER_VARIABLE_FEE_PCT","CUSTOMER_FIXED_FEE","CUSTOMER_VARIABLE_FEE_PCT"]}}}}}}],"title":"BLOCKCHAIN"}]}]}]}]},"history":{"type":"array","items":{"anyOf":[{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["CREATED"]}},"title":"CREATED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["PENDING"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"PENDING"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["COMPLETED"]}},"title":"COMPLETED"},{"type":"object","required":["id","createdAt","status"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["FAILED"]}},"title":"FAILED"},{"type":"object","required":["id","createdAt","status","receipt"],"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"status":{"type":"string","enum":["RETURNED"]},"receipt":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"A unique ID for a withdrawal receipt instance","examples":["4Sb5a8gtvUXD1kqnCj8HRQw3Q15twjgbevB1hfXNMXb5QiQBympzVk(d4GWL3RrVSuGxxVv6769VFegYLtg1WnM2"]},"type":{"type":"string","description":"The type of receipt generated","examples":["SOLANA_TRANSACTION_SIGNATURE"],"enum":["SOLANA_TRANSACTION_SIGNATURE"]}}}},"title":"RETURNED"}]}}}},{"anyOf":[{"type":"object","required":["methodId"],"properties":{"methodId":{"type":"string","enum":["US_WIRE","SWIFT_WIRE"]},"imad":{"type":"string","description":"Input message accountability data. Available on successful wire."},"omad":{"type":"string","description":"Output message accountability data. May be available on successful wire."}}},{"type":"object","required":["methodId"],"properties":{"methodId":{"anyOf":[{"type":"string","description":"US ACH Direct Debit","examples":["ACH_PULL"],"enum":["ACH_PULL"]},{"type":"string","description":"US Instant Payment (RTP | FEDNOW)","examples":["US_INSTANT"],"enum":["US_INSTANT"]},{"type":"string","description":"Mexico SPEI","examples":["MX_SPEI"],"enum":["MX_SPEI"]},{"type":"string","description":"US Automated Clearing House","examples":["US_ACH"],"enum":["US_ACH"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]},{"type":"string","description":"African Bank or Mobile Money Withdrawal","examples":["AF_WITHDRAWAL"],"enum":["AF_WITHDRAWAL"]},{"type":"string","description":"US Wire Drawdown","examples":["US_WIRE_DRAWDOWN"],"enum":["US_WIRE_DRAWDOWN"]},{"type":"string","description":"Withdrawal to a blockchain address","examples":["BLOCKCHAIN"],"enum":["BLOCKCHAIN"]},{"type":"string","enum":["SWIFT_WIRE"]},{"type":"string","enum":["US_WIRE"]}]}}}]}]}]}]}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/rate":{"get":{"summary":"Get Withdrawal Rates","tags":["Rate"],"description":"Get the conversation rates for a source and target currency prior to a withdrawal.","parameters":[{"schema":{"type":"string","enum":["USDC","MOVEUSD"]},"in":"query","name":"sourceCurrency","required":true},{"schema":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"]},"in":"query","name":"targetCurrency","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["sourceCurrency","targetCurrency","fxRate"],"properties":{"sourceCurrency":{"type":"string","enum":["USDC","MOVEUSD"]},"targetCurrency":{"type":"string","enum":["USD","MXN","XOF","KES","AUD","HKD","JPY","NZD","SGD","SEK","CHF","CAD","GBP","CZK","DKK","EUR"]},"fxRate":{"type":"number","description":"The withdrawal rate available for the nominated source and target currencies","example":18.37}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/af/networks":{"get":{"summary":"Get Available Africa Withdrawal Networks","tags":["Africa","Networks"],"description":"Returns an array of available withdrawal networks for a given country","parameters":[{"schema":{"type":"string"},"in":"query","name":"country","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["status","channelIds","accountNumberType","id","country","name"],"properties":{"code":{"type":"string"},"status":{"type":"string"},"channelIds":{"type":"array","items":{"type":"string"}},"accountNumberType":{"type":"string"},"id":{"type":"string"},"country":{"type":"string"},"name":{"type":"string"}}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/usage":{"get":{"summary":"Get Withdrawal Usage","tags":["Withdrawal"],"description":"Retrieve withdrawal product usages for a given identity or organization.","parameters":[{"schema":{"type":"string"},"example":"id_VfsdSMtd8UdgxCgTnz0tm","in":"query","name":"identityId","required":false,"description":"Identity ID associated with the deposit request"},{"schema":{"type":"string"},"example":"org_RD2of9vs3XFodUSd8T5hW","in":"query","name":"organizationId","required":false,"description":"Organization ID associated with the deposit request"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["products","aggregated"],"properties":{"products":{"type":"array","items":{"allOf":[{"type":"object","required":["name","limits"],"properties":{"name":{"type":"string","enum":["organization.v1","identity.v1","card.physical_card.v1","card.virtual_card.v1","deposit.us_cash.v1","deposit.rtp.v1","deposit.us_bank_ach.v1","deposit.ach_credit.v1","deposit.us_wire.v1","deposit.swift_wire.v1","transfer.redemption.v1","swap.v1","withdraw.blockchain.v1","withdraw.ke_bank.v1","withdraw.ke_momo.v1","withdraw.mx_bank_spei.v1","withdraw.swift_wire.v1","withdraw.tg_momo.v1","withdraw.us_bank_ach.v1","withdraw.us_instant.v1","withdraw.us_wire.v1","withdraw.ach_pull.v1","withdraw.us_wire_drawdown.v1","account.virtual-account.v1"]},"limits":{"type":"object","required":["transactionMinUsd","transactionMaxUsd","limit24hMaxUsd","limit24hMaxCount","limit7dMaxUsd","limit7dMaxCount","limit30dMaxUsd","limit30dMaxCount","limitCalendarMonthMaxUsd","limitCalendarMonthMaxCount"],"properties":{"transactionMinUsd":{"type":"string","nullable":true},"transactionMaxUsd":{"type":"string","nullable":true},"limit24hMaxUsd":{"type":"string","nullable":true},"limit24hMaxCount":{"type":"string","nullable":true},"limit7dMaxUsd":{"type":"string","nullable":true},"limit7dMaxCount":{"type":"string","nullable":true},"limit30dMaxUsd":{"type":"string","nullable":true},"limit30dMaxCount":{"type":"string","nullable":true},"limitCalendarMonthMaxUsd":{"type":"string","nullable":true},"limitCalendarMonthMaxCount":{"type":"string","nullable":true}},"description":"Effective limits after evaluating all admin and customer limit rules against the entity. `null` means no limit on that dimension. All amounts are USD BigNumber strings."}}},{"type":"object","required":["usage24hUsd","usage24hCount","usage7dUsd","usage7dCount","usage30dUsd","usage30dCount","usageCalendarMonthUsd","usageCalendarMonthCount"],"properties":{"usage24hUsd":{"type":"string"},"usage24hCount":{"type":"string"},"usage7dUsd":{"type":"string"},"usage7dCount":{"type":"string"},"usage30dUsd":{"type":"string"},"usage30dCount":{"type":"string"},"usageCalendarMonthUsd":{"type":"string"},"usageCalendarMonthCount":{"type":"string"}},"description":"Effective usage by entity over rolling time windows, mirroring the dimensions in `TProductLimits`. All amounts are USD BigNumber strings; counts are integer-valued BigNumber strings."}]},"description":"CFX product"},"aggregated":{"type":"object","required":["usage24hUsd","usage24hCount","usage7dUsd","usage7dCount","usage30dUsd","usage30dCount","usageCalendarMonthUsd","usageCalendarMonthCount"],"properties":{"usage24hUsd":{"type":"string"},"usage24hCount":{"type":"string"},"usage7dUsd":{"type":"string"},"usage7dCount":{"type":"string"},"usage30dUsd":{"type":"string"},"usage30dCount":{"type":"string"},"usageCalendarMonthUsd":{"type":"string"},"usageCalendarMonthCount":{"type":"string"}},"description":"Effective usage by entity over rolling time windows, mirroring the dimensions in `TProductLimits`. All amounts are USD BigNumber strings; counts are integer-valued BigNumber strings."}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"404":{"description":"The resource was not found","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"title":"NOT_FOUND","description":"The resource was not found"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}},"/v1/withdrawal/af/channels":{"get":{"summary":"Get Available Africa Withdrawal Channels","tags":["Africa","Channels"],"description":"Returns an array of available withdrawal channels for a given country","parameters":[{"schema":{"type":"string"},"in":"query","name":"country","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["max","currency","status","feeLocal","createdAt","vendorId","country","feeUSD","min","channelType","rampType","updatedAt","id"],"properties":{"max":{"type":"number"},"currency":{"type":"string"},"status":{"type":"string"},"feeLocal":{"type":"number"},"createdAt":{"type":"string"},"vendorId":{"type":"string"},"country":{"type":"string"},"feeUSD":{"type":"number"},"min":{"type":"number"},"channelType":{"type":"string"},"rampType":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"}}}}}}},"400":{"description":"The service cannot understand the request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST"]},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":true}}},"title":"INVALID_REQUEST","description":"The service cannot understand the request"}}}},"401":{"description":"The access to this resource has been denied","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"type":"string"}},"title":"UNAUTHORIZED","description":"The access to this resource has been denied"}}}},"default":{"description":"Catch-all error response for any unexpected internal errors","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL"]},"message":{"type":"string","enum":["An unexpected internal error has occurred"]}},"title":"INTERNAL","description":"Catch-all error response for any unexpected internal errors"}}}}}}}},"servers":[{"url":"https://api.dev.cfx.to","description":"Customer Sandbox"},{"url":"https://api.cfx.to","description":"Production"}],"security":[{"ApiKeyAuth":[],"ApiSecretAuth":[]}],"tags":[{"name":"Withdraw"},{"name":"Withdraw > Estimate"},{"name":"Withdraw > Quote"},{"name":"Withdraw > Rate"},{"name":"Withdraw > Limits"}],"externalDocs":{"description":"Find out more about CFX","url":"https://www.cfxlabs.com/"}}