squarefi-bff-api-module 1.36.31 → 1.36.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6411,637 +6411,7 @@ export interface paths {
6411
6411
  patch?: never;
6412
6412
  trace?: never;
6413
6413
  };
6414
- "/v2/orders/L2F_WIRE_OFFRAMP": {
6415
- parameters: {
6416
- query?: never;
6417
- header?: never;
6418
- path?: never;
6419
- cookie?: never;
6420
- };
6421
- get?: never;
6422
- put?: never;
6423
- /**
6424
- * Create L2F wire offramp order with virtual account
6425
- * @description Create a wire transfer withdrawal order using Railio virtual account
6426
- */
6427
- post: {
6428
- parameters: {
6429
- query?: never;
6430
- header?: never;
6431
- path?: never;
6432
- cookie?: never;
6433
- };
6434
- requestBody: {
6435
- content: {
6436
- "application/json": {
6437
- /**
6438
- * @description Unique key to prevent duplicate transactions
6439
- * @example 123e4567-e89b-12d3-a456-426614174000
6440
- */
6441
- request_id: string;
6442
- /**
6443
- * @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id
6444
- * @example va_123456789
6445
- */
6446
- virtual_account_id?: string;
6447
- /**
6448
- * @description ID of the counterparty destination (where to send funds)
6449
- * @example dest_123456789
6450
- */
6451
- counterparty_destination_id: string;
6452
- /**
6453
- * @description Amount to withdraw
6454
- * @example 1000
6455
- */
6456
- amount: number;
6457
- /**
6458
- * @description Source wallet ID
6459
- * @example 8205c701-cd41-4929-910f-fccbb949729a
6460
- */
6461
- wallet_id: string;
6462
- /**
6463
- * @description Currency UUID
6464
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
6465
- */
6466
- from_currency_id: string;
6467
- /**
6468
- * @description Destination currency UUID (optional, defaults to from_currency_id)
6469
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
6470
- */
6471
- to_currency_id?: string;
6472
- /**
6473
- * @description Calculate in reverse (starting from the destination amount)
6474
- * @example false
6475
- */
6476
- is_reverse?: boolean;
6477
- /**
6478
- * @description Message to include when processing WIRE transfer
6479
- * @example Wire transfer reference
6480
- */
6481
- reference?: string;
6482
- /**
6483
- * @description Optional note for internal use
6484
- * @example L2F wire withdrawal
6485
- */
6486
- note?: string;
6487
- documents?: components["schemas"]["OrderDocuments"];
6488
- };
6489
- };
6490
- };
6491
- responses: {
6492
- /** @description Order successfully created */
6493
- 200: {
6494
- headers: {
6495
- [name: string]: unknown;
6496
- };
6497
- content: {
6498
- "application/json": {
6499
- /** @description Internal order ID */
6500
- id?: string;
6501
- /** @description Unique order identifier */
6502
- order_uuid?: string;
6503
- /** @description Idempotency key (duplicated on top level) */
6504
- request_id?: string;
6505
- wallet_uuid?: string;
6506
- from_uuid?: string;
6507
- to_uuid?: string;
6508
- /** @description Billing amount (amount debited from virtual account including fees) */
6509
- amount_from?: number;
6510
- /** @description Transaction amount (amount sent to counterparty destination) */
6511
- amount_to?: number;
6512
- /** @example L2F_WIRE_OFFRAMP */
6513
- order_type?: string;
6514
- /** @enum {string} */
6515
- status?: "PENDING" | "PROCESSING" | "COMPLETE" | "FAILED";
6516
- /** @description Always null for L2F orders */
6517
- sub_account_id?: string | null;
6518
- /** Format: date-time */
6519
- created_at?: string;
6520
- /**
6521
- * Format: date-time
6522
- * @description Last update timestamp
6523
- */
6524
- updated_at?: string;
6525
- /** @description Human-readable order description */
6526
- info?: string;
6527
- meta?: {
6528
- /** @description Internal order ID (duplicates top-level id) */
6529
- order_id?: string;
6530
- order_uuid?: string;
6531
- request_id?: string;
6532
- /** @description Always null for fiat orders */
6533
- chain_id?: number | null;
6534
- /** @description Network fee (0 for fiat) */
6535
- network_fee?: number;
6536
- network_fee_currency?: string | null;
6537
- /** @description Exchange rate applied */
6538
- exchange_rate?: number;
6539
- /** @description Same as amount_from - total amount debited */
6540
- billing_amount?: number;
6541
- /** @description Same as amount_to - amount sent to destination */
6542
- transaction_amount?: number;
6543
- virtual_account_id?: string;
6544
- /** @description Name of the virtual account */
6545
- virtual_account_name?: string | null;
6546
- /** @description Railio vendor account ID */
6547
- vendor_account_id?: string;
6548
- /** @description ID from counterparty_destinations table */
6549
- counterparty_destination_id?: string;
6550
- /** @description ID from counterparty_accounts table */
6551
- counterparty_account_id?: string;
6552
- /** @description Name from counterparty_accounts table */
6553
- counterparty_account_name?: string;
6554
- /** @description Nickname from counterparty_destinations table */
6555
- counterparty_account_nickname?: string | null;
6556
- /** @description Reference message included in the transfer */
6557
- reference?: string | null;
6558
- /** @description Internal note */
6559
- note?: string | null;
6560
- /** @description Workflow type (e.g., L2F_WIRE_OFFRAMP) */
6561
- workflow_type?: string;
6562
- /** @description Current workflow status (typically INITIALIZED on creation) */
6563
- workflow_status?: string;
6564
- /**
6565
- * Format: date-time
6566
- * @description When workflow status was last updated
6567
- */
6568
- workflow_status_updated_at?: string;
6569
- /** @description Processing method (qstash for async) */
6570
- processing_type?: string;
6571
- /**
6572
- * Format: date-time
6573
- * @description When processing started
6574
- */
6575
- processing_started_at?: string;
6576
- /** @description QStash message ID for async processing */
6577
- qstash_message_id?: string;
6578
- };
6579
- };
6580
- };
6581
- };
6582
- /** @description Bad request - validation error */
6583
- 400: {
6584
- headers: {
6585
- [name: string]: unknown;
6586
- };
6587
- content: {
6588
- "application/json": {
6589
- error?: string;
6590
- };
6591
- };
6592
- };
6593
- /** @description Server error */
6594
- 500: {
6595
- headers: {
6596
- [name: string]: unknown;
6597
- };
6598
- content: {
6599
- "application/json": {
6600
- error?: string;
6601
- };
6602
- };
6603
- };
6604
- };
6605
- };
6606
- delete?: never;
6607
- options?: never;
6608
- head?: never;
6609
- patch?: never;
6610
- trace?: never;
6611
- };
6612
- "/v2/orders/L2F_ACH_OFFRAMP": {
6613
- parameters: {
6614
- query?: never;
6615
- header?: never;
6616
- path?: never;
6617
- cookie?: never;
6618
- };
6619
- get?: never;
6620
- put?: never;
6621
- /**
6622
- * Create L2F ACH offramp order with virtual account
6623
- * @description Create an ACH transfer withdrawal order using Railio virtual account
6624
- */
6625
- post: {
6626
- parameters: {
6627
- query?: never;
6628
- header?: never;
6629
- path?: never;
6630
- cookie?: never;
6631
- };
6632
- requestBody: {
6633
- content: {
6634
- "application/json": {
6635
- /**
6636
- * @description Unique key to prevent duplicate transactions
6637
- * @example 123e4567-e89b-12d3-a456-426614174000
6638
- */
6639
- request_id: string;
6640
- /**
6641
- * @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id
6642
- * @example va_123456789
6643
- */
6644
- virtual_account_id?: string;
6645
- /**
6646
- * @description ID of the counterparty destination (where to send funds)
6647
- * @example dest_123456789
6648
- */
6649
- counterparty_destination_id: string;
6650
- /**
6651
- * @description Amount to withdraw
6652
- * @example 1000
6653
- */
6654
- amount: number;
6655
- /**
6656
- * @description Source wallet ID
6657
- * @example 8205c701-cd41-4929-910f-fccbb949729a
6658
- */
6659
- wallet_id: string;
6660
- /**
6661
- * @description Currency UUID
6662
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
6663
- */
6664
- from_currency_id: string;
6665
- /**
6666
- * @description Destination currency UUID (optional, defaults to from_currency_id)
6667
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
6668
- */
6669
- to_currency_id?: string;
6670
- /**
6671
- * @description Calculate in reverse (starting from the destination amount)
6672
- * @example false
6673
- */
6674
- is_reverse?: boolean;
6675
- /**
6676
- * @description Reference message to include when processing ACH transfer
6677
- * @example PAY 12345
6678
- */
6679
- reference?: string;
6680
- /**
6681
- * @description Optional note for internal use
6682
- * @example L2F ACH withdrawal
6683
- */
6684
- note?: string;
6685
- documents?: components["schemas"]["OrderDocuments"];
6686
- };
6687
- };
6688
- };
6689
- responses: {
6690
- /** @description Order successfully created */
6691
- 200: {
6692
- headers: {
6693
- [name: string]: unknown;
6694
- };
6695
- content: {
6696
- "application/json": {
6697
- /** @description Internal order ID */
6698
- id?: string;
6699
- /** @description Unique order identifier */
6700
- order_uuid?: string;
6701
- /** @description Idempotency key (duplicated on top level) */
6702
- request_id?: string;
6703
- wallet_uuid?: string;
6704
- from_uuid?: string;
6705
- to_uuid?: string;
6706
- /** @description Billing amount (amount debited from virtual account including fees) */
6707
- amount_from?: number;
6708
- /** @description Transaction amount (amount sent to counterparty destination) */
6709
- amount_to?: number;
6710
- /** @example L2F_ACH_OFFRAMP */
6711
- order_type?: string;
6712
- /** @enum {string} */
6713
- status?: "PENDING" | "PROCESSING" | "COMPLETE" | "FAILED";
6714
- /** @description Always null for L2F orders */
6715
- sub_account_id?: string | null;
6716
- /** Format: date-time */
6717
- created_at?: string;
6718
- /**
6719
- * Format: date-time
6720
- * @description Last update timestamp
6721
- */
6722
- updated_at?: string;
6723
- /** @description Human-readable order description */
6724
- info?: string;
6725
- meta?: {
6726
- /** @description Internal order ID (duplicates top-level id) */
6727
- order_id?: string;
6728
- order_uuid?: string;
6729
- request_id?: string;
6730
- /** @description Always null for fiat orders */
6731
- chain_id?: number | null;
6732
- /** @description Network fee (0 for fiat) */
6733
- network_fee?: number;
6734
- network_fee_currency?: string | null;
6735
- /** @description Exchange rate applied */
6736
- exchange_rate?: number;
6737
- /** @description Same as amount_from - total amount debited */
6738
- billing_amount?: number;
6739
- /** @description Same as amount_to - amount sent to destination */
6740
- transaction_amount?: number;
6741
- virtual_account_id?: string;
6742
- /** @description Name of the virtual account */
6743
- virtual_account_name?: string | null;
6744
- /** @description Railio vendor account ID */
6745
- vendor_account_id?: string;
6746
- /** @description ID from counterparty_destinations table */
6747
- counterparty_destination_id?: string;
6748
- /** @description ID from counterparty_accounts table */
6749
- counterparty_account_id?: string;
6750
- /** @description Name from counterparty_accounts table */
6751
- counterparty_account_name?: string;
6752
- /** @description Nickname from counterparty_destinations table */
6753
- counterparty_account_nickname?: string | null;
6754
- /** @description Reference message included in the transfer */
6755
- reference?: string | null;
6756
- /** @description Internal note */
6757
- note?: string | null;
6758
- /** @description Workflow type (e.g., L2F_ACH_OFFRAMP) */
6759
- workflow_type?: string;
6760
- /** @description Current workflow status (typically INITIALIZED on creation) */
6761
- workflow_status?: string;
6762
- /**
6763
- * Format: date-time
6764
- * @description When workflow status was last updated
6765
- */
6766
- workflow_status_updated_at?: string;
6767
- /** @description Processing method (qstash for async) */
6768
- processing_type?: string;
6769
- /**
6770
- * Format: date-time
6771
- * @description When processing started
6772
- */
6773
- processing_started_at?: string;
6774
- /** @description QStash message ID for async processing */
6775
- qstash_message_id?: string;
6776
- };
6777
- };
6778
- };
6779
- };
6780
- /** @description Bad request - validation error */
6781
- 400: {
6782
- headers: {
6783
- [name: string]: unknown;
6784
- };
6785
- content: {
6786
- "application/json": {
6787
- error?: string;
6788
- };
6789
- };
6790
- };
6791
- /** @description Server error */
6792
- 500: {
6793
- headers: {
6794
- [name: string]: unknown;
6795
- };
6796
- content: {
6797
- "application/json": {
6798
- error?: string;
6799
- };
6800
- };
6801
- };
6802
- };
6803
- };
6804
- delete?: never;
6805
- options?: never;
6806
- head?: never;
6807
- patch?: never;
6808
- trace?: never;
6809
- };
6810
- "/v2/orders/BRL_WIRE_OFFRAMP": {
6811
- parameters: {
6812
- query?: never;
6813
- header?: never;
6814
- path?: never;
6815
- cookie?: never;
6816
- };
6817
- get?: never;
6818
- put?: never;
6819
- /**
6820
- * Create Brale FedWire offramp order (USD)
6821
- * @description Submit a stablecoin → USD wire transfer via Brale. Body shape mirrors
6822
- * L2F_WIRE_OFFRAMP — `virtual_account_id` (Brale automation VA) is the
6823
- * source of funds (the Brale-managed stablecoin address), and
6824
- * `counterparty_destination_id` is the destination bank account
6825
- * (must be a US bank with `type = FEDWIRE`).
6826
- *
6827
- * The actual on-rail send goes from the VA's stablecoin balance to the
6828
- * beneficiary US bank account via Brale's `wire` rail. Bank address
6829
- * registration with Brale is performed lazily and cached.
6830
- *
6831
- */
6832
- post: {
6833
- parameters: {
6834
- query?: never;
6835
- header?: never;
6836
- path?: never;
6837
- cookie?: never;
6838
- };
6839
- requestBody: {
6840
- content: {
6841
- "application/json": {
6842
- /** @description Idempotency key for the order. */
6843
- request_id: string;
6844
- /** @description Brale VA id. Auto-populated when omitted. */
6845
- virtual_account_id?: string;
6846
- /** @description US bank destination (must be FEDWIRE type). */
6847
- counterparty_destination_id: string;
6848
- /** @description Amount to disburse in USD. */
6849
- amount: number;
6850
- wallet_id: string;
6851
- /** @description Source currency UUID (debited from user wallet). */
6852
- from_currency_id: string;
6853
- /** @description Destination currency UUID (USD). */
6854
- to_currency_id?: string;
6855
- is_reverse?: boolean;
6856
- /** @description FedWire memo (truncated to 50 chars). */
6857
- reference?: string;
6858
- note?: string;
6859
- documents?: components["schemas"]["OrderDocuments"];
6860
- };
6861
- };
6862
- };
6863
- responses: {
6864
- /** @description Order successfully created. */
6865
- 200: {
6866
- headers: {
6867
- [name: string]: unknown;
6868
- };
6869
- content?: never;
6870
- };
6871
- /** @description Validation error. */
6872
- 400: {
6873
- headers: {
6874
- [name: string]: unknown;
6875
- };
6876
- content?: never;
6877
- };
6878
- /** @description Server error. */
6879
- 500: {
6880
- headers: {
6881
- [name: string]: unknown;
6882
- };
6883
- content?: never;
6884
- };
6885
- };
6886
- };
6887
- delete?: never;
6888
- options?: never;
6889
- head?: never;
6890
- patch?: never;
6891
- trace?: never;
6892
- };
6893
- "/v2/orders/BRL_ACH_OFFRAMP": {
6894
- parameters: {
6895
- query?: never;
6896
- header?: never;
6897
- path?: never;
6898
- cookie?: never;
6899
- };
6900
- get?: never;
6901
- put?: never;
6902
- /**
6903
- * Create Brale ACH offramp order (USD)
6904
- * @description Submit a stablecoin → USD ACH transfer via Brale. Behaves identically
6905
- * to BRL_WIRE_OFFRAMP except the destination rail is `ach_credit`
6906
- * (Brale's outbound ACH product) and `counterparty_destination_id`
6907
- * must reference a destination of type `ACH`. Brale-side rail
6908
- * selection (ach_credit vs same_day_ach_credit vs rtp_credit) is
6909
- * made at send time; the destination is registered with all three
6910
- * sub-rails so we can switch later without re-registering the bank.
6911
- *
6912
- */
6913
- post: {
6914
- parameters: {
6915
- query?: never;
6916
- header?: never;
6917
- path?: never;
6918
- cookie?: never;
6919
- };
6920
- requestBody: {
6921
- content: {
6922
- "application/json": {
6923
- request_id: string;
6924
- virtual_account_id?: string;
6925
- /** @description US bank destination (must be ACH type). */
6926
- counterparty_destination_id: string;
6927
- amount: number;
6928
- wallet_id: string;
6929
- from_currency_id: string;
6930
- to_currency_id?: string;
6931
- is_reverse?: boolean;
6932
- /** @description ACH memo (truncated at the rail's 10-char limit). */
6933
- reference?: string;
6934
- note?: string;
6935
- documents?: components["schemas"]["OrderDocuments"];
6936
- };
6937
- };
6938
- };
6939
- responses: {
6940
- /** @description Order successfully created. */
6941
- 200: {
6942
- headers: {
6943
- [name: string]: unknown;
6944
- };
6945
- content?: never;
6946
- };
6947
- /** @description Validation error. */
6948
- 400: {
6949
- headers: {
6950
- [name: string]: unknown;
6951
- };
6952
- content?: never;
6953
- };
6954
- /** @description Server error. */
6955
- 500: {
6956
- headers: {
6957
- [name: string]: unknown;
6958
- };
6959
- content?: never;
6960
- };
6961
- };
6962
- };
6963
- delete?: never;
6964
- options?: never;
6965
- head?: never;
6966
- patch?: never;
6967
- trace?: never;
6968
- };
6969
- "/v2/orders/BRL_RTP_OFFRAMP": {
6970
- parameters: {
6971
- query?: never;
6972
- header?: never;
6973
- path?: never;
6974
- cookie?: never;
6975
- };
6976
- get?: never;
6977
- put?: never;
6978
- /**
6979
- * Create Brale RTP offramp order (USD)
6980
- * @description Submit a stablecoin → USD RTP transfer via Brale. Behaves like
6981
- * BRL_ACH_OFFRAMP except the destination rail is `rtp_credit`
6982
- * (Real-Time Payments — settles in minutes, available 24/7
6983
- * including weekends and holidays). The destination must reference
6984
- * a counterparty of type `ACH` whose Brale external address has
6985
- * had RTP eligibility confirmed by Brale's banking partner — that
6986
- * confirmation is asynchronous and is reflected by `rtp_credit`
6987
- * appearing in the address's `transfer_types`. The workflow
6988
- * refuses to send if RTP is not yet enabled, in which case the
6989
- * caller can retry shortly or fall back to BRL_ACH_OFFRAMP.
6990
- *
6991
- */
6992
- post: {
6993
- parameters: {
6994
- query?: never;
6995
- header?: never;
6996
- path?: never;
6997
- cookie?: never;
6998
- };
6999
- requestBody: {
7000
- content: {
7001
- "application/json": {
7002
- request_id: string;
7003
- counterparty_destination_id: string;
7004
- amount: number;
7005
- wallet_id: string;
7006
- from_currency_id: string;
7007
- to_currency_id?: string;
7008
- virtual_account_id: string;
7009
- reference?: string;
7010
- note?: string;
7011
- };
7012
- };
7013
- };
7014
- responses: {
7015
- /** @description Order successfully created. */
7016
- 200: {
7017
- headers: {
7018
- [name: string]: unknown;
7019
- };
7020
- content?: never;
7021
- };
7022
- /** @description Validation error. */
7023
- 400: {
7024
- headers: {
7025
- [name: string]: unknown;
7026
- };
7027
- content?: never;
7028
- };
7029
- /** @description Server error. */
7030
- 500: {
7031
- headers: {
7032
- [name: string]: unknown;
7033
- };
7034
- content?: never;
7035
- };
7036
- };
7037
- };
7038
- delete?: never;
7039
- options?: never;
7040
- head?: never;
7041
- patch?: never;
7042
- trace?: never;
7043
- };
7044
- "/v2/orders/DLS_WIRE_OFFRAMP": {
6414
+ "/v2/orders/BRL_WIRE_OFFRAMP": {
7045
6415
  parameters: {
7046
6416
  query?: never;
7047
6417
  header?: never;
@@ -7051,13 +6421,16 @@ export interface paths {
7051
6421
  get?: never;
7052
6422
  put?: never;
7053
6423
  /**
7054
- * Create Delos FedWire offramp order (USD)
7055
- * @description Submit a USD domestic wire withdrawal via Delos Financial. Body shape
7056
- * mirrors BRL_WIRE_OFFRAMP — `virtual_account_id` (Delos VA, source of
7057
- * funds) is REQUIRED, and `counterparty_destination_id` must reference a
7058
- * US bank destination of type `FEDWIRE`. Beneficiary registration with
7059
- * Delos is performed lazily and cached; the workflow waits for
7060
- * Delos-side beneficiary verification before submitting the payout.
6424
+ * Create Brale FedWire offramp order (USD)
6425
+ * @description Submit a stablecoin → USD wire transfer via Brale. Body shape mirrors
6426
+ * L2F_WIRE_OFFRAMP — `virtual_account_id` (Brale automation VA) is the
6427
+ * source of funds (the Brale-managed stablecoin address), and
6428
+ * `counterparty_destination_id` is the destination bank account
6429
+ * (must be a US bank with `type = FEDWIRE`).
6430
+ *
6431
+ * The actual on-rail send goes from the VA's stablecoin balance to the
6432
+ * beneficiary US bank account via Brale's `wire` rail. Bank address
6433
+ * registration with Brale is performed lazily and cached.
7061
6434
  *
7062
6435
  */
7063
6436
  post: {
@@ -7070,17 +6443,21 @@ export interface paths {
7070
6443
  requestBody: {
7071
6444
  content: {
7072
6445
  "application/json": {
6446
+ /** @description Idempotency key for the order. */
7073
6447
  request_id: string;
7074
- /** @description Delos virtual account (source of funds). */
7075
- virtual_account_id: string;
6448
+ /** @description Brale VA id. Auto-populated when omitted. */
6449
+ virtual_account_id?: string;
7076
6450
  /** @description US bank destination (must be FEDWIRE type). */
7077
6451
  counterparty_destination_id: string;
7078
6452
  /** @description Amount to disburse in USD. */
7079
6453
  amount: number;
7080
6454
  wallet_id: string;
6455
+ /** @description Source currency UUID (debited from user wallet). */
7081
6456
  from_currency_id: string;
6457
+ /** @description Destination currency UUID (USD). */
7082
6458
  to_currency_id?: string;
7083
- /** @description Free-form payment note (sent as Delos comment). */
6459
+ is_reverse?: boolean;
6460
+ /** @description FedWire memo (truncated to 50 chars). */
7084
6461
  reference?: string;
7085
6462
  note?: string;
7086
6463
  documents?: components["schemas"]["OrderDocuments"];
@@ -7117,7 +6494,7 @@ export interface paths {
7117
6494
  patch?: never;
7118
6495
  trace?: never;
7119
6496
  };
7120
- "/v2/orders/DLS_ACH_OFFRAMP": {
6497
+ "/v2/orders/BRL_ACH_OFFRAMP": {
7121
6498
  parameters: {
7122
6499
  query?: never;
7123
6500
  header?: never;
@@ -7127,10 +6504,14 @@ export interface paths {
7127
6504
  get?: never;
7128
6505
  put?: never;
7129
6506
  /**
7130
- * Create Delos ACH offramp order (USD)
7131
- * @description Submit a USD ACH withdrawal via Delos Financial. Identical to
7132
- * DLS_WIRE_OFFRAMP except `counterparty_destination_id` must reference
7133
- * a destination of type `ACH`.
6507
+ * Create Brale ACH offramp order (USD)
6508
+ * @description Submit a stablecoin → USD ACH transfer via Brale. Behaves identically
6509
+ * to BRL_WIRE_OFFRAMP except the destination rail is `ach_credit`
6510
+ * (Brale's outbound ACH product) and `counterparty_destination_id`
6511
+ * must reference a destination of type `ACH`. Brale-side rail
6512
+ * selection (ach_credit vs same_day_ach_credit vs rtp_credit) is
6513
+ * made at send time; the destination is registered with all three
6514
+ * sub-rails so we can switch later without re-registering the bank.
7134
6515
  *
7135
6516
  */
7136
6517
  post: {
@@ -7144,13 +6525,15 @@ export interface paths {
7144
6525
  content: {
7145
6526
  "application/json": {
7146
6527
  request_id: string;
7147
- virtual_account_id: string;
6528
+ virtual_account_id?: string;
7148
6529
  /** @description US bank destination (must be ACH type). */
7149
6530
  counterparty_destination_id: string;
7150
6531
  amount: number;
7151
6532
  wallet_id: string;
7152
6533
  from_currency_id: string;
7153
6534
  to_currency_id?: string;
6535
+ is_reverse?: boolean;
6536
+ /** @description ACH memo (truncated at the rail's 10-char limit). */
7154
6537
  reference?: string;
7155
6538
  note?: string;
7156
6539
  documents?: components["schemas"]["OrderDocuments"];
@@ -7187,7 +6570,7 @@ export interface paths {
7187
6570
  patch?: never;
7188
6571
  trace?: never;
7189
6572
  };
7190
- "/v2/orders/DLS_SEPA_OFFRAMP": {
6573
+ "/v2/orders/BRL_RTP_OFFRAMP": {
7191
6574
  parameters: {
7192
6575
  query?: never;
7193
6576
  header?: never;
@@ -7197,10 +6580,17 @@ export interface paths {
7197
6580
  get?: never;
7198
6581
  put?: never;
7199
6582
  /**
7200
- * Create Delos SEPA offramp order (EUR)
7201
- * @description Submit a EUR SEPA Credit Transfer withdrawal via Delos Financial.
7202
- * `counterparty_destination_id` must reference a destination of type
7203
- * `SEPA` (IBAN required).
6583
+ * Create Brale RTP offramp order (USD)
6584
+ * @description Submit a stablecoin USD RTP transfer via Brale. Behaves like
6585
+ * BRL_ACH_OFFRAMP except the destination rail is `rtp_credit`
6586
+ * (Real-Time Payments — settles in minutes, available 24/7
6587
+ * including weekends and holidays). The destination must reference
6588
+ * a counterparty of type `ACH` whose Brale external address has
6589
+ * had RTP eligibility confirmed by Brale's banking partner — that
6590
+ * confirmation is asynchronous and is reflected by `rtp_credit`
6591
+ * appearing in the address's `transfer_types`. The workflow
6592
+ * refuses to send if RTP is not yet enabled, in which case the
6593
+ * caller can retry shortly or fall back to BRL_ACH_OFFRAMP.
7204
6594
  *
7205
6595
  */
7206
6596
  post: {
@@ -7214,16 +6604,14 @@ export interface paths {
7214
6604
  content: {
7215
6605
  "application/json": {
7216
6606
  request_id: string;
7217
- virtual_account_id: string;
7218
- /** @description SEPA destination (IBAN required). */
7219
6607
  counterparty_destination_id: string;
7220
6608
  amount: number;
7221
6609
  wallet_id: string;
7222
6610
  from_currency_id: string;
7223
6611
  to_currency_id?: string;
6612
+ virtual_account_id: string;
7224
6613
  reference?: string;
7225
6614
  note?: string;
7226
- documents?: components["schemas"]["OrderDocuments"];
7227
6615
  };
7228
6616
  };
7229
6617
  };
@@ -7257,7 +6645,7 @@ export interface paths {
7257
6645
  patch?: never;
7258
6646
  trace?: never;
7259
6647
  };
7260
- "/v2/orders/DLS_SWIFT_OFFRAMP": {
6648
+ "/v2/orders/DLS_WIRE_OFFRAMP": {
7261
6649
  parameters: {
7262
6650
  query?: never;
7263
6651
  header?: never;
@@ -7267,12 +6655,13 @@ export interface paths {
7267
6655
  get?: never;
7268
6656
  put?: never;
7269
6657
  /**
7270
- * Create Delos SWIFT offramp order (USD/EUR/GBP)
7271
- * @description Submit an international SWIFT withdrawal via Delos Financial.
7272
- * `counterparty_destination_id` must reference a destination of type
7273
- * `SWIFT` (SWIFT/BIC required; bank address with country required for
7274
- * regional routing). GBP payouts use this route until Delos confirms a
7275
- * local UK rail (FPS/CHAPS).
6658
+ * Create Delos FedWire offramp order (USD)
6659
+ * @description Submit a USD domestic wire withdrawal via Delos Financial. Body shape
6660
+ * mirrors BRL_WIRE_OFFRAMP — `virtual_account_id` (Delos VA, source of
6661
+ * funds) is REQUIRED, and `counterparty_destination_id` must reference a
6662
+ * US bank destination of type `FEDWIRE`. Beneficiary registration with
6663
+ * Delos is performed lazily and cached; the workflow waits for
6664
+ * Delos-side beneficiary verification before submitting the payout.
7276
6665
  *
7277
6666
  */
7278
6667
  post: {
@@ -7286,238 +6675,43 @@ export interface paths {
7286
6675
  content: {
7287
6676
  "application/json": {
7288
6677
  request_id: string;
6678
+ /** @description Delos virtual account (source of funds). */
7289
6679
  virtual_account_id: string;
7290
- /** @description SWIFT destination (BIC + bank country required). */
7291
- counterparty_destination_id: string;
7292
- amount: number;
7293
- wallet_id: string;
7294
- from_currency_id: string;
7295
- to_currency_id?: string;
7296
- reference?: string;
7297
- note?: string;
7298
- documents?: components["schemas"]["OrderDocuments"];
7299
- };
7300
- };
7301
- };
7302
- responses: {
7303
- /** @description Order successfully created. */
7304
- 200: {
7305
- headers: {
7306
- [name: string]: unknown;
7307
- };
7308
- content?: never;
7309
- };
7310
- /** @description Validation error. */
7311
- 400: {
7312
- headers: {
7313
- [name: string]: unknown;
7314
- };
7315
- content?: never;
7316
- };
7317
- /** @description Server error. */
7318
- 500: {
7319
- headers: {
7320
- [name: string]: unknown;
7321
- };
7322
- content?: never;
7323
- };
7324
- };
7325
- };
7326
- delete?: never;
7327
- options?: never;
7328
- head?: never;
7329
- patch?: never;
7330
- trace?: never;
7331
- };
7332
- "/v2/orders/L2F_SEPA_OFFRAMP": {
7333
- parameters: {
7334
- query?: never;
7335
- header?: never;
7336
- path?: never;
7337
- cookie?: never;
7338
- };
7339
- get?: never;
7340
- put?: never;
7341
- /**
7342
- * Create L2F SEPA offramp order with virtual account
7343
- * @description Create a SEPA transfer withdrawal order using Railio virtual account
7344
- */
7345
- post: {
7346
- parameters: {
7347
- query?: never;
7348
- header?: never;
7349
- path?: never;
7350
- cookie?: never;
7351
- };
7352
- requestBody: {
7353
- content: {
7354
- "application/json": {
7355
- /**
7356
- * @description Unique key to prevent duplicate transactions
7357
- * @example 123e4567-e89b-12d3-a456-426614174000
7358
- */
7359
- request_id: string;
7360
- /**
7361
- * @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id
7362
- * @example va_123456789
7363
- */
7364
- virtual_account_id?: string;
7365
- /**
7366
- * @description ID of the counterparty destination (where to send funds)
7367
- * @example dest_123456789
7368
- */
6680
+ /** @description US bank destination (must be FEDWIRE type). */
7369
6681
  counterparty_destination_id: string;
7370
- /**
7371
- * @description Amount to withdraw
7372
- * @example 1000
7373
- */
7374
- amount: number;
7375
- /**
7376
- * @description Source wallet ID
7377
- * @example 8205c701-cd41-4929-910f-fccbb949729a
7378
- */
7379
- wallet_id: string;
7380
- /**
7381
- * @description Currency UUID
7382
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
7383
- */
7384
- from_currency_id: string;
7385
- /**
7386
- * @description Destination currency UUID (optional, defaults to from_currency_id)
7387
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
7388
- */
7389
- to_currency_id?: string;
7390
- /**
7391
- * @description Calculate in reverse (starting from the destination amount)
7392
- * @example false
7393
- */
7394
- is_reverse?: boolean;
7395
- /**
7396
- * @description Reference message to include when processing SEPA transfer
7397
- * @example Invoice 123456
7398
- */
6682
+ /** @description Amount to disburse in USD. */
6683
+ amount: number;
6684
+ wallet_id: string;
6685
+ from_currency_id: string;
6686
+ to_currency_id?: string;
6687
+ /** @description Free-form payment note (sent as Delos comment). */
7399
6688
  reference?: string;
7400
- /**
7401
- * @description Optional note for internal use
7402
- * @example L2F SEPA withdrawal
7403
- */
7404
6689
  note?: string;
7405
6690
  documents?: components["schemas"]["OrderDocuments"];
7406
6691
  };
7407
6692
  };
7408
6693
  };
7409
6694
  responses: {
7410
- /** @description Order successfully created */
6695
+ /** @description Order successfully created. */
7411
6696
  200: {
7412
6697
  headers: {
7413
6698
  [name: string]: unknown;
7414
6699
  };
7415
- content: {
7416
- "application/json": {
7417
- /** @description Internal order ID */
7418
- id?: string;
7419
- /** @description Unique order identifier */
7420
- order_uuid?: string;
7421
- /** @description Idempotency key (duplicated on top level) */
7422
- request_id?: string;
7423
- wallet_uuid?: string;
7424
- from_uuid?: string;
7425
- to_uuid?: string;
7426
- /** @description Billing amount (amount debited from virtual account including fees) */
7427
- amount_from?: number;
7428
- /** @description Transaction amount (amount sent to counterparty destination) */
7429
- amount_to?: number;
7430
- /** @example L2F_SEPA_OFFRAMP */
7431
- order_type?: string;
7432
- /** @enum {string} */
7433
- status?: "PENDING" | "PROCESSING" | "COMPLETE" | "FAILED";
7434
- /** @description Always null for L2F orders */
7435
- sub_account_id?: string | null;
7436
- /** Format: date-time */
7437
- created_at?: string;
7438
- /**
7439
- * Format: date-time
7440
- * @description Last update timestamp
7441
- */
7442
- updated_at?: string;
7443
- /** @description Human-readable order description */
7444
- info?: string;
7445
- meta?: {
7446
- /** @description Internal order ID (duplicates top-level id) */
7447
- order_id?: string;
7448
- order_uuid?: string;
7449
- request_id?: string;
7450
- /** @description Always null for fiat orders */
7451
- chain_id?: number | null;
7452
- /** @description Network fee (0 for fiat) */
7453
- network_fee?: number;
7454
- network_fee_currency?: string | null;
7455
- /** @description Exchange rate applied */
7456
- exchange_rate?: number;
7457
- /** @description Same as amount_from - total amount debited */
7458
- billing_amount?: number;
7459
- /** @description Same as amount_to - amount sent to destination */
7460
- transaction_amount?: number;
7461
- virtual_account_id?: string;
7462
- /** @description Name of the virtual account */
7463
- virtual_account_name?: string | null;
7464
- /** @description Railio vendor account ID */
7465
- vendor_account_id?: string;
7466
- /** @description ID from counterparty_destinations table */
7467
- counterparty_destination_id?: string;
7468
- /** @description ID from counterparty_accounts table */
7469
- counterparty_account_id?: string;
7470
- /** @description Name from counterparty_accounts table */
7471
- counterparty_account_name?: string;
7472
- /** @description Nickname from counterparty_destinations table */
7473
- counterparty_account_nickname?: string | null;
7474
- /** @description Reference message included in the transfer */
7475
- reference?: string | null;
7476
- /** @description Internal note */
7477
- note?: string | null;
7478
- /** @description Workflow type (e.g., L2F_SEPA_OFFRAMP) */
7479
- workflow_type?: string;
7480
- /** @description Current workflow status (typically INITIALIZED on creation) */
7481
- workflow_status?: string;
7482
- /**
7483
- * Format: date-time
7484
- * @description When workflow status was last updated
7485
- */
7486
- workflow_status_updated_at?: string;
7487
- /** @description Processing method (qstash for async) */
7488
- processing_type?: string;
7489
- /**
7490
- * Format: date-time
7491
- * @description When processing started
7492
- */
7493
- processing_started_at?: string;
7494
- /** @description QStash message ID for async processing */
7495
- qstash_message_id?: string;
7496
- };
7497
- };
7498
- };
6700
+ content?: never;
7499
6701
  };
7500
- /** @description Bad request - validation error */
6702
+ /** @description Validation error. */
7501
6703
  400: {
7502
6704
  headers: {
7503
6705
  [name: string]: unknown;
7504
6706
  };
7505
- content: {
7506
- "application/json": {
7507
- error?: string;
7508
- };
7509
- };
6707
+ content?: never;
7510
6708
  };
7511
- /** @description Server error */
6709
+ /** @description Server error. */
7512
6710
  500: {
7513
6711
  headers: {
7514
6712
  [name: string]: unknown;
7515
6713
  };
7516
- content: {
7517
- "application/json": {
7518
- error?: string;
7519
- };
7520
- };
6714
+ content?: never;
7521
6715
  };
7522
6716
  };
7523
6717
  };
@@ -7527,7 +6721,7 @@ export interface paths {
7527
6721
  patch?: never;
7528
6722
  trace?: never;
7529
6723
  };
7530
- "/v2/orders/L2F_SWIFT_OFFRAMP": {
6724
+ "/v2/orders/DLS_ACH_OFFRAMP": {
7531
6725
  parameters: {
7532
6726
  query?: never;
7533
6727
  header?: never;
@@ -7537,8 +6731,11 @@ export interface paths {
7537
6731
  get?: never;
7538
6732
  put?: never;
7539
6733
  /**
7540
- * Create L2F SWIFT offramp order with virtual account
7541
- * @description Create a SWIFT transfer withdrawal order using Railio virtual account
6734
+ * Create Delos ACH offramp order (USD)
6735
+ * @description Submit a USD ACH withdrawal via Delos Financial. Identical to
6736
+ * DLS_WIRE_OFFRAMP except `counterparty_destination_id` must reference
6737
+ * a destination of type `ACH`.
6738
+ *
7542
6739
  */
7543
6740
  post: {
7544
6741
  parameters: {
@@ -7550,172 +6747,41 @@ export interface paths {
7550
6747
  requestBody: {
7551
6748
  content: {
7552
6749
  "application/json": {
7553
- /**
7554
- * @description Unique key to prevent duplicate transactions
7555
- * @example 123e4567-e89b-12d3-a456-426614174000
7556
- */
7557
6750
  request_id: string;
7558
- /**
7559
- * @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id
7560
- * @example va_123456789
7561
- */
7562
- virtual_account_id?: string;
7563
- /**
7564
- * @description ID of the counterparty destination (where to send funds)
7565
- * @example dest_123456789
7566
- */
6751
+ virtual_account_id: string;
6752
+ /** @description US bank destination (must be ACH type). */
7567
6753
  counterparty_destination_id: string;
7568
- /**
7569
- * @description Amount to withdraw
7570
- * @example 1000
7571
- */
7572
6754
  amount: number;
7573
- /**
7574
- * @description Source wallet ID
7575
- * @example 8205c701-cd41-4929-910f-fccbb949729a
7576
- */
7577
6755
  wallet_id: string;
7578
- /**
7579
- * @description Currency UUID
7580
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
7581
- */
7582
6756
  from_currency_id: string;
7583
- /**
7584
- * @description Destination currency UUID (optional, defaults to from_currency_id)
7585
- * @example 509eca03-bc0d-4a38-b7dc-d136d2bdaa43
7586
- */
7587
6757
  to_currency_id?: string;
7588
- /**
7589
- * @description Calculate in reverse (starting from the destination amount)
7590
- * @example false
7591
- */
7592
- is_reverse?: boolean;
7593
- /**
7594
- * @description Reference message to include when processing SWIFT transfer
7595
- * @example International wire ref
7596
- */
7597
6758
  reference?: string;
7598
- /**
7599
- * @description Optional note for internal use
7600
- * @example L2F SWIFT withdrawal
7601
- */
7602
6759
  note?: string;
7603
6760
  documents?: components["schemas"]["OrderDocuments"];
7604
6761
  };
7605
6762
  };
7606
6763
  };
7607
6764
  responses: {
7608
- /** @description Order successfully created */
6765
+ /** @description Order successfully created. */
7609
6766
  200: {
7610
6767
  headers: {
7611
6768
  [name: string]: unknown;
7612
6769
  };
7613
- content: {
7614
- "application/json": {
7615
- /** @description Internal order ID */
7616
- id?: string;
7617
- /** @description Unique order identifier */
7618
- order_uuid?: string;
7619
- /** @description Idempotency key (duplicated on top level) */
7620
- request_id?: string;
7621
- wallet_uuid?: string;
7622
- from_uuid?: string;
7623
- to_uuid?: string;
7624
- /** @description Billing amount (amount debited from virtual account including fees) */
7625
- amount_from?: number;
7626
- /** @description Transaction amount (amount sent to counterparty destination) */
7627
- amount_to?: number;
7628
- /** @example L2F_SWIFT_OFFRAMP */
7629
- order_type?: string;
7630
- /** @enum {string} */
7631
- status?: "PENDING" | "PROCESSING" | "COMPLETE" | "FAILED";
7632
- /** @description Always null for L2F orders */
7633
- sub_account_id?: string | null;
7634
- /** Format: date-time */
7635
- created_at?: string;
7636
- /**
7637
- * Format: date-time
7638
- * @description Last update timestamp
7639
- */
7640
- updated_at?: string;
7641
- /** @description Human-readable order description */
7642
- info?: string;
7643
- meta?: {
7644
- /** @description Internal order ID (duplicates top-level id) */
7645
- order_id?: string;
7646
- order_uuid?: string;
7647
- request_id?: string;
7648
- /** @description Always null for fiat orders */
7649
- chain_id?: number | null;
7650
- /** @description Network fee (0 for fiat) */
7651
- network_fee?: number;
7652
- network_fee_currency?: string | null;
7653
- /** @description Exchange rate applied */
7654
- exchange_rate?: number;
7655
- /** @description Same as amount_from - total amount debited */
7656
- billing_amount?: number;
7657
- /** @description Same as amount_to - amount sent to destination */
7658
- transaction_amount?: number;
7659
- virtual_account_id?: string;
7660
- /** @description Name of the virtual account */
7661
- virtual_account_name?: string | null;
7662
- /** @description Railio vendor account ID */
7663
- vendor_account_id?: string;
7664
- /** @description ID from counterparty_destinations table */
7665
- counterparty_destination_id?: string;
7666
- /** @description ID from counterparty_accounts table */
7667
- counterparty_account_id?: string;
7668
- /** @description Name from counterparty_accounts table */
7669
- counterparty_account_name?: string;
7670
- /** @description Nickname from counterparty_destinations table */
7671
- counterparty_account_nickname?: string | null;
7672
- /** @description Reference message included in the transfer */
7673
- reference?: string | null;
7674
- /** @description Internal note */
7675
- note?: string | null;
7676
- /** @description Workflow type (e.g., L2F_SWIFT_OFFRAMP) */
7677
- workflow_type?: string;
7678
- /** @description Current workflow status (typically INITIALIZED on creation) */
7679
- workflow_status?: string;
7680
- /**
7681
- * Format: date-time
7682
- * @description When workflow status was last updated
7683
- */
7684
- workflow_status_updated_at?: string;
7685
- /** @description Processing method (qstash for async) */
7686
- processing_type?: string;
7687
- /**
7688
- * Format: date-time
7689
- * @description When processing started
7690
- */
7691
- processing_started_at?: string;
7692
- /** @description QStash message ID for async processing */
7693
- qstash_message_id?: string;
7694
- };
7695
- };
7696
- };
6770
+ content?: never;
7697
6771
  };
7698
- /** @description Bad request - validation error */
6772
+ /** @description Validation error. */
7699
6773
  400: {
7700
6774
  headers: {
7701
6775
  [name: string]: unknown;
7702
6776
  };
7703
- content: {
7704
- "application/json": {
7705
- error?: string;
7706
- };
7707
- };
6777
+ content?: never;
7708
6778
  };
7709
- /** @description Server error */
6779
+ /** @description Server error. */
7710
6780
  500: {
7711
6781
  headers: {
7712
6782
  [name: string]: unknown;
7713
6783
  };
7714
- content: {
7715
- "application/json": {
7716
- error?: string;
7717
- };
7718
- };
6784
+ content?: never;
7719
6785
  };
7720
6786
  };
7721
6787
  };
@@ -7725,7 +6791,7 @@ export interface paths {
7725
6791
  patch?: never;
7726
6792
  trace?: never;
7727
6793
  };
7728
- "/v2/orders/L2F_CHAPS_OFFRAMP": {
6794
+ "/v2/orders/DLS_SEPA_OFFRAMP": {
7729
6795
  parameters: {
7730
6796
  query?: never;
7731
6797
  header?: never;
@@ -7735,8 +6801,11 @@ export interface paths {
7735
6801
  get?: never;
7736
6802
  put?: never;
7737
6803
  /**
7738
- * Create L2F CHAPS offramp order with virtual account
7739
- * @description Create a CHAPS transfer withdrawal order using Railio virtual account
6804
+ * Create Delos SEPA offramp order (EUR)
6805
+ * @description Submit a EUR SEPA Credit Transfer withdrawal via Delos Financial.
6806
+ * `counterparty_destination_id` must reference a destination of type
6807
+ * `SEPA` (IBAN required).
6808
+ *
7740
6809
  */
7741
6810
  post: {
7742
6811
  parameters: {
@@ -7748,52 +6817,36 @@ export interface paths {
7748
6817
  requestBody: {
7749
6818
  content: {
7750
6819
  "application/json": {
7751
- /**
7752
- * @description Unique key to prevent duplicate transactions
7753
- * @example 123e4567-e89b-12d3-a456-426614174000
7754
- */
7755
6820
  request_id: string;
7756
- /** @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id */
7757
- virtual_account_id?: string;
7758
- /** @description ID of the counterparty destination (where to send funds) */
6821
+ virtual_account_id: string;
6822
+ /** @description SEPA destination (IBAN required). */
7759
6823
  counterparty_destination_id: string;
7760
- /**
7761
- * @description Amount to withdraw
7762
- * @example 1000
7763
- */
7764
6824
  amount: number;
7765
- /** @description Source wallet ID */
7766
6825
  wallet_id: string;
7767
- /** @description Currency UUID */
7768
6826
  from_currency_id: string;
7769
- /** @description Destination currency UUID (optional, defaults to from_currency_id) */
7770
6827
  to_currency_id?: string;
7771
- /** @description Calculate in reverse (starting from the destination amount) */
7772
- is_reverse?: boolean;
7773
- /** @description Reference message to include when processing CHAPS transfer */
7774
6828
  reference?: string;
7775
- /** @description Optional note for internal use */
7776
6829
  note?: string;
7777
6830
  documents?: components["schemas"]["OrderDocuments"];
7778
6831
  };
7779
6832
  };
7780
6833
  };
7781
6834
  responses: {
7782
- /** @description Order successfully created */
6835
+ /** @description Order successfully created. */
7783
6836
  200: {
7784
6837
  headers: {
7785
6838
  [name: string]: unknown;
7786
6839
  };
7787
6840
  content?: never;
7788
6841
  };
7789
- /** @description Bad request - validation error */
6842
+ /** @description Validation error. */
7790
6843
  400: {
7791
6844
  headers: {
7792
6845
  [name: string]: unknown;
7793
6846
  };
7794
6847
  content?: never;
7795
6848
  };
7796
- /** @description Server error */
6849
+ /** @description Server error. */
7797
6850
  500: {
7798
6851
  headers: {
7799
6852
  [name: string]: unknown;
@@ -7808,7 +6861,7 @@ export interface paths {
7808
6861
  patch?: never;
7809
6862
  trace?: never;
7810
6863
  };
7811
- "/v2/orders/L2F_FPS_OFFRAMP": {
6864
+ "/v2/orders/DLS_SWIFT_OFFRAMP": {
7812
6865
  parameters: {
7813
6866
  query?: never;
7814
6867
  header?: never;
@@ -7818,8 +6871,13 @@ export interface paths {
7818
6871
  get?: never;
7819
6872
  put?: never;
7820
6873
  /**
7821
- * Create L2F FPS offramp order with virtual account
7822
- * @description Create an FPS transfer withdrawal order using Railio virtual account
6874
+ * Create Delos SWIFT offramp order (USD/EUR/GBP)
6875
+ * @description Submit an international SWIFT withdrawal via Delos Financial.
6876
+ * `counterparty_destination_id` must reference a destination of type
6877
+ * `SWIFT` (SWIFT/BIC required; bank address with country required for
6878
+ * regional routing). GBP payouts use this route until Delos confirms a
6879
+ * local UK rail (FPS/CHAPS).
6880
+ *
7823
6881
  */
7824
6882
  post: {
7825
6883
  parameters: {
@@ -7831,52 +6889,36 @@ export interface paths {
7831
6889
  requestBody: {
7832
6890
  content: {
7833
6891
  "application/json": {
7834
- /**
7835
- * @description Unique key to prevent duplicate transactions
7836
- * @example 123e4567-e89b-12d3-a456-426614174000
7837
- */
7838
6892
  request_id: string;
7839
- /** @description ID of the virtual account (source of funds). If not provided, will be auto-selected based on wallet_id and from_currency_id */
7840
- virtual_account_id?: string;
7841
- /** @description ID of the counterparty destination (where to send funds) */
6893
+ virtual_account_id: string;
6894
+ /** @description SWIFT destination (BIC + bank country required). */
7842
6895
  counterparty_destination_id: string;
7843
- /**
7844
- * @description Amount to withdraw
7845
- * @example 1000
7846
- */
7847
6896
  amount: number;
7848
- /** @description Source wallet ID */
7849
6897
  wallet_id: string;
7850
- /** @description Currency UUID */
7851
6898
  from_currency_id: string;
7852
- /** @description Destination currency UUID (optional, defaults to from_currency_id) */
7853
6899
  to_currency_id?: string;
7854
- /** @description Calculate in reverse (starting from the destination amount) */
7855
- is_reverse?: boolean;
7856
- /** @description Reference message to include when processing FPS transfer */
7857
6900
  reference?: string;
7858
- /** @description Optional note for internal use */
7859
6901
  note?: string;
7860
6902
  documents?: components["schemas"]["OrderDocuments"];
7861
6903
  };
7862
6904
  };
7863
6905
  };
7864
6906
  responses: {
7865
- /** @description Order successfully created */
6907
+ /** @description Order successfully created. */
7866
6908
  200: {
7867
6909
  headers: {
7868
6910
  [name: string]: unknown;
7869
6911
  };
7870
6912
  content?: never;
7871
6913
  };
7872
- /** @description Bad request - validation error */
6914
+ /** @description Validation error. */
7873
6915
  400: {
7874
6916
  headers: {
7875
6917
  [name: string]: unknown;
7876
6918
  };
7877
6919
  content?: never;
7878
6920
  };
7879
- /** @description Server error */
6921
+ /** @description Server error. */
7880
6922
  500: {
7881
6923
  headers: {
7882
6924
  [name: string]: unknown;
@@ -8583,7 +7625,7 @@ export interface components {
8583
7625
  * @example EXCHANGE_OMNI
8584
7626
  * @enum {string}
8585
7627
  */
8586
- OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
7628
+ OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "BC1_SEPA_ONRAMP" | "BC1_SEPA_OFFRAMP" | "BC1_SWIFT_ONRAMP" | "BC1_SWIFT_OFFRAMP" | "BC3_SEPA_ONRAMP" | "BC3_SEPA_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
8587
7629
  /** @description Order type reference with optional product guardrails, associated KYC rails and tenant billing rates */
8588
7630
  OrderType: {
8589
7631
  /** @description Order type identifier (e.g. EXCHANGE, WITHDRAWAL_CRYPTO) */