diff --git a/v2/api-validator/src/client/generated/index.ts b/v2/api-validator/src/client/generated/index.ts index 9015e13b..5ed7e8e5 100644 --- a/v2/api-validator/src/client/generated/index.ts +++ b/v2/api-validator/src/client/generated/index.ts @@ -128,6 +128,7 @@ export { InteracCapability } from './models/InteracCapability'; export type { InteracDestination } from './models/InteracDestination'; export type { InteracTransfer } from './models/InteracTransfer'; export type { InteracTransferDetailsBase } from './models/InteracTransferDetailsBase'; +export type { InteracTransferSecurityQuestionAndAnswer } from './models/InteracTransferSecurityQuestionAndAnswer'; export type { InteractTransferDetailsOffRamp } from './models/InteractTransferDetailsOffRamp'; export type { InteractTransferDetailsOnRamp } from './models/InteractTransferDetailsOnRamp'; export type { InternalTransfer } from './models/InternalTransfer'; diff --git a/v2/api-validator/src/client/generated/models/InteracAddressPaymentInstruction.ts b/v2/api-validator/src/client/generated/models/InteracAddressPaymentInstruction.ts index 774d27d5..82a53080 100644 --- a/v2/api-validator/src/client/generated/models/InteracAddressPaymentInstruction.ts +++ b/v2/api-validator/src/client/generated/models/InteracAddressPaymentInstruction.ts @@ -7,6 +7,10 @@ import type { AccountHolderDetails } from './AccountHolderDetails'; import type { InteracCapability } from './InteracCapability'; import type { InteractTransferDetailsOnRamp } from './InteractTransferDetailsOnRamp'; +/** + * When true, funds are deposited directly into the recipient's bank account without a security question. + * When false, a security question and answer are required to complete the transfer + */ export type InteracAddressPaymentInstruction = (InteracCapability & InteractTransferDetailsOnRamp & { accountHolder: AccountHolderDetails; }); diff --git a/v2/api-validator/src/client/generated/models/InteracTransferSecurityQuestionAndAnswer.ts b/v2/api-validator/src/client/generated/models/InteracTransferSecurityQuestionAndAnswer.ts new file mode 100644 index 00000000..b65bae4c --- /dev/null +++ b/v2/api-validator/src/client/generated/models/InteracTransferSecurityQuestionAndAnswer.ts @@ -0,0 +1,17 @@ +/* generated using openapi-typescript-codegen -- do no edit */ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ + +export type InteracTransferSecurityQuestionAndAnswer = { + autoDeposit: boolean; + /** + * if autoDeposit is false, this is required + */ + securityQuestion?: string; + /** + * if autoDeposit is false, this is required + */ + securityAnswer?: string; +}; + diff --git a/v2/api-validator/src/client/generated/models/InteractTransferDetailsOnRamp.ts b/v2/api-validator/src/client/generated/models/InteractTransferDetailsOnRamp.ts index fa68a8ad..212a22b2 100644 --- a/v2/api-validator/src/client/generated/models/InteractTransferDetailsOnRamp.ts +++ b/v2/api-validator/src/client/generated/models/InteractTransferDetailsOnRamp.ts @@ -4,6 +4,7 @@ /* eslint-disable */ import type { InteracTransferDetailsBase } from './InteracTransferDetailsBase'; +import type { InteracTransferSecurityQuestionAndAnswer } from './InteracTransferSecurityQuestionAndAnswer'; -export type InteractTransferDetailsOnRamp = InteracTransferDetailsBase; +export type InteractTransferDetailsOnRamp = (InteracTransferDetailsBase & InteracTransferSecurityQuestionAndAnswer); diff --git a/v2/openapi/docs.html b/v2/openapi/docs.html index 948844ce..d1bd371a 100644 --- a/v2/openapi/docs.html +++ b/v2/openapi/docs.html @@ -306,7 +306,7 @@ " class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

-
X-FBAPI-SIGNATURE
required
string
X-FBAPI-SIGNATURE
required
string
X-FBAPI-INITIATED-BY
string

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Responses

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

-
X-FBAPI-SIGNATURE
required
string
X-FBAPI-SIGNATURE
required
string
X-FBAPI-INITIATED-BY
string

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Responses

