@augustusbank/typescript-sdk 0.21.0 → 0.22.1

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.
Files changed (216) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/client.d.mts +12 -6
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +12 -6
  5. package/client.d.ts.map +1 -1
  6. package/client.js +6 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +6 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account-holders.d.mts +1555 -1184
  12. package/resources/account-holders.d.mts.map +1 -1
  13. package/resources/account-holders.d.ts +1555 -1184
  14. package/resources/account-holders.d.ts.map +1 -1
  15. package/resources/account-holders.js +59 -0
  16. package/resources/account-holders.js.map +1 -1
  17. package/resources/account-holders.mjs +59 -0
  18. package/resources/account-holders.mjs.map +1 -1
  19. package/resources/account-programs.d.mts +22 -17
  20. package/resources/account-programs.d.mts.map +1 -1
  21. package/resources/account-programs.d.ts +22 -17
  22. package/resources/account-programs.d.ts.map +1 -1
  23. package/resources/account-programs.js +2 -2
  24. package/resources/account-programs.js.map +1 -1
  25. package/resources/account-programs.mjs +2 -2
  26. package/resources/account-programs.mjs.map +1 -1
  27. package/resources/accounts.d.mts +226 -48
  28. package/resources/accounts.d.mts.map +1 -1
  29. package/resources/accounts.d.ts +226 -48
  30. package/resources/accounts.d.ts.map +1 -1
  31. package/resources/accounts.js +55 -2
  32. package/resources/accounts.js.map +1 -1
  33. package/resources/accounts.mjs +55 -2
  34. package/resources/accounts.mjs.map +1 -1
  35. package/resources/api-keys.d.mts +1 -1
  36. package/resources/api-keys.d.mts.map +1 -1
  37. package/resources/api-keys.d.ts +1 -1
  38. package/resources/api-keys.d.ts.map +1 -1
  39. package/resources/api-versions.d.mts +3 -0
  40. package/resources/api-versions.d.mts.map +1 -1
  41. package/resources/api-versions.d.ts +3 -0
  42. package/resources/api-versions.d.ts.map +1 -1
  43. package/resources/conversions.d.mts +36 -81
  44. package/resources/conversions.d.mts.map +1 -1
  45. package/resources/conversions.d.ts +36 -81
  46. package/resources/conversions.d.ts.map +1 -1
  47. package/resources/conversions.js +25 -1
  48. package/resources/conversions.js.map +1 -1
  49. package/resources/conversions.mjs +25 -1
  50. package/resources/conversions.mjs.map +1 -1
  51. package/resources/counterparties.d.mts +1042 -0
  52. package/resources/counterparties.d.mts.map +1 -0
  53. package/resources/counterparties.d.ts +1042 -0
  54. package/resources/counterparties.d.ts.map +1 -0
  55. package/resources/counterparties.js +45 -0
  56. package/resources/counterparties.js.map +1 -0
  57. package/resources/counterparties.mjs +41 -0
  58. package/resources/counterparties.mjs.map +1 -0
  59. package/resources/deposits.d.mts +48 -186
  60. package/resources/deposits.d.mts.map +1 -1
  61. package/resources/deposits.d.ts +48 -186
  62. package/resources/deposits.d.ts.map +1 -1
  63. package/resources/events.d.mts +3 -3
  64. package/resources/events.d.mts.map +1 -1
  65. package/resources/events.d.ts +3 -3
  66. package/resources/events.d.ts.map +1 -1
  67. package/resources/index.d.mts +5 -3
  68. package/resources/index.d.mts.map +1 -1
  69. package/resources/index.d.ts +5 -3
  70. package/resources/index.d.ts.map +1 -1
  71. package/resources/index.js +5 -1
  72. package/resources/index.js.map +1 -1
  73. package/resources/index.mjs +2 -0
  74. package/resources/index.mjs.map +1 -1
  75. package/resources/payouts.d.mts +133 -335
  76. package/resources/payouts.d.mts.map +1 -1
  77. package/resources/payouts.d.ts +133 -335
  78. package/resources/payouts.d.ts.map +1 -1
  79. package/resources/payouts.js +25 -0
  80. package/resources/payouts.js.map +1 -1
  81. package/resources/payouts.mjs +25 -0
  82. package/resources/payouts.mjs.map +1 -1
  83. package/resources/quotes/indicative.d.mts +7 -11
  84. package/resources/quotes/indicative.d.mts.map +1 -1
  85. package/resources/quotes/indicative.d.ts +7 -11
  86. package/resources/quotes/indicative.d.ts.map +1 -1
  87. package/resources/quotes/quotes.d.mts +4 -8
  88. package/resources/quotes/quotes.d.mts.map +1 -1
  89. package/resources/quotes/quotes.d.ts +4 -8
  90. package/resources/quotes/quotes.d.ts.map +1 -1
  91. package/resources/quotes/quotes.js.map +1 -1
  92. package/resources/quotes/quotes.mjs.map +1 -1
  93. package/resources/returns.d.mts +84 -39
  94. package/resources/returns.d.mts.map +1 -1
  95. package/resources/returns.d.ts +84 -39
  96. package/resources/returns.d.ts.map +1 -1
  97. package/resources/returns.js +22 -0
  98. package/resources/returns.js.map +1 -1
  99. package/resources/returns.mjs +22 -0
  100. package/resources/returns.mjs.map +1 -1
  101. package/resources/scopes.d.mts +4 -1
  102. package/resources/scopes.d.mts.map +1 -1
  103. package/resources/scopes.d.ts +4 -1
  104. package/resources/scopes.d.ts.map +1 -1
  105. package/resources/simulations/account-programs.d.mts +215 -0
  106. package/resources/simulations/account-programs.d.mts.map +1 -0
  107. package/resources/simulations/account-programs.d.ts +215 -0
  108. package/resources/simulations/account-programs.d.ts.map +1 -0
  109. package/resources/simulations/account-programs.js +96 -0
  110. package/resources/simulations/account-programs.js.map +1 -0
  111. package/resources/simulations/account-programs.mjs +92 -0
  112. package/resources/simulations/account-programs.mjs.map +1 -0
  113. package/resources/simulations/accounts.d.mts +209 -0
  114. package/resources/simulations/accounts.d.mts.map +1 -0
  115. package/resources/simulations/accounts.d.ts +209 -0
  116. package/resources/simulations/accounts.d.ts.map +1 -0
  117. package/resources/simulations/accounts.js +90 -0
  118. package/resources/simulations/accounts.js.map +1 -0
  119. package/resources/simulations/accounts.mjs +86 -0
  120. package/resources/simulations/accounts.mjs.map +1 -0
  121. package/resources/simulations/conversions.d.mts +54 -0
  122. package/resources/simulations/conversions.d.mts.map +1 -0
  123. package/resources/simulations/conversions.d.ts +54 -0
  124. package/resources/simulations/conversions.d.ts.map +1 -0
  125. package/resources/simulations/conversions.js +39 -0
  126. package/resources/simulations/conversions.js.map +1 -0
  127. package/resources/simulations/conversions.mjs +35 -0
  128. package/resources/simulations/conversions.mjs.map +1 -0
  129. package/resources/simulations/deposits.d.mts +202 -0
  130. package/resources/simulations/deposits.d.mts.map +1 -0
  131. package/resources/simulations/deposits.d.ts +202 -0
  132. package/resources/simulations/deposits.d.ts.map +1 -0
  133. package/resources/simulations/deposits.js +25 -0
  134. package/resources/simulations/deposits.js.map +1 -0
  135. package/resources/simulations/deposits.mjs +21 -0
  136. package/resources/simulations/deposits.mjs.map +1 -0
  137. package/resources/simulations/index.d.mts +7 -0
  138. package/resources/simulations/index.d.mts.map +1 -0
  139. package/resources/simulations/index.d.ts +7 -0
  140. package/resources/simulations/index.d.ts.map +1 -0
  141. package/resources/simulations/index.js +17 -0
  142. package/resources/simulations/index.js.map +1 -0
  143. package/resources/simulations/index.mjs +8 -0
  144. package/resources/simulations/index.mjs.map +1 -0
  145. package/resources/simulations/payouts.d.mts +62 -0
  146. package/resources/simulations/payouts.d.mts.map +1 -0
  147. package/resources/simulations/payouts.d.ts +62 -0
  148. package/resources/simulations/payouts.d.ts.map +1 -0
  149. package/resources/simulations/payouts.js +39 -0
  150. package/resources/simulations/payouts.js.map +1 -0
  151. package/resources/simulations/payouts.mjs +35 -0
  152. package/resources/simulations/payouts.mjs.map +1 -0
  153. package/resources/simulations/simulations.d.mts +26 -0
  154. package/resources/simulations/simulations.d.mts.map +1 -0
  155. package/resources/simulations/simulations.d.ts +26 -0
  156. package/resources/simulations/simulations.d.ts.map +1 -0
  157. package/resources/simulations/simulations.js +33 -0
  158. package/resources/simulations/simulations.js.map +1 -0
  159. package/resources/simulations/simulations.mjs +28 -0
  160. package/resources/simulations/simulations.mjs.map +1 -0
  161. package/resources/simulations.d.mts +2 -0
  162. package/resources/simulations.d.mts.map +1 -0
  163. package/resources/simulations.d.ts +2 -0
  164. package/resources/simulations.d.ts.map +1 -0
  165. package/resources/simulations.js +6 -0
  166. package/resources/simulations.js.map +1 -0
  167. package/resources/simulations.mjs +3 -0
  168. package/resources/simulations.mjs.map +1 -0
  169. package/resources/transactions.d.mts +342 -162
  170. package/resources/transactions.d.mts.map +1 -1
  171. package/resources/transactions.d.ts +342 -162
  172. package/resources/transactions.d.ts.map +1 -1
  173. package/resources/webhook-subscriptions.d.mts +61 -11
  174. package/resources/webhook-subscriptions.d.mts.map +1 -1
  175. package/resources/webhook-subscriptions.d.ts +61 -11
  176. package/resources/webhook-subscriptions.d.ts.map +1 -1
  177. package/resources/webhook-subscriptions.js +49 -0
  178. package/resources/webhook-subscriptions.js.map +1 -1
  179. package/resources/webhook-subscriptions.mjs +49 -0
  180. package/resources/webhook-subscriptions.mjs.map +1 -1
  181. package/resources/webhooks.d.mts +976 -978
  182. package/resources/webhooks.d.mts.map +1 -1
  183. package/resources/webhooks.d.ts +976 -978
  184. package/resources/webhooks.d.ts.map +1 -1
  185. package/src/client.ts +48 -8
  186. package/src/resources/account-holders.ts +1701 -1282
  187. package/src/resources/account-programs.ts +30 -19
  188. package/src/resources/accounts.ts +265 -50
  189. package/src/resources/api-keys.ts +3 -0
  190. package/src/resources/api-versions.ts +3 -0
  191. package/src/resources/conversions.ts +36 -93
  192. package/src/resources/counterparties.ts +3127 -0
  193. package/src/resources/deposits.ts +66 -269
  194. package/src/resources/events.ts +18 -12
  195. package/src/resources/index.ts +21 -4
  196. package/src/resources/payouts.ts +204 -439
  197. package/src/resources/quotes/indicative.ts +7 -12
  198. package/src/resources/quotes/quotes.ts +4 -9
  199. package/src/resources/returns.ts +144 -40
  200. package/src/resources/scopes.ts +7 -1
  201. package/src/resources/simulations/account-programs.ts +282 -0
  202. package/src/resources/simulations/accounts.ts +265 -0
  203. package/src/resources/simulations/conversions.ts +70 -0
  204. package/src/resources/simulations/deposits.ts +522 -0
  205. package/src/resources/simulations/index.ts +33 -0
  206. package/src/resources/simulations/payouts.ts +80 -0
  207. package/src/resources/simulations/simulations.ts +92 -0
  208. package/src/resources/simulations.ts +3 -0
  209. package/src/resources/transactions.ts +954 -206
  210. package/src/resources/webhook-subscriptions.ts +102 -36
  211. package/src/resources/webhooks.ts +1283 -1153
  212. package/src/version.ts +1 -1
  213. package/version.d.mts +1 -1
  214. package/version.d.ts +1 -1
  215. package/version.js +1 -1
  216. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"payouts.d.ts","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,WAAW,EACP,oBAAoB,CAAC,oBAAoB,GACzC,oBAAoB,CAAC,wBAAwB,GAC7C,oBAAoB,CAAC,mBAAmB,GACxC,oBAAoB,CAAC,4BAA4B,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,eAAe,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,WAAW,EACP,sBAAsB,CAAC,oBAAoB,GAC3C,sBAAsB,CAAC,wBAAwB,GAC/C,sBAAsB,CAAC,mBAAmB,GAC1C,sBAAsB,CAAC,4BAA4B,CAAC;IAExD;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,eAAe,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,WAAW,EACP,kBAAkB,CAAC,oBAAoB,GACvC,kBAAkB,CAAC,wBAAwB,GAC3C,kBAAkB,CAAC,mBAAmB,GACtC,kBAAkB,CAAC,4BAA4B,CAAC;IAEpD;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,eAAe,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,WAAW,EACP,kBAAkB,CAAC,IAAI,GACvB,kBAAkB,CAAC,wBAAwB,GAC3C,kBAAkB,CAAC,mBAAmB,GACtC,kBAAkB,CAAC,4BAA4B,CAAC;IAEpD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,iBAAiB,CAAC;CACpD;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;KACnB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,4BAA4B;QAC3C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,SAAS,GACT,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,cAAc,CAAC;QAEnB;;WAEG;QACH,IAAI,EAAE,eAAe,CAAC;KACvB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAC;CACxC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"payouts.d.ts","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;CAGlE;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,EACA,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,UAAU,GACV,QAAQ,GACR,KAAK,GACL,SAAS,GACT,SAAS,GACT,kBAAkB,GAClB,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,GACd,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEnE;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EACA,gBAAgB,GAChB,iBAAiB,GACjB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,gBAAgB,GAChB,cAAc,GACd,uBAAuB,GACvB,2BAA2B,GAC3B,cAAc,GACd,uBAAuB,GACvB,gCAAgC,GAChC,mBAAmB,GACnB,SAAS,CAAC;QAEd;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,EACD,MAAM,GACN,cAAc,GACd,iBAAiB,GACjB,OAAO,GACP,KAAK,GACL,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,QAAQ,GACR,eAAe,GACf,SAAS,GACT,cAAc,CAAC;IAEnB;;;OAGG;IACH,mCAAmC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrD;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAExC;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC;IAEnD;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;CACrE;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -8,18 +8,43 @@ const path_1 = require("../internal/utils/path.js");
