Create a new Deposit transaction
curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/deposits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"accountId": "cm2c4x3cc000019stwv7um4zl",
"fiat": "USD",
"country": "US",
"paymentMethod": "ACH",
"asset": "BTC",
"developerFee": "5.00",
"redirectUrl": "<string>",
"paymentInstructionId": "cm2c4x3cc000019stwv7um4zl",
"counterPartyIdentityId": "cm2c4x3cc000019stwv7um4zl",
"sourceAccountId": "cm2c4x3cc000019stwv7um4zl",
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
],
"quoteId": "cm2c4x3cc000019stwv7um4zl"
}
'import requests
url = "https://sandbox-api.borderless.xyz/v1/deposits"
payload = {
"amount": "100.00",
"accountId": "cm2c4x3cc000019stwv7um4zl",
"fiat": "USD",
"country": "US",
"paymentMethod": "ACH",
"asset": "BTC",
"developerFee": "5.00",
"redirectUrl": "<string>",
"paymentInstructionId": "cm2c4x3cc000019stwv7um4zl",
"counterPartyIdentityId": "cm2c4x3cc000019stwv7um4zl",
"sourceAccountId": "cm2c4x3cc000019stwv7um4zl",
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
],
"quoteId": "cm2c4x3cc000019stwv7um4zl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '100.00',
accountId: 'cm2c4x3cc000019stwv7um4zl',
fiat: 'USD',
country: 'US',
paymentMethod: 'ACH',
asset: 'BTC',
developerFee: '5.00',
redirectUrl: '<string>',
paymentInstructionId: 'cm2c4x3cc000019stwv7um4zl',
counterPartyIdentityId: 'cm2c4x3cc000019stwv7um4zl',
sourceAccountId: 'cm2c4x3cc000019stwv7um4zl',
documents: [{type: 'Invoice', content: 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'}],
quoteId: 'cm2c4x3cc000019stwv7um4zl'
})
};
fetch('https://sandbox-api.borderless.xyz/v1/deposits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.borderless.xyz/v1/deposits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '100.00',
'accountId' => 'cm2c4x3cc000019stwv7um4zl',
'fiat' => 'USD',
'country' => 'US',
'paymentMethod' => 'ACH',
'asset' => 'BTC',
'developerFee' => '5.00',
'redirectUrl' => '<string>',
'paymentInstructionId' => 'cm2c4x3cc000019stwv7um4zl',
'counterPartyIdentityId' => 'cm2c4x3cc000019stwv7um4zl',
'sourceAccountId' => 'cm2c4x3cc000019stwv7um4zl',
'documents' => [
[
'type' => 'Invoice',
'content' => 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'
]
],
'quoteId' => 'cm2c4x3cc000019stwv7um4zl'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.borderless.xyz/v1/deposits"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.borderless.xyz/v1/deposits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"source": {
"amount": "<string>",
"fiatCurrency": "<string>",
"accountId": "<string>",
"accountName": "<string>",
"sender": {
"name": "<string>",
"legalName": "<string>",
"description": "<string>",
"taxIdLast4": "<string>",
"bankName": "<string>",
"bankRoutingNumberLast4": "<string>",
"bankAccountNumberLast4": "<string>",
"accountNumberLast4": "<string>",
"traceNumber": "<string>",
"originatorName": "<string>",
"beneficiaryName": "<string>",
"wireMessage": "<string>",
"imad": "<string>",
"iban": "<string>",
"ibanLast4": "<string>",
"bic": "<string>",
"sortCode": "<string>",
"clabe": "<string>",
"trackingNumber": "<string>",
"reference": "<string>",
"uetr": "<string>",
"paymentScheme": "<string>",
"recipientName": "<string>"
}
},
"destination": {
"amount": "<string>",
"fiatCurrency": "<string>",
"imad": "<string>",
"reference": "<string>",
"omad": "<string>",
"traceNumber": "<string>",
"externalAddress": "<string>",
"accountId": "<string>",
"accountName": "<string>",
"paymentInstructionId": "<string>"
},
"instructions": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"txHash": [
"<string>"
],
"feeAmount": {},
"failureReason": {
"details": [
{
"path": "paymentInstruction",
"pfiErrorMessage": "bank.transitNumber must match /^([0-9]{3}-[0-9]{5}|[0-9]{5}-[0-9]{3})$/ regular expression"
}
],
"message": "Validation error from PFI"
},
"depositInstruction": {
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"bankSlug": "<string>",
"bankCode": "<string>",
"phone": "<string>",
"taxId": "<string>",
"bankAccountNumber": "123456789"
}
},
"withdrawalOnchainInstruction": {
"id": "<string>",
"amount": "100.00",
"asset": "BTC",
"fromAddress": "<string>",
"toAddress": "<string>",
"spenderAddress": "<string>",
"onchainInstructionTransaction": {
"id": "<string>",
"to": "<string>",
"from": "<string>",
"data": "<string>",
"nonce": "<string>",
"value": "<string>",
"chainId": 123,
"gasLimit": "<string>",
"gasPrice": "<string>",
"fee": "<string>",
"unsignedTx": "<string>",
"psbt": "<string>",
"inputs": {},
"outputs": {},
"walletId": "<string>",
"body": {},
"visible": true,
"txID": "<string>",
"rawData": {},
"rawDataHex": "<string>",
"spender": "<string>",
"mint": "<string>"
}
},
"counterPartyIdentityId": "<string>",
"virtualAccountId": "<string>",
"reconciliationWasRegressed": true,
"staleSince": "2023-11-07T05:31:56Z",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"destination": {},
"reason": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>"
}
}Transaction / Deposits
Create a new Deposit transaction
Create a new Deposit transaction using the data provided in the request body.
POST
/
v1
/
deposits
Create a new Deposit transaction
curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/deposits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "100.00",
"accountId": "cm2c4x3cc000019stwv7um4zl",
"fiat": "USD",
"country": "US",
"paymentMethod": "ACH",
"asset": "BTC",
"developerFee": "5.00",
"redirectUrl": "<string>",
"paymentInstructionId": "cm2c4x3cc000019stwv7um4zl",
"counterPartyIdentityId": "cm2c4x3cc000019stwv7um4zl",
"sourceAccountId": "cm2c4x3cc000019stwv7um4zl",
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
],
"quoteId": "cm2c4x3cc000019stwv7um4zl"
}
'import requests
url = "https://sandbox-api.borderless.xyz/v1/deposits"
payload = {
"amount": "100.00",
"accountId": "cm2c4x3cc000019stwv7um4zl",
"fiat": "USD",
"country": "US",
"paymentMethod": "ACH",
"asset": "BTC",
"developerFee": "5.00",
"redirectUrl": "<string>",
"paymentInstructionId": "cm2c4x3cc000019stwv7um4zl",
"counterPartyIdentityId": "cm2c4x3cc000019stwv7um4zl",
"sourceAccountId": "cm2c4x3cc000019stwv7um4zl",
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
],
"quoteId": "cm2c4x3cc000019stwv7um4zl"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '100.00',
accountId: 'cm2c4x3cc000019stwv7um4zl',
fiat: 'USD',
country: 'US',
paymentMethod: 'ACH',
asset: 'BTC',
developerFee: '5.00',
redirectUrl: '<string>',
paymentInstructionId: 'cm2c4x3cc000019stwv7um4zl',
counterPartyIdentityId: 'cm2c4x3cc000019stwv7um4zl',
sourceAccountId: 'cm2c4x3cc000019stwv7um4zl',
documents: [{type: 'Invoice', content: 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'}],
quoteId: 'cm2c4x3cc000019stwv7um4zl'
})
};
fetch('https://sandbox-api.borderless.xyz/v1/deposits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.borderless.xyz/v1/deposits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '100.00',
'accountId' => 'cm2c4x3cc000019stwv7um4zl',
'fiat' => 'USD',
'country' => 'US',
'paymentMethod' => 'ACH',
'asset' => 'BTC',
'developerFee' => '5.00',
'redirectUrl' => '<string>',
'paymentInstructionId' => 'cm2c4x3cc000019stwv7um4zl',
'counterPartyIdentityId' => 'cm2c4x3cc000019stwv7um4zl',
'sourceAccountId' => 'cm2c4x3cc000019stwv7um4zl',
'documents' => [
[
'type' => 'Invoice',
'content' => 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'
]
],
'quoteId' => 'cm2c4x3cc000019stwv7um4zl'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.borderless.xyz/v1/deposits"
payload := strings.NewReader("{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.borderless.xyz/v1/deposits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"100.00\",\n \"accountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"fiat\": \"USD\",\n \"country\": \"US\",\n \"paymentMethod\": \"ACH\",\n \"asset\": \"BTC\",\n \"developerFee\": \"5.00\",\n \"redirectUrl\": \"<string>\",\n \"paymentInstructionId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"counterPartyIdentityId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"sourceAccountId\": \"cm2c4x3cc000019stwv7um4zl\",\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ],\n \"quoteId\": \"cm2c4x3cc000019stwv7um4zl\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"source": {
"amount": "<string>",
"fiatCurrency": "<string>",
"accountId": "<string>",
"accountName": "<string>",
"sender": {
"name": "<string>",
"legalName": "<string>",
"description": "<string>",
"taxIdLast4": "<string>",
"bankName": "<string>",
"bankRoutingNumberLast4": "<string>",
"bankAccountNumberLast4": "<string>",
"accountNumberLast4": "<string>",
"traceNumber": "<string>",
"originatorName": "<string>",
"beneficiaryName": "<string>",
"wireMessage": "<string>",
"imad": "<string>",
"iban": "<string>",
"ibanLast4": "<string>",
"bic": "<string>",
"sortCode": "<string>",
"clabe": "<string>",
"trackingNumber": "<string>",
"reference": "<string>",
"uetr": "<string>",
"paymentScheme": "<string>",
"recipientName": "<string>"
}
},
"destination": {
"amount": "<string>",
"fiatCurrency": "<string>",
"imad": "<string>",
"reference": "<string>",
"omad": "<string>",
"traceNumber": "<string>",
"externalAddress": "<string>",
"accountId": "<string>",
"accountName": "<string>",
"paymentInstructionId": "<string>"
},
"instructions": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"txHash": [
"<string>"
],
"feeAmount": {},
"failureReason": {
"details": [
{
"path": "paymentInstruction",
"pfiErrorMessage": "bank.transitNumber must match /^([0-9]{3}-[0-9]{5}|[0-9]{5}-[0-9]{3})$/ regular expression"
}
],
"message": "Validation error from PFI"
},
"depositInstruction": {
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"bankSlug": "<string>",
"bankCode": "<string>",
"phone": "<string>",
"taxId": "<string>",
"bankAccountNumber": "123456789"
}
},
"withdrawalOnchainInstruction": {
"id": "<string>",
"amount": "100.00",
"asset": "BTC",
"fromAddress": "<string>",
"toAddress": "<string>",
"spenderAddress": "<string>",
"onchainInstructionTransaction": {
"id": "<string>",
"to": "<string>",
"from": "<string>",
"data": "<string>",
"nonce": "<string>",
"value": "<string>",
"chainId": 123,
"gasLimit": "<string>",
"gasPrice": "<string>",
"fee": "<string>",
"unsignedTx": "<string>",
"psbt": "<string>",
"inputs": {},
"outputs": {},
"walletId": "<string>",
"body": {},
"visible": true,
"txID": "<string>",
"rawData": {},
"rawDataHex": "<string>",
"spender": "<string>",
"mint": "<string>"
}
},
"counterPartyIdentityId": "<string>",
"virtualAccountId": "<string>",
"reconciliationWasRegressed": true,
"staleSince": "2023-11-07T05:31:56Z",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"destination": {},
"reason": {},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
- Deposit (crypto)
- Deposit (PFI fiat)
The amount for the operation. For deposits, this is the fiat amount the user must contribute. For withdrawals, this is the amount of the asset to be withdrawn.
Example:
"100.00"
The id of the account associated with the operation. For withdrawals, this is the account from which assets will be withdrawn. For deposits, this is the account where assets will be deposited.
Example:
"cm2c4x3cc000019stwv7um4zl"
The fiat currency used for the deposit operation.
Available options:
USD, EUR, BRL, ARS, MXN, COP, CLP, PEN, PYG, DOP, UYU, BOB, CRC, GTQ, BWP, CDF, GHS, KES, MWK, NGN, RWF, ZAR, TZS, UGX, ZMW, XOF, XAF, AUD, BDT, CAD, INR, JPY, NPR, PKR, PHP, SGD, GBP, CNY, HKD, IDR, MYR, KRW, LKR, THB, TRY, VND, CZK, DKK, NOK, PLN, RON, RSD, SEK, CHF, AED, SAR, QAR, ILS, EGP, JOD, HNL, JMD, NZD, DZD, GMD, GNF, HTG, MAD, TND Example:
"USD"
The country code in ISO-3166-2 format for the region where the deposit is performed.
Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CD, CG, CK, CR, HR, CU, CW, CY, CZ, CI, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, MK, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, ZZ Example:
"US"
The payment method used for the deposit transaction. Learn more at Payment Methods Documentation.
Available options:
ACH, Wire, Sepa, Swift, Card, MobileMoney, PIX, TED, PSE, SPEI, COELSA, Transfers30, SPAV, CCE, SPI, LBTR, SINPE, Transfer365, NIP, GhIPSS, BankTransfer, EFT, RTP, BECS, FPS, IMPS_FIRC, Breb, NPSS, MADA, ZAHAV, IBFT, SIC Example:
"ACH"
The token tied to a specific blockchain for the deposit. See the list of supported deposit assets.
Available options:
POL, USDT_POLYGON, USDC_POLYGON, SBC_POLYGON, ETH, USDT_ETHEREUM, USDC_ETHEREUM, PYUSD_ETHEREUM, DAI_ETHEREUM, SBC_ETHEREUM, TRX, USDT_TRON, SBC_TRON, ETH_BASE, USDC_BASE, USDB_BASE, EURC_BASE, SBC_BASE, ETH_OPTIMISM, USDT_OPTIMISM, USDC_OPTIMISM, BTC, CELO, CUSD_CELO, USDC_CELO, SBC_CELO, SOL, USDC_SOLANA, USDT_SOLANA, PYUSD_SOLANA, USDP_SOLANA, EURC_SOLANA, SBC_SOLANA Example:
"BTC"
An optional developer fee for the operation, if applicable
Example:
"5.00"
Specific PFI to use for this operation. If omitted, the organization's default PFI is used.
Available options:
Bridge, Koywe, Kotanipay, Hercle, Bitso, Yellowcard, TraceFinance, HoneyCoin, BlindPay, Finity, Infinia, Walapay, Abra, Yativo, Capa, Bivo, Cobre, Avenia, Brale, BVNK, CoinsPH, Iron, Enigma, Juicyway, Kira, TripleA, Onmeta, Alfred, Demo, CrissCross The details of the deposit source. Some deposit payment methods (e.g. mobile money) require you to specify source account info.
Show child attributes
Show child attributes
The URL to redirect the user after the deposit is completed. This url is used: MobileMoney and EFT (South Africa); PSE (Colombia) payment methods.
The ID of the payment instruction containing bank details for the deposit. Required for certain payment providers (e.g. Onmeta).
Example:
"cm2c4x3cc000019stwv7um4zl"
The ID of the identity on whose behalf the deposit is being initiated. Provide this only if the deposit should be linked to a different identity than the one associated with the account. If not specified, the deposit will be initiated for the identity tied to the account by default.
Example:
"cm2c4x3cc000019stwv7um4zl"
The ID of the account that funds this deposit at the payment provider (the merchant balance account). Use it to select which configured merchant's credentials are used. Required when the organization has multiple merchants configured; optional when a single set of credentials is configured.
Example:
"cm2c4x3cc000019stwv7um4zl"
Documents may be required by certain countries or payment providers (for example, an invoice, contract, or agreement)
Show child attributes
Show child attributes
The id of an executable quote previously created via POST /deposits/quotes. When provided, the deposit is initiated using the locked exchange rate and fees from that quote, as long as the quote has not expired.
Example:
"cm2c4x3cc000019stwv7um4zl"
Response
Successfully created Deposit transaction data.
Available options:
Deposit, Withdrawal, Exchange Available options:
Submitted, Verifying, Orchestrating, Pending, Processing, Completed, Failed, Cancelled, Refunded Available options:
Bridge, Koywe, Kotanipay, Hercle, Bitso, Yellowcard, TraceFinance, HoneyCoin, BlindPay, Finity, Infinia, Walapay, Abra, Yativo, Capa, Bivo, Cobre, Avenia, Brale, BVNK, CoinsPH, Iron, Enigma, Juicyway, Kira, TripleA, Onmeta, Alfred, Demo, CrissCross Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CD, CG, CK, CR, HR, CU, CW, CY, CZ, CI, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, MK, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, ZZ Show child attributes
Show child attributes
Show child attributes
Show child attributes
Deprecated. Use withdrawalOnchainInstruction or depositInstruction instead.
Example:
{
"details": [
{
"path": "paymentInstruction",
"pfiErrorMessage": "bank.transitNumber must match /^([0-9]{3}-[0-9]{5}|[0-9]{5}-[0-9]{3})$/ regular expression"
}
],
"message": "Validation error from PFI"
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
Matched, Mismatched, Missing, PfiError Available options:
Competitive, InLine, OffMarket Available options:
Classified, Calibrating, Stale, NoRateProduced, Syncing Available options:
Strong, Standard Available options:
Competitive, InLine, OffMarket Available options:
Reconciliation, Import, CsvImport Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
Get available finance institutions (e.g. banks, mobile money providers)Deprecated. Use GET /organizations/network instead.
⌘I