- Client Profile
- Transfer Orchestrator
- Activities
- BankDetailsDirectory
- ClientOperations
- Documents
- Participants
- Transfers
- Fetch transfers based on the specified filters.GET
- Fetch transfer details by the specified transfer identifier.GET
- Fetch incoming transfer details by the specified transfer identifier.GET
- Create a foreign exchange transfer.POST
- Fetch foreign exchange transfer details by the specified transfer identifier.GET
- Create a self transfer (same-BAAS or cross-BAAS same currency).POST
- Get list of available accounts to make fx transfer to (in/cross baas)GET
- Get list of available accounts to make self/crossbaas transfer toGET
- Create an outgoing transfer.POST
- Create a mass payout - many outgoing transfers from one account, confirmed together by a
single OTP. Nothing is created unless every payment can be: a request with any unusable
payment is refused as a whole, listing what is wrong with each of them againPOST
- Fetch a mass payout of the current client by its identifier.GET
- Fetch outgoing transfer details by the specified transfer identifier.GET
- Check whether a confirmation document is required for an outgoing transfer with the given parameters.GET
- Get the additional payment-data fields (form descriptors) required for an outgoing transfer
from the given account to the given recipient over the given payment system — e.g. the UAE
purpose-of-payment code, or fields configured for the account's providGET
- Get the constraints configured for the transfer's reference and purpose, so the form can apply
the provider's alphabet and length limits before the payment is sent. An empty array means
nothing is configured and the platform defaults apply.GET
- Fetch transfers based on the specified filters.
- Dfns Integration
- AccessRecovery
- CredentialOperations
- Credentials
- Lists the keys and devices of the client, together with whether an active recovery key exists.
- Starts issuing a credential and returns what the client needs to generate it.
- Hands over the generated credential and creates the confirmation authorizing its registration.
- Starts revoking a credential and creates the confirmation authorizing it.
- CustodialKey
- Devices
- Gas
- Accounts
- Cards
- Cards
- Returns the caller's configured card routes and their required KYC status.
- Issues an allowed provider/currency card for the calling client.
- Returns a page of the caller's own cards.
- Returns one of the caller's own cards.
- Returns the accounts one of the caller's own cards draws on.
- /Cards/{cardId}/freeze
- /Cards/{cardId}/unfreeze
- Prepares a provider-defined encrypted session for one of the caller's cards.
- Relays an opaque encrypted-session exchange for one of the caller's cards.
- Cards
- Confirmations
- Reporter
- Merchant
- Onboarding Lite
- Fee
- Exchange
- Schemas
- Client Profile
- AddressDto
- BeneficiaryType
- BusinessPartnerDto
- ClientCompanyDto
- ClientDto
- ClientDtoResult
- ClientIndividualDto
- ClientState
- ClientType
- CompanyType
- ComplianceEvaluationDto
- CountriesGroup
- CustomerType
- DocumentSide
- DocumentType
- EmployeeCount
- FundFlowsDto
- HighRiskActivity
- IError
- IReason
- ISuccess
- IdentificationDocumentDto
- IdentificationDocumentType
- Industry
- KycBlockDto
- KycBlockStatus
- PurposeAccountOpening
- RelatedIndividualInfoDto
- Result
- SourceOfFunds
- StartActionDto
- TariffPlan
- Turnover
- TurnoverUsd
- UploadedDocumentDto
- UploadedDocumentFileDto
- Transfer Orchestrator
- AccountType
- AchCredentials
- Address
- ApplePayCredentials
- BankDetails
- BankDetailsByBicDto
- BizumCredentials
- BlikCredentials
- BlockchainNetworkCode
- BunqCredentials
- BusinessEntity
- CardCredentials
- CardMerchantCredentials
- CardNetwork
- CardPayOutActivityDto
- CardPaymentInfo
- CardProvider
- CardholderType
- CoinsPaidCredentials
- CreateParticipantDto
- Credentials
- CryptoCredentials
- CryptoCurrencyResponseDto
- CryptoTransferDetails
- CurrencyResponseDto
- CustomerFxTransferDto
- CustomerIncomingTransferDto
- CustomerOutgoingTransferDto
- CustomerTransferBatchDto
- CustomerTransferBatchItemDto
- CustomerTransferDto
- CustomerTransferDtoPagedDataDto
- CustomerTransferStateDto
- DocumentDto
- ErrorDetailsDto
- ExchangeTransferActivityDto
- FasterUkCredentials
- FedWireCredentials
- FeeAllocationDto
- FiatCurrencyResponseDto
- FieldCondition
- FieldInfo
- FieldType
- FieldValueFormatter
- FieldValueInfo
- FxAccountType
- FxBaseAccountDto
- FxBuyAccountDto
- FxOpenAccountDto
- FxRequestAccountDto
- FxTransferParamsDto
- GasPaymentActivityDto
- GasPaymentInfoDto
- GetUsedParticipantsDto
- GooglePayCredentials
- IActivityDto
- IActivityDtoPagedDataDto
- IncomingTransferActivityDto
- IndividualEntity
- InternalCredentials
- LegalEntity
- LegalEntityType
- LocalAEDCredentials
- LocalXafCredentials
- MBWayCredentials
- MidpointRounding
- MultibancoCredentials
- N26Credentials
- NeftCredentials
- NetellerCredentials
- OpenBankingCredentials
- OperationTypeDto
- OutgoingBatchPaymentDto
- OutgoingDocumentRequirementDto
- OutgoingTransferActivityDto
- OutgoingTransferBatchParamsDto
- OutgoingTransferDocumentDto
- OutgoingTransferParamsDto
- PageInfoDto
- PagedFilterDto
- Participant
- ParticipantDto
- ParticipantPagedDataDto
- PaymentSystem
- PaysafecardCredentials
- PixCredentials
- ProblemDetails
- Przelewy24Credentials
- RequestFxAccountDto
- RevolutCredentials
- SelfAccountType
- SelfBaseAccountDto
- SelfBuyAccountDto
- SelfRequestAccountDto
- SelfTransferActivityDto
- SelfTransferParamsDto
- SepaCredentials
- SkrillCredentials
- SortDto
- SortOrderDto
- SwiftCredentials
- TedPayCredentials
- TransferBatchDraftedDto
- TransferBatchDraftedItemDto
- TransferDetails
- TransferDraftedDto
- TransferOperationDetailsDto
- TransferSideDto
- TransferTypeDto
- UaeFtsCredentials
- UaeIppCredentials
- ValidationProblemDetails
- WiseCredentials
- YeePayKesLocalCredentials
- YeePayMxnLocalCredentials
- YeePayNgnLocalCredentials
- Dfns Integration
- AccessRecoveryChallengeDto
- ClientCredentialDeviceDto
- ClientCredentialDto
- ClientCredentialKind
- ClientCredentialOperationStatus
- ClientCredentialPurpose
- ClientCredentialStatus
- ClientCredentialsDto
- CredentialCreationAuthenticatorSelectionDto
- CredentialCreationChallengeDto
- CredentialCreationParamDto
- CredentialCreationUserDto
- CredentialOperationConfirmationDto
- CredentialOperationStatusDto
- EndUserDeviceMetadata
- GasRequirementDto
- GasTransferType
- IssueCredentialRequest
- PasskeyCreationChallengeDto
- PasswordProtectedKeyCreationChallengeDto
- PresentDeviceCodeRequest
- RecoveryKeyCreationChallengeDto
- RegisterCredentialRequest
- RegisterDeviceCredentialRequest
- RegisterDevicePasskeyRequest
- RegisterDevicePasswordProtectedKeyRequest
- RegisterPasskeyRequest
- RegisterPasswordProtectedKeyRequest
- RegisterRecoveryKeyRequest
- UniversalCreationChallengeDto
- Accounts
- AccountDraftedDto
- BankAccountFrontOfficeDto
- BankAccountState
- CommissionStrategy
- CreateAccountDto
- FrontOfficeAvailableCurrenciesDto
- FrontOfficeAvailableCurrencyDto
- FrontOfficeBankCurrencyDto
- FrontOfficeOpenCurrencyDto
- FrontOfficeRequestableCurrencyDto
- FrontOfficeSettingsDto
- IncomingRequisitesChannel
- IncomingRequisitesDto
- IncomingRequisitesGroupDto
- IncomingRequisitesItemDto
- IncomingRequisitesItemKind
- IncomingRequisitesPaymentMethodDto
- ParticipantLegalEntityType
- RenameBankAccountDto
- ReorderAccountsFrontOfficeDto
- RequestAccountDto
- SettlementInstructionsDto
- Cards
- Confirmations
- AccessRecoveryChallenge
- AccessRecoveryChallengeDataDto
- AccessRecoveryConfirm
- AccessRecoveryConfirmation
- AllowedCredential
- ChallengeConfirm
- ChallengeConfirmType
- ChallengeDataDto
- ChallengeDataType
- ChallengeDto
- ChallengeState
- ConfirmResult
- ConfirmResultOperationResult
- CredentialCreationChallenge
- CredentialCreationChallengeDataDto
- CredentialCreationConfirm
- CredentialRegistrationConfirmation
- CredentialToRegisterKind
- EmailChannelInfoDto
- EmptyResult
- EndUserCredentialToRegister
- EndUserSignature
- EndUserSignatureKind
- KeyPairAllowedCredential
- KeyPairCredentialToRegister
- KeyPairSignature
- NotificationChannel
- OperationAssertionChallenge
- OperationAssertionChallengeDataDto
- OperationAssertionConfirm
- OperationAssertionConfirmation
- OtpChallengeConfirm
- OtpChallengeDataDto
- OtpChannelInfoDto
- OtpState
- PasswordProtectedKeyAllowedCredential
- PasswordProtectedKeyCredentialToRegister
- PasswordProtectedKeySignature
- RecoveryCredentialToRegister
- RecoveryKeySignature
- RetryResult
- RetryResultOperationResult
- SmsChannelInfoDto
- WebAuthnAllowedCredential
- WebAuthnCoseAlgorithm
- WebAuthnCredentialToRegister
- WebAuthnPublicKeyCredentialParam
- WebAuthnPublicKeyCredentialType
- WebAuthnSignature
- WebAuthnState
- Reporter
- Merchant
- Onboarding Lite
- Fee
- Exchange
- Client Profile
Check whether a confirmation document is required for an outgoing transfer with the given parameters.
GET
/Transfers/outgoing/document-requirement
Request
Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/Transfers/outgoing/document-requirement?accountId=undefined&amount=undefined&system=undefined'Responses
🟢200
application/json
Bodyapplication/json
Example
{
"documentRequired": true,
"thresholdAmount": 0,
"thresholdCurrency": "string",
"amountInThresholdCurrency": 0
}🟠400
🟠404
🟠422
🔴500
Modified at 2026-10-29 19:39:20
Previous
Fetch outgoing transfer details by the specified transfer identifier.
Next
Get the additional payment-data fields (form descriptors) required for an outgoing transfer
from the given account to the given recipient over the given payment system — e.g. the UAE
purpose-of-payment code, or fields configured for the account's provid