nationalCurrencyCode
string (NationalCurrencyCode)
Enum: "ADP" "AED" "AFA" "AFN" "ALK" "ALL" "AMD" "ANG" "AOA" "AOK" "AON" "AOR" "ARA" "ARP" "ARS" "ARY" "ATS" "AUD" "AWG" "AYM" "AZM" "BAD" "BAM" "BBD" "BDT" "BEC" "BEF" "BEL" "BGJ" "BGK" "BGL" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOP" "BOV" "BRB" "BRC" "BRE" "BRL" "BRN" "BRR" "BSD" "BTN" "BUK" "BWP" "BYB" "BYN" "BYR" "BZD" "CAD" "CDF" "CHC" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CSD" "CSJ" "CSK" "CUC" "CUP" "CVE" "CYP" "CZK" "DDM" "DEM" "DJF" "DKK" "DOP" "DZD" "ECS" "ECV" "EEK" "EGP" "ERN" "ESA" "ESB" "ESP" "ETB" "EUR" "FIM" "FJD" "FKP" "FRF" "GBP" "GEK" "GEL" "GHC" "GHP" "GHS" "GIP" "GMD" "GNE" "GNF" "GNS" "GQE" "GRD" "GTQ" "GWE" "GWP" "GYD" "HKD" "HNL" "HRD" "HRK" "HTG" "HUF" "IDR" "IEP" "ILP" "ILR" "ILS" "INR" "IQD" "IRR" "ISJ" "ISK" "ITL" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAJ" "LAK" "LBP" "LKR" "LRD" "LSL" "LSM" "LTL" "LTT" "LUC" "LUF" "LUL" "LVL" "LVR" "LYD" "MAD" "MDL" "MGA" "MGF" "MKD" "MLF" "MMK" "MNT" "MOP" "MRO" "MRU" "MTL" "MTP" "MUR" "MVQ" "MVR" "MWK" "MXN" "MXP" "MXV" "MYR" "MZE" "MZM" "NAD" "NGN" "NIC" "NIO" "NLG" "NOK" "NPR" "NZD" "OMR" "PAB" "PEH" "PEI" "PEN" "PES" "PGK" "PHP" "PKR" "PLN" "PLZ" "PTE" "PYG" "QAR" "RHD" "ROK" "ROL" "RON" "RSD" "RUB" "RUR" "RWF" "SAR" "SBD" "SCR" "SDD" "SDG" "SDP" "SEK" "SGD" "SHP" "SIT" "SKK" "SLL" "SOS" "SRD" "SRG" "SSP" "STD" "STN" "SUR" "SVC" "SYP" "SZL" "THB" "TJR" "TJS" "TMM" "TMT" "TND" "TOP" "TPE" "TRL" "TRY" "TTD" "TWD" "TZS" "UAH" "UAK" "UGS" "UGW" "UGX" "USD" "USN" "USS" "UYI" "UYN" "UYP" "UYU" "UYW" "UZS" "VEB" "VEF" "VES" "VNC" "VND" "VUV" "WST" "XAF" "XCD" "XOF" "XPF" "XSU" "XTS" "XUA" "XXX" "YDD" "YER" "YUD" "YUM" "YUN" "ZAL" "ZAR" "ZMK" "ZMW" "ZRN" "ZRZ" "ZWC" "ZWD" "ZWL" "ZWN" "ZWR"

Limits the response to one asset with the provided NationalCurrencyCode Cannot be used in conjunction with cryptocurrencySymbol or assetId

-
cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "BITKUB" "BNB" "BSV" "BTC" "CANTO" "CELESTIA" "CELO" "CHZ" "CHZ2" "CTXC" "DASH" "DOGE" "DOT" "DYDX" "EOS" "ETC" "ETH" "ETHW" "EVMOS" "FLR" "FTM" "GLMR" "HBAR" "HT" "KAVA" "KSM" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"
cryptocurrencySymbol
string (CryptocurrencySymbol)
Enum: "ADA" "ALGO" "ARB" "ASTR" "ATOM" "AURORA" "AVAX" "AXL" "BASE" "BCH" "BCHA" "BERA" "BITKUB" "BNB" "BSV" "BTC" "CANTO" "CELESTIA" "CELO" "CHZ" "CHZ2" "CTXC" "DASH" "DOGE" "DOT" "DYDX" "EOS" "ETC" "ETH" "ETHW" "EVMOS" "FLR" "FTM" "GLMR" "HBAR" "HT" "KAVA" "KSM" "LTC" "LUNA" "LUNA2" "MATIC" "MOVR" "NEAR" "OAS" "OPT" "OSMO" "PALM" "RON" "RSK" "SMR" "SOL" "SONGBIRD" "SXNETWORK" "TKX" "TRX" "VLX" "WEMIX" "XDB" "XDC" "XEC" "XEM" "XLM" "XRP" "XTZ" "ZEC"

Limits the response to one asset with the provided CryptocurrencySymbol Cannot be used in conjunction with nationalCurrencyCode or assetId

header Parameters
X-FBAPI-KEY
required
string

API authentication key.

@@ -382,7 +386,7 @@ " class="sc-iKOlBD sc-cCzKKD cslxVo daOcFE">

Unique identifier of the request.

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

-
X-FBAPI-SIGNATURE
required
string
X-FBAPI-SIGNATURE
required
string
X-FBAPI-INITIATED-BY
string

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Responses

X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

-
X-FBAPI-SIGNATURE
required
string
X-FBAPI-SIGNATURE
required
string
X-FBAPI-INITIATED-BY
string

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Responses

required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
required
NationalCurrency (object) or NativeCryptocurrency (object) or OtherAssetReference (object) (AssetReference)
fromAmount
required
string (PositiveAmount) ^\d+(\.\d+)?

Responses

idempotencyKey
required
string
amount
required
string (PositiveAmount) ^\d+(\.\d+)?
customerReferenceId
string
X-FBAPI-TIMESTAMP
required
number
X-FBAPI-TIMESTAMP
required
number

Request timestamp in milliseconds since Unix epoch.

+
X-FBAPI-INITIATED-BY
string

Conditional. This header is provided only when the corresponding capability requirement is enabled.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "amount": "string",
  • "estimatedFees": [
    ],
  • "executionDetails": {
    },
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "paymentInstructions": {
    },
  • "type": "OnRamp",
  • "from": {
    },
  • "to": {
    },
  • "receipt": {
    }
}