8
8
  class Payouts extends resource_1.APIResource {
9
9
  /**
10
10
  * Creates a new payout.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const payout = await client.payouts.create({
15
+ * account_id: '550e8400-e29b-41d4-a716-44665544000b',
16
+ * amount: '100.50',
17
+ * counterparty_id: '550e8400-e29b-41d4-a716-446655440000',
18
+ * currency: 'EUR',
19
+ * });
20
+ * ```
11
21
  */
12
22
  create(body, options) {
13
23
  return this._client.post('/v1/payouts', { body, ...options });
14
24
  }
15
25
  /**
16
26
  * Retrieves a payout by ID.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const payout = await client.payouts.retrieve(
31
+ * '550e8400-e29b-41d4-a716-446655440003',
32
+ * );
33
+ * ```
17
34
  */
18
35
  retrieve(id, options) {
19
36
  return this._client.get((0, path_1.path) `/v1/payouts/${id}`, options);
20
37
  }
21
38
  /**
22
39
  * Lists payouts for the merchant with cursor-based pagination.
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * // Automatically fetches more pages as needed.
44
+ * for await (const payoutListResponse of client.payouts.list()) {
45
+ * // ...
46
+ * }
47
+ * ```
23
48
  */
24
49
  list(query = {}, options) {
25
50
  return this._client.getAPIList('/v1/payouts', (pagination_1.CursorPage), { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"payouts.js","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAxBD,0BAwBC"}
1
+ {"version":3,"file":"payouts.js","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAjDD,0BAiDC"}
@@ -5,18 +5,43 @@ import { path } from "../internal/utils/path.mjs";
5
5
  export class Payouts extends APIResource {
6
6
  /**
7
7
  * Creates a new payout.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const payout = await client.payouts.create({
12
+ * account_id: '550e8400-e29b-41d4-a716-44665544000b',
13
+ * amount: '100.50',
14
+ * counterparty_id: '550e8400-e29b-41d4-a716-446655440000',
15
+ * currency: 'EUR',
16
+ * });
17
+ * ```
8
18
  */
9
19
  create(body, options) {
10
20
  return this._client.post('/v1/payouts', { body, ...options });
11
21
  }
12
22
  /**
13
23
  * Retrieves a payout by ID.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const payout = await client.payouts.retrieve(
28
+ * '550e8400-e29b-41d4-a716-446655440003',
29
+ * );
30
+ * ```
14
31
  */
15
32
  retrieve(id, options) {
16
33
  return this._client.get(path `/v1/payouts/${id}`, options);
17
34
  }
18
35
  /**
19
36
  * Lists payouts for the merchant with cursor-based pagination.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * // Automatically fetches more pages as needed.
41
+ * for await (const payoutListResponse of client.payouts.list()) {
42
+ * // ...
43
+ * }
44
+ * ```
20
45
  */
21
46
  list(query = {}, options) {
22
47
  return this._client.getAPIList('/v1/payouts', (CursorPage), { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"payouts.mjs","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
1
+ {"version":3,"file":"payouts.mjs","sourceRoot":"","sources":["../src/resources/payouts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
@@ -21,25 +21,21 @@ export interface IndicativeRetrieveResponse {
21
21
  */
22
22
  rate: string;
23
23
  /**
24
- * Source amount as a string decimal.
24
+ * Amount as a string decimal (e.g. "100.50").
25
25
  */
26
26
  source_amount: string;
27
27
  /**
28
- * Source currency code.
28
+ * Currency code (ISO 4217 or crypto).
29
29
  */
30
30
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
31
31
  /**
32
- * Target amount as a string decimal.
32
+ * Amount as a string decimal (e.g. "100.50").
33
33
  */
34
34
  target_amount: string;
35
35
  /**
36
- * Target currency code.
36
+ * Currency code (ISO 4217 or crypto).
37
37
  */
38
38
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
39
- /**
40
- * Venue the quote was fetched from.
41
- */
42
- venue: string;
43
39
  }
44
40
  export declare namespace IndicativeRetrieveResponse {
45
41
  /**
@@ -58,15 +54,15 @@ export declare namespace IndicativeRetrieveResponse {
58
54
  }
59
55
  export interface IndicativeRetrieveParams {
60
56
  /**
61
- * Source currency code.
57
+ * Currency code (ISO 4217 or crypto).
62
58
  */
63
59
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
64
60
  /**
65
- * Target currency code.
61
+ * Currency code (ISO 4217 or crypto).
66
62
  */
67
63
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
68
64
  /**
69
- * Source amount as a string decimal. Defaults to 1 unit if omitted.
65
+ * Amount as a string decimal (e.g. "100.50").
70
66
  */
71
67
  source_amount?: string;
72
68
  }
@@ -1 +1 @@
1
- {"version":3,"file":"indicative.d.mts","sourceRoot":"","sources":["../../src/resources/quotes/indicative.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,GAAG,EAAE,0BAA0B,CAAC,GAAG,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;KAC1E;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"indicative.d.mts","sourceRoot":"","sources":["../../src/resources/quotes/indicative.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,GAAG,EAAE,0BAA0B,CAAC,GAAG,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;CACjF;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;KAC1E;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -21,25 +21,21 @@ export interface IndicativeRetrieveResponse {
21
21
  */
22
22
  rate: string;
23
23
  /**
24
- * Source amount as a string decimal.
24
+ * Amount as a string decimal (e.g. "100.50").
25
25
  */
26
26
  source_amount: string;
27
27
  /**
28
- * Source currency code.
28
+ * Currency code (ISO 4217 or crypto).
29
29
  */
30
30
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
31
31
  /**
32
- * Target amount as a string decimal.
32
+ * Amount as a string decimal (e.g. "100.50").
33
33
  */
34
34
  target_amount: string;
35
35
  /**
36
- * Target currency code.
36
+ * Currency code (ISO 4217 or crypto).
37
37
  */
38
38
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
39
- /**
40
- * Venue the quote was fetched from.
41
- */
42
- venue: string;
43
39
  }
44
40
  export declare namespace IndicativeRetrieveResponse {
45
41
  /**
@@ -58,15 +54,15 @@ export declare namespace IndicativeRetrieveResponse {
58
54
  }
59
55
  export interface IndicativeRetrieveParams {
60
56
  /**
61
- * Source currency code.
57
+ * Currency code (ISO 4217 or crypto).
62
58
  */
63
59
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
64
60
  /**
65
- * Target currency code.
61
+ * Currency code (ISO 4217 or crypto).
66
62
  */
67
63
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
68
64
  /**
69
- * Source amount as a string decimal. Defaults to 1 unit if omitted.
65
+ * Amount as a string decimal (e.g. "100.50").
70
66
  */
71
67
  source_amount?: string;
72
68
  }
@@ -1 +1 @@
1
- {"version":3,"file":"indicative.d.ts","sourceRoot":"","sources":["../../src/resources/quotes/indicative.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,GAAG,EAAE,0BAA0B,CAAC,GAAG,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;KAC1E;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"indicative.d.ts","sourceRoot":"","sources":["../../src/resources/quotes/indicative.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,QAAQ,CACN,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,GAAG,EAAE,0BAA0B,CAAC,GAAG,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;CACjF;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;KAC1E;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -32,11 +32,11 @@ export interface QuoteRetrieveResponse {
32
32
  */
33
33
  funding_status: 'pending' | 'sent' | 'completed' | 'failed' | 'on_hold';
34
34
  /**
35
- * Source amount as a string decimal.
35
+ * Amount as a string decimal (e.g. "100.50").
36
36
  */
37
37
  source_amount: string;
38
38
  /**
39
- * Source currency code.
39
+ * Currency code (ISO 4217 or crypto).
40
40
  */
41
41
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
42
42
  /**
@@ -44,11 +44,11 @@ export interface QuoteRetrieveResponse {
44
44
  */
45
45
  status: 'pending' | 'quote_accepted' | 'order_pending' | 'order_failed' | 'order_completed' | 'withdrawal_pending' | 'withdrawal_failed' | 'withdrawal_completed' | 'completed' | 'failed';
46
46
  /**
47
- * Target amount as a string decimal.
47
+ * Amount as a string decimal (e.g. "100.50").
48
48
  */
49
49
  target_amount: string;
50
50
  /**
51
- * Target currency code.
51
+ * Currency code (ISO 4217 or crypto).
52
52
  */
53
53
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
54
54
  /**
@@ -59,10 +59,6 @@ export interface QuoteRetrieveResponse {
59
59
  * ISO 8601 UTC timestamp when the quote was last updated.
60
60
  */
61
61
  updated_at: string;
62
- /**
63
- * Execution venue (e.g. "kraken").
64
- */
65
- venue: string;
66
62
  }
67
63
  export declare namespace Quotes {
68
64
  export { type QuoteRetrieveResponse as QuoteRetrieveResponse };
@@ -1 +1 @@
1
- {"version":3,"file":"quotes.d.mts","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,yBAAqB;AAChG,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,MAAM,EACF,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,WAAW,GACX,QAAQ,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"quotes.d.mts","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,yBAAqB;AAChG,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,MAAM,EACF,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,WAAW,GACX,QAAQ,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -32,11 +32,11 @@ export interface QuoteRetrieveResponse {
32
32
  */
33
33
  funding_status: 'pending' | 'sent' | 'completed' | 'failed' | 'on_hold';
34
34
  /**
35
- * Source amount as a string decimal.
35
+ * Amount as a string decimal (e.g. "100.50").
36
36
  */
37
37
  source_amount: string;
38
38
  /**
39
- * Source currency code.
39
+ * Currency code (ISO 4217 or crypto).
40
40
  */
41
41
  source_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
42
42
  /**
@@ -44,11 +44,11 @@ export interface QuoteRetrieveResponse {
44
44
  */
45
45
  status: 'pending' | 'quote_accepted' | 'order_pending' | 'order_failed' | 'order_completed' | 'withdrawal_pending' | 'withdrawal_failed' | 'withdrawal_completed' | 'completed' | 'failed';
46
46
  /**
47
- * Target amount as a string decimal.
47
+ * Amount as a string decimal (e.g. "100.50").
48
48
  */
49
49
  target_amount: string;
50
50
  /**
51
- * Target currency code.
51
+ * Currency code (ISO 4217 or crypto).
52
52
  */
53
53
  target_currency: 'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL';
54
54
  /**
@@ -59,10 +59,6 @@ export interface QuoteRetrieveResponse {
59
59
  * ISO 8601 UTC timestamp when the quote was last updated.
60
60
  */
61
61
  updated_at: string;
62
- /**
63
- * Execution venue (e.g. "kraken").
64
- */
65
- venue: string;
66
62
  }
67
63
  export declare namespace Quotes {
68
64
  export { type QuoteRetrieveResponse as QuoteRetrieveResponse };
@@ -1 +1 @@
1
- {"version":3,"file":"quotes.d.ts","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,wBAAqB;AAChG,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,MAAM,EACF,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,WAAW,GACX,QAAQ,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"quotes.d.ts","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,aAAa,wBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,wBAAqB;AAChG,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,MAAM,EACF,SAAS,GACT,gBAAgB,GAChB,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,oBAAoB,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,WAAW,GACX,QAAQ,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAEhF;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -1 +1 @@
1
- {"version":3,"file":"quotes.js","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,uEAA8C;AAC9C,gDAAgG;AAGhG,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQpF,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AATD,wBASC;AA+ED,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC"}
1
+ {"version":3,"file":"quotes.js","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,uEAA8C;AAC9C,gDAAgG;AAGhG,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IAAvC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQpF,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AATD,wBASC;AA0ED,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"quotes.mjs","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAwD,yBAAqB;AAGhG,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQpF,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AA+ED,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC"}
1
+ {"version":3,"file":"quotes.mjs","sourceRoot":"","sources":["../../src/resources/quotes/quotes.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAwD,yBAAqB;AAGhG,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAQpF,CAAC;IANC;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AA0ED,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC"}
@@ -5,14 +5,36 @@ import { RequestOptions } from "../internal/request-options.mjs";
5
5
  export declare class Returns extends APIResource {
6
6
  /**
7
7
  * Initiates a return of funds from a deposit to the source.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const _return = await client.returns.create({
12
+ * deposit_id: '550e8400-e29b-41d4-a716-446655440004',
13
+ * });
14
+ * ```
8
15
  */
9
16
  create(body: ReturnCreateParams, options?: RequestOptions): APIPromise<ReturnCreateResponse>;
10
17
  /**
11
18
  * Retrieves a return by ID.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const _return = await client.returns.retrieve(
23
+ * '550e8400-e29b-41d4-a716-446655440005',
24
+ * );
25
+ * ```
12
26
  */
13
27
  retrieve(id: string, options?: RequestOptions): APIPromise<ReturnRetrieveResponse>;
14
28
  /**
15
29
  * Lists deposit returns for the merchant with cursor-based pagination.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * // Automatically fetches more pages as needed.
34
+ * for await (const returnListResponse of client.returns.list()) {
35
+ * // ...
36
+ * }
37
+ * ```
16
38
  */
17
39
  list(query?: ReturnListParams | null | undefined, options?: RequestOptions): PagePromise<ReturnListResponsesCursorPage, ReturnListResponse>;
18
40
  }
@@ -27,11 +49,7 @@ export interface ReturnCreateResponse {
27
49
  */
28
50
  amount: string;
29
51
  /**
30
- * ISO 8601 UTC timestamp when the return was created.
31
- */
32
- created_at: string;
33
- /**
34
- * Currency code (ISO 4217 currency code or crypto currency code).
52
+ * Currency code (ISO 4217 or crypto).
35
53
  */
36
54
  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
37
55
  /**
@@ -42,18 +60,31 @@ export interface ReturnCreateResponse {
42
60
  * Failure details when status is failed, otherwise null.
43
61
  */
44
62
  failure: ReturnCreateResponse.Failure | null;
63
+ /**
64
+ * ISO 8601 UTC timestamp when the return was initiated.
65
+ */
66
+ initiated_at: string;
67
+ /**
68
+ * Payment scheme or blockchain used for the return, or null when unknown.
69
+ */
70
+ rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
71
+ /**
72
+ * ISO 8601 UTC timestamp when the return was sent.
73
+ */
74
+ sent_at: string | null;
45
75
  /**
46
76
  * Current status of the return.
47
77
  */
48
- status: 'pending' | 'paid' | 'failed' | 'returned';
78
+ status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
49
79
  /**
50
- * Type of the resource.
80
+ * Transaction hash for crypto returns, or null when not known. Only blockchain
81
+ * rails support this field.
51
82
  */
52
- type: 'return';
83
+ tx_hash: string | null;
53
84
  /**
54
- * ISO 8601 UTC timestamp when the return was last updated.
85
+ * Resource type discriminator.
55
86
  */
56
- updated_at: string;
87
+ type: 'return';
57
88
  }
58
89
  export declare namespace ReturnCreateResponse {
59
90
  /**
@@ -63,7 +94,7 @@ export declare namespace ReturnCreateResponse {
63
94
  /**
64
95
  * Failure code.
65
96
  */
66
- code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
97
+ code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
67
98
  /**
68
99
  * Human-readable description of the failure.
69
100
  */
@@ -84,11 +115,7 @@ export interface ReturnRetrieveResponse {
84
115
  */
85
116
  amount: string;
86
117
  /**
87
- * ISO 8601 UTC timestamp when the return was created.
88
- */
89
- created_at: string;
90
- /**
91
- * Currency code (ISO 4217 currency code or crypto currency code).
118
+ * Currency code (ISO 4217 or crypto).
92
119
  */
93
120
  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
94
121
  /**
@@ -99,18 +126,31 @@ export interface ReturnRetrieveResponse {
99
126
  * Failure details when status is failed, otherwise null.
100
127
  */
101
128
  failure: ReturnRetrieveResponse.Failure | null;
129
+ /**
130
+ * ISO 8601 UTC timestamp when the return was initiated.
131
+ */
132
+ initiated_at: string;
133
+ /**
134
+ * Payment scheme or blockchain used for the return, or null when unknown.
135
+ */
136
+ rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
137
+ /**
138
+ * ISO 8601 UTC timestamp when the return was sent.
139
+ */
140
+ sent_at: string | null;
102
141
  /**
103
142
  * Current status of the return.
104
143
  */
105
- status: 'pending' | 'paid' | 'failed' | 'returned';
144
+ status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
106
145
  /**
107
- * Type of the resource.
146
+ * Transaction hash for crypto returns, or null when not known. Only blockchain
147
+ * rails support this field.
108
148
  */
109
- type: 'return';
149
+ tx_hash: string | null;
110
150
  /**
111
- * ISO 8601 UTC timestamp when the return was last updated.
151
+ * Resource type discriminator.
112
152
  */
113
- updated_at: string;
153
+ type: 'return';
114
154
  }
115
155
  export declare namespace ReturnRetrieveResponse {
116
156
  /**
@@ -120,7 +160,7 @@ export declare namespace ReturnRetrieveResponse {
120
160
  /**
121
161
  * Failure code.
122
162
  */
123
- code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
163
+ code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
124
164
  /**
125
165
  * Human-readable description of the failure.
126
166
  */
@@ -141,11 +181,7 @@ export interface ReturnListResponse {
141
181
  */
142
182
  amount: string;
143
183
  /**
144
- * ISO 8601 UTC timestamp when the return was created.
145
- */
146
- created_at: string;
147
- /**
148
- * Currency code (ISO 4217 currency code or crypto currency code).
184
+ * Currency code (ISO 4217 or crypto).
149
185
  */
150
186
  currency: 'EUR' | 'GBP' | 'USD' | 'USDC';
151
187
  /**
@@ -156,18 +192,31 @@ export interface ReturnListResponse {
156
192
  * Failure details when status is failed, otherwise null.
157
193
  */
158
194
  failure: ReturnListResponse.Failure | null;
195
+ /**
196
+ * ISO 8601 UTC timestamp when the return was initiated.
197
+ */
198
+ initiated_at: string;
199
+ /**
200
+ * Payment scheme or blockchain used for the return, or null when unknown.
201
+ */
202
+ rail: 'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | null;
203
+ /**
204
+ * ISO 8601 UTC timestamp when the return was sent.
205
+ */
206
+ sent_at: string | null;
159
207
  /**
160
208
  * Current status of the return.
161
209
  */
162
- status: 'pending' | 'paid' | 'failed' | 'returned';
210
+ status: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
163
211
  /**
164
- * Type of the resource.
212
+ * Transaction hash for crypto returns, or null when not known. Only blockchain
213
+ * rails support this field.
165
214
  */
166
- type: 'return';
215
+ tx_hash: string | null;
167
216
  /**
168
- * ISO 8601 UTC timestamp when the return was last updated.
217
+ * Resource type discriminator.
169
218
  */
170
- updated_at: string;
219
+ type: 'return';
171
220
  }
172
221
  export declare namespace ReturnListResponse {
173
222
  /**
@@ -177,7 +226,7 @@ export declare namespace ReturnListResponse {
177
226
  /**
178
227
  * Failure code.
179
228
  */
180
- code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
229
+ code: 'account_closed' | 'account_blocked' | 'insufficient_funds' | 'invalid_account_format' | 'invalid_routing_number' | 'invalid_instruction' | 'invalid_amount' | 'invalid_time' | 'duplicate_transaction' | 'payee_verification_failed' | 'system_error' | 'provider_system_error' | 'rejected_by_correspondent_bank' | 'blocked_by_review' | 'unknown';
181
230
  /**
182
231
  * Human-readable description of the failure.
183
232
  */
@@ -193,10 +242,6 @@ export interface ReturnCreateParams {
193
242
  * Deposit to return funds from.
194
243
  */
195
244
  deposit_id: string;
196
- /**
197
- * Payment rail when the deposit allows multiple schemes.
198
- */
199
- rail?: 'sepa_instant' | 'sepa' | 'faster_payments';
200
245
  }
201
246
  export interface ReturnListParams extends CursorPageParams {
202
247
  created_at?: ReturnListParams.CreatedAt;
@@ -205,9 +250,9 @@ export interface ReturnListParams extends CursorPageParams {
205
250
  */
206
251
  deposit_id?: string;
207
252
  /**
208
- * Current status of the return.
253
+ * Filter by return status.
209
254
  */
210
- status?: 'pending' | 'paid' | 'failed' | 'returned';
255
+ status?: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned';
211
256
  }
212
257
  export declare namespace ReturnListParams {
213
258
  interface CreatedAt {