Bakkt Crypto Solutions

Authorization
- Loginpost
Instruments
- Retrieve Instrument Definitionsget
Orders
Positions
- Retrieve Crypto Positionsget
Accounts
Configuration and Status
- Check the Health of the API Gatewayget
- Get Client Connection Configurationsget
Documents
Agreements
Transfers
Jurisdictions
- Retrieve Jurisdiction Definitionsget
- Retrieve Jurisdiction Definitionsget
Currency Onboarding
Document Verification
- Get Partner Party Document Verification Detailsget
Fiat Onboarding
Gift
- Request For Giftpost
- Retrieve Gift Details By clientTransactionIdget
Block Trade & Allocate

Bakkt® Fiat API

Partner Connectivity
- Generate Access Tokenpost
- Check connectivity with Bakkt backendpost
Partner Party Linking
Partner Party Funding

Bakkt® Trust Custody

Auth Token
- Retrieve an auth token for accessing custody api's.post
Organization
- Retrieve organizations based on various parameters.get
Wallet
WalletTransaction
Allowlist

Bakkt Crypto Solutions

Authorization
- Loginpost
Instruments
- Retrieve Instrument Definitionsget
Orders
Positions
- Retrieve Crypto Positionsget
Accounts
Configuration and Status
- Check the Health of the API Gatewayget
- Get Client Connection Configurationsget
Documents
Agreements
Transfers
Jurisdictions
- Retrieve Jurisdiction Definitionsget
- Retrieve Jurisdiction Definitionsget
Currency Onboarding
Document Verification
- Get Partner Party Document Verification Detailsget
Fiat Onboarding
Gift
- Request For Giftpost
- Retrieve Gift Details By clientTransactionIdget
Block Trade & Allocate

Bakkt® Fiat API

Partner Connectivity
- Generate Access Tokenpost
- Check connectivity with Bakkt backendpost
Partner Party Linking
Partner Party Funding

Bakkt® Trust Custody

Auth Token
- Retrieve an auth token for accessing custody api's.post
Organization
- Retrieve organizations based on various parameters.get
Wallet
WalletTransaction
Allowlist

Request For Currency Allocation

post https://apex-crypto/api/v2/allocation/currency/batch/allocate

Currency allocation request for a single customer account

Body Params

account

string

required

External ID for customer account

batchTransactionId

string

required

Client-specified unique identifier for a set of currency allocations belonging to the same batch

clientTransactionId

string

required

Client-specified unique identifier for the currency allocation

currency

string

required

Requested currency

direction

string

required

Denotes whether depositing or withdrawing currency

quantity

string

required

Order size in product units

Responses

Response body

object

createdAt

date-time

required

Date at which the currency allocation batch was submitted

string

required

Bakkt unique identifier for the currency allocation

rejectReason

string

The reason the currency allocation was rejected

request

object

required

Currency allocation request for a single customer account

account

string

required

External ID for customer account

batchTransactionId

string

required

Client-specified unique identifier for a set of currency allocations belonging to the same batch

clientTransactionId

string

required

Client-specified unique identifier for the currency allocation

currency

string

required

Requested currency

direction

string

required

Denotes whether depositing or withdrawing currency

DEPOSIT WITHDRAWAL

quantity

string

required

Order size in product units

status

string

required

Status of allocation

PENDING IN_PROGRESS COMPLETE REJECTED CANCELLED

Response body

object

code

int32

required

This code represents an HTTP style error code. Error codes in the 4xx range indicate errors made in the way the client made the request. Error codes in the 5xx range indicate errors that the Apex Crypto system encountered in handling the request.

message

string

required

This error message provides additional insight into the nature of the error encountered.

Response body

object

code

int32

required

message

string

required

This error message provides additional insight into the nature of the error encountered.

Updated over 1 year ago

Retrieve Jurisdiction Definitions

Retrieve Currency Allocation Details By clientTransactionId

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://apex-crypto/api/v2/allocation/currency/batch/allocate \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "direction": "DEPOSIT"
8
}
9
'

Choose an example:

application/json

Updated over 1 year ago

Retrieve Jurisdiction Definitions

Retrieve Currency Allocation Details By clientTransactionId

Did this page help you?

Bakkt Crypto Solutions
Authorization
Loginpost
Instruments
Retrieve Instrument Definitionsget
Orders
Submit a Request to Cancel an Orderpost
Retrieve an Order by Client Order IDget
Retrieve Order Entry Eventsget
Submit an Order to Buy or Sell Cryptopost
Retrieve a List of Ordersget
Positions
Retrieve Crypto Positionsget
Accounts
Retrieves account status by Account IDget
Retrieves Accounts by Account IDget
Trigger KYB Screening on Accountpost
Update Settlement Method on Accountpost
Create a New User Accountpost
Configuration and Status
Get Client Connection Configurationsget
Check the Health of the API Gatewayget
Documents
Retrieve Metadata for Specific Documentget
Download Documentget
Upload Document and Metadatapost
Agreements
Transfers
Retrieve the Withdrawal Statusget
Retrieve a Fee Estimate to Complete a Withdrawalpost
Create a Crypto Withdrawal Requestpost
Verify that a wallet address is valid prior to using it in a transfer request.post
Lookup the name of a vasp associated with a wallet address.get
Retrieve a List of Transfersget
Retrieve a Wallet Receive Addresspost
Jurisdictions
Retrieve Jurisdiction Definitionsget
Retrieve Jurisdiction Definitionsget
Currency Onboarding
Retrieve Currency Allocation Details By batchTransactionIdget
Request For New Currency Allocation Batchpost
Request To Close Currency Allocation Batchpost
Retrieve Currency Allocation Details By clientTransactionIdget
Request For Currency Allocationpost
Document Verification
Get Partner Party Document Verification Detailsget
Fiat Onboarding
Retrieve Fiat Allocation Details By batchTransactionIdget
Request For New Fiat Allocation Batchpost
Request To Close Fiat Allocation Batchpost
Retrieve Fiat Allocation Details By clientTransactionIdget
Request For Fiat Allocationpost
Gift
Retrieve Gift Details By clientTransactionIdget
Request For Giftpost
Block Trade & Allocate
Retrieve Allocation Details By batchTransactionIdget
Request For New Allocation Batchpost
Request To Close Allocation Batchpost
Retrieve Allocation Details By clientTransactionIdget
Request For Allocationpost

