Get transaction
curl --request GET \
--url https://api.fernhq.com/transactions/{transactionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fernhq.com/transactions/{transactionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fernhq.com/transactions/{transactionId}', 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://api.fernhq.com/transactions/{transactionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fernhq.com/transactions/{transactionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fernhq.com/transactions/{transactionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fernhq.com/transactions/{transactionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"transactionId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
"customerId": "0423300f-ae6d-4e82-8afb-a3b430e22e29",
"quoteId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
"transactionStatus": "PROCESSING",
"source": {
"sourceCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"sourcePaymentMethod": "ACH",
"sourceAmount": "100.00",
"sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
"sourceReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
},
"destination": {
"destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
"destinationPaymentMethod": "ETHEREUM",
"destinationCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"exchangeRate": "1.2",
"destinationAmount": "100",
"destinationReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
},
"fees": {
"feeCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"fernFee": {
"feeAmount": "5.45",
"feeUSDAmount": "5.45"
},
"developerFee": {
"feeAmount": "5.45",
"feeUSDAmount": "5.45"
}
},
"createdAt": "2023-08-01T12:00:00Z",
"updatedAt": "2023-08-01T12:00:00Z",
"correlationId": "03b7030f-6da1-4e76-3352-3debd82112c8",
"transferInstructions": {
"type": "fiat",
"transferPaymentMethod": "ACH",
"transferMessage": "Payment for order #12345",
"transferBankName": "First National Bank",
"transferBankAddress": "123 Bank St, Finance City",
"transferBankAccountNumber": "987654321",
"transferRoutingNumber": "123456789",
"transferBankBeneficiaryName": "John Doe",
"transferIban": "GB29NWBK60161331926819",
"transferBicSwift": "DEUTDEFF",
"transferIfscCode": "SBIN0005943",
"transferSortCode": "40-47-36",
"transferBsbNumber": "082-902",
"transferTransitNumber": "12345",
"transferBankCode": "001",
"transferClabeNumber": "002010077777777771",
"transferRoutingCode": "ROUT1234",
"transferBranchCode": "0001",
"transferClearingCode": "110000",
"transferCnapsCode": "102033003330",
"transferNubanCode": "1234567890",
"transferPixCode": "user@bank.com",
"transferPaymentLink": "https://secure.payzen.lat/t/paxsz1d7"
},
"expiresAt": "2023-08-01T12:05:00Z"
}Get transaction
Get a transaction by ID
GET
/
transactions
/
{transactionId}
Get transaction
curl --request GET \
--url https://api.fernhq.com/transactions/{transactionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fernhq.com/transactions/{transactionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fernhq.com/transactions/{transactionId}', 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://api.fernhq.com/transactions/{transactionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fernhq.com/transactions/{transactionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fernhq.com/transactions/{transactionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fernhq.com/transactions/{transactionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"transactionId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
"customerId": "0423300f-ae6d-4e82-8afb-a3b430e22e29",
"quoteId": "1d8beb26-b4d1-47ee-8e5d-0d3905f200c7",
"transactionStatus": "PROCESSING",
"source": {
"sourceCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"sourcePaymentMethod": "ACH",
"sourceAmount": "100.00",
"sourcePaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
"sourceReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
},
"destination": {
"destinationPaymentAccountId": "072a8b7b-38c7-429a-a6cf-35dae7f2fb77",
"destinationPaymentMethod": "ETHEREUM",
"destinationCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"exchangeRate": "1.2",
"destinationAmount": "100",
"destinationReferenceId": "0x5332ee2726b7a1b818447d116f81af3be3518a801fb229ebf43e563c0ac4b4bc"
},
"fees": {
"feeCurrency": {
"label": "USDC",
"chain": "ETHEREUM",
"contractAddress": "0x123456789abcd123456789abcd123456789abcd",
"currencyDecimals": 18
},
"fernFee": {
"feeAmount": "5.45",
"feeUSDAmount": "5.45"
},
"developerFee": {
"feeAmount": "5.45",
"feeUSDAmount": "5.45"
}
},
"createdAt": "2023-08-01T12:00:00Z",
"updatedAt": "2023-08-01T12:00:00Z",
"correlationId": "03b7030f-6da1-4e76-3352-3debd82112c8",
"transferInstructions": {
"type": "fiat",
"transferPaymentMethod": "ACH",
"transferMessage": "Payment for order #12345",
"transferBankName": "First National Bank",
"transferBankAddress": "123 Bank St, Finance City",
"transferBankAccountNumber": "987654321",
"transferRoutingNumber": "123456789",
"transferBankBeneficiaryName": "John Doe",
"transferIban": "GB29NWBK60161331926819",
"transferBicSwift": "DEUTDEFF",
"transferIfscCode": "SBIN0005943",
"transferSortCode": "40-47-36",
"transferBsbNumber": "082-902",
"transferTransitNumber": "12345",
"transferBankCode": "001",
"transferClabeNumber": "002010077777777771",
"transferRoutingCode": "ROUT1234",
"transferBranchCode": "0001",
"transferClearingCode": "110000",
"transferCnapsCode": "102033003330",
"transferNubanCode": "1234567890",
"transferPixCode": "user@bank.com",
"transferPaymentLink": "https://secure.payzen.lat/t/paxsz1d7"
},
"expiresAt": "2023-08-01T12:05:00Z"
}Authorizations
To authenticate server-side requests
Path Parameters
Unique identifier of the transaction
Response
Response schema for a transaction creation request
Response schema for a transaction creation request
Unique identifier of the transaction
Example:
"1d8beb26-b4d1-47ee-8e5d-0d3905f200c7"
ID of the customer associated with this transaction
Example:
"0423300f-ae6d-4e82-8afb-a3b430e22e29"
ID of the quote used for this transaction
Example:
"1d8beb26-b4d1-47ee-8e5d-0d3905f200c7"
Current status of the transaction
Available options:
AWAITING_TRANSFER, PROCESSING, COMPLETED, FAILED, CANCELLED, CREATED, EXPIRED Example:
"PROCESSING"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Fee structure for a transaction
Show child attributes
Show child attributes
ISO timestamp when this transaction was created
Example:
"2023-08-01T12:00:00Z"
ISO timestamp when this transaction was last updated
Example:
"2023-08-01T12:00:00Z"
Optional: You can add your own correlationId to match the transaction to your own internal records.
Example:
"03b7030f-6da1-4e76-3352-3debd82112c8"
Instructions for the customer to initiate the fiat transfer
- Fiat Transfer Instructions
- Crypto Transfer Instructions
Show child attributes
Show child attributes
ISO timestamp when this transaction expires (only for AWAITING_TRANSFER status)
Example:
"2023-08-01T12:05:00Z"
Was this page helpful?