{"openapi":"3.1.0","info":{"title":"STONS API","version":"1"},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key"}},"schemas":{}},"paths":{"/v1/addresses":{"post":{"summary":"Permanent deposit address of a user (per_user merchants)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_user_id":{"type":"string","pattern":"^[\\x21-\\x7E]{1,200}$"},"network":{"type":"string","enum":["tron"]}},"required":["external_user_id","network"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"network":{"type":"string","enum":["tron"]},"assets":{"type":"array","items":{"type":"string"}}},"required":["address","network","assets"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/invoices":{"post":{"summary":"Create an invoice, or return the existing invoice of the same order","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order_id":{"type":"string","pattern":"^[\\x21-\\x7E]{1,200}$"},"asset":{"type":"string","pattern":"^[A-Z0-9]+_[A-Z0-9]+$"},"amount":{"type":"string","minLength":1,"maxLength":100},"expires_in":{"type":"integer","minimum":60,"maximum":604800},"external_user_id":{"type":"string","pattern":"^[\\x21-\\x7E]{1,200}$"},"return_url":{"type":"string"},"cancel_url":{"type":"string"}},"required":["order_id","asset","amount","expires_in"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"order_id":{"type":"string"},"status":{"type":"string","enum":["created","seen","confirmed","underpaid","expired","paid_late","settled"]},"asset":{"type":"string"},"network":{"type":"string"},"address":{"type":"string"},"amount_requested":{"type":"string"},"amount_expected":{"type":"string"},"amount_received":{"type":"string"},"amount_credited":{"type":"string"},"fees":{"type":"object","properties":{"service":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"percent":{"type":"string"},"amount":{"type":"string"}},"required":["payer","percent","amount"],"additionalProperties":false},"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"quote":{"type":"null"},"quote_rate":{"type":"null"},"actual":{"type":"null"},"status":{"type":"string","enum":["included"]}},"required":["payer","quote","quote_rate","actual","status"],"additionalProperties":false}},"required":["service","network"],"additionalProperties":false},"external_user_id":{"type":["string","null"]},"return_url":{"type":["string","null"]},"cancel_url":{"type":["string","null"]},"checkout_url":{"type":["string","null"]},"expires_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"deposits":{"type":"array","items":{"type":"object","properties":{"tx_hash":{"type":"string"},"amount":{"type":"string"},"confirmations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["seen","confirmed"]},"block_time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"late":{"type":"boolean"}},"required":["tx_hash","amount","confirmations","status","block_time","late"],"additionalProperties":false}}},"required":["invoice_id","order_id","status","asset","network","address","amount_requested","amount_expected","amount_received","amount_credited","fees","external_user_id","return_url","cancel_url","checkout_url","expires_at","created_at","deposits"],"additionalProperties":false}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"order_id":{"type":"string"},"status":{"type":"string","enum":["created","seen","confirmed","underpaid","expired","paid_late","settled"]},"asset":{"type":"string"},"network":{"type":"string"},"address":{"type":"string"},"amount_requested":{"type":"string"},"amount_expected":{"type":"string"},"amount_received":{"type":"string"},"amount_credited":{"type":"string"},"fees":{"type":"object","properties":{"service":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"percent":{"type":"string"},"amount":{"type":"string"}},"required":["payer","percent","amount"],"additionalProperties":false},"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"quote":{"type":"null"},"quote_rate":{"type":"null"},"actual":{"type":"null"},"status":{"type":"string","enum":["included"]}},"required":["payer","quote","quote_rate","actual","status"],"additionalProperties":false}},"required":["service","network"],"additionalProperties":false},"external_user_id":{"type":["string","null"]},"return_url":{"type":["string","null"]},"cancel_url":{"type":["string","null"]},"checkout_url":{"type":["string","null"]},"expires_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"deposits":{"type":"array","items":{"type":"object","properties":{"tx_hash":{"type":"string"},"amount":{"type":"string"},"confirmations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["seen","confirmed"]},"block_time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"late":{"type":"boolean"}},"required":["tx_hash","amount","confirmations","status","block_time","late"],"additionalProperties":false}}},"required":["invoice_id","order_id","status","asset","network","address","amount_requested","amount_expected","amount_received","amount_credited","fees","external_user_id","return_url","cancel_url","checkout_url","expires_at","created_at","deposits"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/invoices/{id}":{"get":{"summary":"Current state of an invoice","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"order_id":{"type":"string"},"status":{"type":"string","enum":["created","seen","confirmed","underpaid","expired","paid_late","settled"]},"asset":{"type":"string"},"network":{"type":"string"},"address":{"type":"string"},"amount_requested":{"type":"string"},"amount_expected":{"type":"string"},"amount_received":{"type":"string"},"amount_credited":{"type":"string"},"fees":{"type":"object","properties":{"service":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"percent":{"type":"string"},"amount":{"type":"string"}},"required":["payer","percent","amount"],"additionalProperties":false},"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant","customer"]},"quote":{"type":"null"},"quote_rate":{"type":"null"},"actual":{"type":"null"},"status":{"type":"string","enum":["included"]}},"required":["payer","quote","quote_rate","actual","status"],"additionalProperties":false}},"required":["service","network"],"additionalProperties":false},"external_user_id":{"type":["string","null"]},"return_url":{"type":["string","null"]},"cancel_url":{"type":["string","null"]},"checkout_url":{"type":["string","null"]},"expires_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"deposits":{"type":"array","items":{"type":"object","properties":{"tx_hash":{"type":"string"},"amount":{"type":"string"},"confirmations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["seen","confirmed"]},"block_time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"late":{"type":"boolean"}},"required":["tx_hash","amount","confirmations","status","block_time","late"],"additionalProperties":false}}},"required":["invoice_id","order_id","status","asset","network","address","amount_requested","amount_expected","amount_received","amount_credited","fees","external_user_id","return_url","cancel_url","checkout_url","expires_at","created_at","deposits"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/payouts":{"post":{"summary":"Create a payout to a whitelisted address, or return the existing one of the same reference","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string","pattern":"^[\\x21-\\x7E]{1,200}$"},"asset":{"type":"string","pattern":"^[A-Z0-9]+_[A-Z0-9]+$"},"to_address":{"type":"string","pattern":"^[0-9A-Za-z]{20,100}$"},"amount":{"type":"string","minLength":1,"maxLength":100}},"required":["reference","asset","to_address","amount"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"payout_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string"},"status":{"type":"string","enum":["pending_review","approved","queued","signing","broadcast","confirmed","rejected","failed"]},"asset":{"type":"string"},"network":{"type":"string"},"to_address":{"type":"string"},"amount":{"type":"string"},"fees":{"type":"object","properties":{"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant"]},"amount":{"type":"string"},"charged":{"type":"string"}},"required":["payer","amount","charged"],"additionalProperties":false}},"required":["network"],"additionalProperties":false},"review_reasons":{"type":"array","items":{"type":"string"}},"tx_hash":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["payout_id","reference","status","asset","network","to_address","amount","fees","review_reasons","tx_hash","created_at","updated_at"],"additionalProperties":false}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"payout_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string"},"status":{"type":"string","enum":["pending_review","approved","queued","signing","broadcast","confirmed","rejected","failed"]},"asset":{"type":"string"},"network":{"type":"string"},"to_address":{"type":"string"},"amount":{"type":"string"},"fees":{"type":"object","properties":{"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant"]},"amount":{"type":"string"},"charged":{"type":"string"}},"required":["payer","amount","charged"],"additionalProperties":false}},"required":["network"],"additionalProperties":false},"review_reasons":{"type":"array","items":{"type":"string"}},"tx_hash":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["payout_id","reference","status","asset","network","to_address","amount","fees","review_reasons","tx_hash","created_at","updated_at"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/v1/payouts/{id}":{"get":{"summary":"Current state of a payout","parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"payout_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string"},"status":{"type":"string","enum":["pending_review","approved","queued","signing","broadcast","confirmed","rejected","failed"]},"asset":{"type":"string"},"network":{"type":"string"},"to_address":{"type":"string"},"amount":{"type":"string"},"fees":{"type":"object","properties":{"network":{"type":"object","properties":{"payer":{"type":"string","enum":["merchant"]},"amount":{"type":"string"},"charged":{"type":"string"}},"required":["payer","amount","charged"],"additionalProperties":false}},"required":["network"],"additionalProperties":false},"review_reasons":{"type":"array","items":{"type":"string"}},"tx_hash":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["payout_id","reference","status","asset","network","to_address","amount","fees","review_reasons","tx_hash","created_at","updated_at"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request","validation_failed","unauthorized","merchant_disabled","merchant_not_approved","route_not_found","invoice_not_found","payout_not_found","merchant_not_found","api_key_not_found","delivery_not_found","delivery_not_failed","asset_not_found","asset_flag_locked","address_mode_mismatch","asset_not_supported","asset_not_payable","asset_payments_disabled","asset_disabled_by_merchant","asset_payouts_disabled","amount_below_minimum","network_fee_payer_not_supported","network_fee_quote_unavailable","service_fee_confirmation_required","service_fee_valid_from_in_past","payout_fee_confirmation_required","payout_fee_valid_from_in_past","redirect_url_not_allowed","order_id_conflict","reference_conflict","address_not_whitelisted","payouts_halted","addresses_exhausted","rate_limited","internal_error","service_unavailable"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}}},"security":[{"apiKey":[]}]}