Attach documents to a transaction.
curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
]
}
'import requests
url = "https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents"
payload = { "documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
] }
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({
documents: [{type: 'Invoice', content: 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'}]
})
};
fetch('https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents', 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/transactions/{id}/documents",
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([
'documents' => [
[
'type' => 'Invoice',
'content' => 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'
]
]
]),
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/transactions/{id}/documents"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\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/transactions/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents")
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 \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "Deposit",
"status": "Submitted",
"pfiName": "Bridge",
"country": "AF",
"source": {
"asset": "POL",
"amount": "<string>",
"fiatCurrency": "<string>",
"paymentMethod": "ACH",
"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": {
"asset": "POL",
"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>"
],
"externalTransactions": [
{
"externalId": "<string>",
"provider": "Standalone"
}
],
"feeAmount": {},
"networkFee": "<string>",
"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": {
"paymentMethod": "ACH",
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"paymentMethod": "ACH",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"bankAccountType": "Checking",
"recipientRelationship": "first party",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "AF",
"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>",
"type": "Transfer",
"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>",
"liquidationAddressId": "<string>",
"uploadedDocumentTypes": [
"Invoice"
],
"documentsRequired": true,
"reconciliationStatus": "Matched",
"reconciliationWasRegressed": true,
"rateGrade": "Competitive",
"rateStatus": "Classified",
"rateConfidenceTier": "Strong",
"lastKnownGrade": "Competitive",
"staleSince": "2023-11-07T05:31:56Z",
"pfiTransactionSource": "Reconciliation",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"dispatchable": true,
"path": "PfiAutoReversal",
"status": "Created",
"destinationSource": "None",
"destination": {
"type": "Address",
"address": "<string>",
"autoRefund": true,
"autoFiatReturn": true
},
"reason": {
"message": "<string>",
"details": [
{}
]
},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>",
"centerSourceLabel": "<string>",
"anchorMode": "Achieved",
"topOrgShare": "<string>",
"bandWidened": "<string>",
"methodologyVersion": "<string>"
}
}{
"id": "<string>",
"type": "Deposit",
"status": "Submitted",
"pfiName": "Bridge",
"country": "AF",
"source": {
"asset": "POL",
"amount": "<string>",
"fiatCurrency": "<string>",
"paymentMethod": "ACH",
"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": {
"asset": "POL",
"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>"
],
"externalTransactions": [
{
"externalId": "<string>",
"provider": "Standalone"
}
],
"feeAmount": {},
"networkFee": "<string>",
"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": {
"paymentMethod": "ACH",
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"paymentMethod": "ACH",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"bankAccountType": "Checking",
"recipientRelationship": "first party",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "AF",
"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>",
"type": "Transfer",
"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>",
"liquidationAddressId": "<string>",
"uploadedDocumentTypes": [
"Invoice"
],
"documentsRequired": true,
"reconciliationStatus": "Matched",
"reconciliationWasRegressed": true,
"rateGrade": "Competitive",
"rateStatus": "Classified",
"rateConfidenceTier": "Strong",
"lastKnownGrade": "Competitive",
"staleSince": "2023-11-07T05:31:56Z",
"pfiTransactionSource": "Reconciliation",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"dispatchable": true,
"path": "PfiAutoReversal",
"status": "Created",
"destinationSource": "None",
"destination": {
"type": "Address",
"address": "<string>",
"autoRefund": true,
"autoFiatReturn": true
},
"reason": {
"message": "<string>",
"details": [
{}
]
},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>",
"centerSourceLabel": "<string>",
"anchorMode": "Achieved",
"topOrgShare": "<string>",
"bandWidened": "<string>",
"methodologyVersion": "<string>"
}
}Transactions
Attach documents to a transaction.
Uploads transaction documents (e.g. an invoice) for a pending or processing transaction. For payments that require a compliance document, such as SWIFT payouts from a liquidation address, the document is forwarded to the payment provider so the payment can proceed.
POST
/
v1
/
transactions
/
{id}
/
documents
Attach documents to a transaction.
curl --request POST \
--url https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
]
}
'import requests
url = "https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents"
payload = { "documents": [
{
"type": "Invoice",
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
] }
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({
documents: [{type: 'Invoice', content: 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'}]
})
};
fetch('https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents', 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/transactions/{id}/documents",
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([
'documents' => [
[
'type' => 'Invoice',
'content' => 'data:image/jpeg;base64,/9j/4AAQSkZJRg...'
]
]
]),
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/transactions/{id}/documents"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\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/transactions/{id}/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.borderless.xyz/v1/transactions/{id}/documents")
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 \"documents\": [\n {\n \"type\": \"Invoice\",\n \"content\": \"data:image/jpeg;base64,/9j/4AAQSkZJRg...\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "Deposit",
"status": "Submitted",
"pfiName": "Bridge",
"country": "AF",
"source": {
"asset": "POL",
"amount": "<string>",
"fiatCurrency": "<string>",
"paymentMethod": "ACH",
"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": {
"asset": "POL",
"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>"
],
"externalTransactions": [
{
"externalId": "<string>",
"provider": "Standalone"
}
],
"feeAmount": {},
"networkFee": "<string>",
"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": {
"paymentMethod": "ACH",
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"paymentMethod": "ACH",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"bankAccountType": "Checking",
"recipientRelationship": "first party",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "AF",
"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>",
"type": "Transfer",
"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>",
"liquidationAddressId": "<string>",
"uploadedDocumentTypes": [
"Invoice"
],
"documentsRequired": true,
"reconciliationStatus": "Matched",
"reconciliationWasRegressed": true,
"rateGrade": "Competitive",
"rateStatus": "Classified",
"rateConfidenceTier": "Strong",
"lastKnownGrade": "Competitive",
"staleSince": "2023-11-07T05:31:56Z",
"pfiTransactionSource": "Reconciliation",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"dispatchable": true,
"path": "PfiAutoReversal",
"status": "Created",
"destinationSource": "None",
"destination": {
"type": "Address",
"address": "<string>",
"autoRefund": true,
"autoFiatReturn": true
},
"reason": {
"message": "<string>",
"details": [
{}
]
},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>",
"centerSourceLabel": "<string>",
"anchorMode": "Achieved",
"topOrgShare": "<string>",
"bandWidened": "<string>",
"methodologyVersion": "<string>"
}
}{
"id": "<string>",
"type": "Deposit",
"status": "Submitted",
"pfiName": "Bridge",
"country": "AF",
"source": {
"asset": "POL",
"amount": "<string>",
"fiatCurrency": "<string>",
"paymentMethod": "ACH",
"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": {
"asset": "POL",
"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>"
],
"externalTransactions": [
{
"externalId": "<string>",
"provider": "Standalone"
}
],
"feeAmount": {},
"networkFee": "<string>",
"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": {
"paymentMethod": "ACH",
"details": {
"depositMessage": "<string>",
"bankAccountNumber": "<string>",
"bankRoutingNumber": "<string>",
"bankBeneficiaryName": "<string>",
"bankBeneficiaryAddress": "<string>",
"bankName": "<string>",
"bankAddress": "<string>",
"bic": "<string>"
}
},
"destinationPaymentInstruction": {
"id": "<string>",
"identityId": "<string>",
"name": "<string>",
"paymentMethod": "ACH",
"currency": "USD",
"country": "US",
"deleted": false,
"createdAt": "2023-11-07T05:31:56Z",
"details": {
"bankName": "Chase",
"accountHolderName": "John Doe",
"bankAccountNumberLast4": "6789",
"bankRoutingNumber": "021000021",
"bankAccountType": "Checking",
"recipientRelationship": "first party",
"address": {
"id": "<string>",
"street1": "<string>",
"street2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "AF",
"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>",
"type": "Transfer",
"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>",
"liquidationAddressId": "<string>",
"uploadedDocumentTypes": [
"Invoice"
],
"documentsRequired": true,
"reconciliationStatus": "Matched",
"reconciliationWasRegressed": true,
"rateGrade": "Competitive",
"rateStatus": "Classified",
"rateConfidenceTier": "Strong",
"lastKnownGrade": "Competitive",
"staleSince": "2023-11-07T05:31:56Z",
"pfiTransactionSource": "Reconciliation",
"developerFeeAmount": {},
"refundResolution": {
"supported": true,
"requiresManualAction": true,
"dispatchable": true,
"path": "PfiAutoReversal",
"status": "Created",
"destinationSource": "None",
"destination": {
"type": "Address",
"address": "<string>",
"autoRefund": true,
"autoFiatReturn": true
},
"reason": {
"message": "<string>",
"details": [
{}
]
},
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z"
},
"importBenchmark": {
"benchmarkMean": "<string>",
"benchmarkStddev": "<string>",
"observationCount": 123,
"deviation": "<string>",
"bestRate": "<string>",
"centerSourceLabel": "<string>",
"anchorMode": "Achieved",
"topOrgShare": "<string>",
"bandWidened": "<string>",
"methodologyVersion": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Documents to attach to the transaction.
Minimum array length:
1Show child attributes
Show child attributes
Response
Successfully retrieved Transaction data.
Available options:
Deposit, Withdrawal, Exchange Available options:
Submitted, Verifying, Orchestrating, Pending, Processing, AwaitingDocuments, 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, Kira, TripleA, Onmeta, Alfred, Tazapay, Demo, CrissCross, Pockyt 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.
Show child attributes
Show child attributes
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:
Invoice, Other Whether the payment provider requires a transaction document (e.g. an invoice) before the payment can proceed.
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?
⌘I