Bakkt® Fiat API
Partner Connectivity
Check connectivity with Bakkt backendpost
Generate Access Tokenpost
Partner Party Linking
Add Bank Accountpost
Link a Plaid account using processor tokenpost
Unlink a fiat accountpost
URL for linking fiat accountpost
Partner Party Funding
Retrieve Fiat Account Balanceget
Generate inbound wire instructionsget
Add Bank Account - Wirepost
Add Bank Account - ACHpost
Unlink fiat Accountpost
Deposit or withdraw fundspost

Bakkt® Trust Custody
Auth Token
Retrieve an auth token for accessing custody api's.post
Organization
Retrieve organizations based on various parameters.get
Wallet
Finds a Wallet based on Wallet Idget
Create a new walletpost
Retrieve wallets based on any of the search criteria belowget
WalletTransaction
Create Transactionpost
Finds wallet transactions based on specified search criteriaget
Retrieve wallet transactions based on any of the search criteria belowget
Allowlist
Get Allow List Address by idget
Create Allowlistpost
Get Allow List Addressesget

Bakkt Crypto Solutions
Authorization
Loginpost
Instruments
Retrieve Instrument Definitionsget
Orders
Submit a Request to Cancel an Orderpost
Retrieve an Order by Client Order IDget
Retrieve Order Entry Eventsget
Submit an Order to Buy or Sell Cryptopost
Retrieve a List of Ordersget
Positions
Retrieve Crypto Positionsget
Accounts
Retrieves account status by Account IDget
Retrieves Accounts by Account IDget
Trigger KYB Screening on Accountpost
Update Settlement Method on Accountpost
Create a New User Accountpost
Configuration and Status
Get Client Connection Configurationsget
Check the Health of the API Gatewayget
Documents
Retrieve Metadata for Specific Documentget
Download Documentget
Upload Document and Metadatapost
Agreements
Transfers
Retrieve the Withdrawal Statusget
Retrieve a Fee Estimate to Complete a Withdrawalpost
Create a Crypto Withdrawal Requestpost
Verify that a wallet address is valid prior to using it in a transfer request.post
Lookup the name of a vasp associated with a wallet address.get
Retrieve a List of Transfersget
Retrieve a Wallet Receive Addresspost
Jurisdictions
Retrieve Jurisdiction Definitionsget
Retrieve Jurisdiction Definitionsget
Currency Onboarding
Retrieve Currency Allocation Details By batchTransactionIdget
Request For New Currency Allocation Batchpost
Request To Close Currency Allocation Batchpost
Retrieve Currency Allocation Details By clientTransactionIdget
Request For Currency Allocationpost
Document Verification
Get Partner Party Document Verification Detailsget
Fiat Onboarding
Retrieve Fiat Allocation Details By batchTransactionIdget
Request For New Fiat Allocation Batchpost
Request To Close Fiat Allocation Batchpost
Retrieve Fiat Allocation Details By clientTransactionIdget
Request For Fiat Allocationpost
Gift
Retrieve Gift Details By clientTransactionIdget
Request For Giftpost
Block Trade & Allocate
Retrieve Allocation Details By batchTransactionIdget
Request For New Allocation Batchpost
Request To Close Allocation Batchpost
Retrieve Allocation Details By clientTransactionIdget
Request For Allocationpost

Bakkt® Fiat API
Partner Connectivity
Check connectivity with Bakkt backendpost
Generate Access Tokenpost
Partner Party Linking
Add Bank Accountpost
Link a Plaid account using processor tokenpost
Unlink a fiat accountpost
URL for linking fiat accountpost
Partner Party Funding
Retrieve Fiat Account Balanceget
Generate inbound wire instructionsget
Add Bank Account - Wirepost
Add Bank Account - ACHpost
Unlink fiat Accountpost
Deposit or withdraw fundspost

Bakkt® Trust Custody
Auth Token
Retrieve an auth token for accessing custody api's.post
Organization
Retrieve organizations based on various parameters.get
Wallet
Finds a Wallet based on Wallet Idget
Create a new walletpost
Retrieve wallets based on any of the search criteria belowget
WalletTransaction
Create Transactionpost
Finds wallet transactions based on specified search criteriaget
Retrieve wallet transactions based on any of the search criteria belowget
Allowlist
Get Allow List Address by idget
Create Allowlistpost
Get Allow List Addressesget

200Successful submission of currency allocation request

400This response returns if the check was improperly submitted.

defaultThis response returns if the system encounters an unexpected error while handling this request.