Initiate Offramp Payout
Initiate a payout after crypto has been deposited to the offramp address. This converts the deposited crypto to fiat and sends it to the registered destination account.
curl --request POST \
--url https://api.carbnconnect.com/payment/api/v1/offramp/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "5d1aabf5-361e-4470-8b99-51d1ce3ef338",
"account_id": "5bc098b7-027f-48a9-9c67-c1666555f5a6",
"crypto_deposit_id": "0750ead5-7f17-4470-8b8f-f13429f7232e"
}
'import requests
url = "https://api.carbnconnect.com/payment/api/v1/offramp/payout"
payload = {
"user_id": "5d1aabf5-361e-4470-8b99-51d1ce3ef338",
"account_id": "5bc098b7-027f-48a9-9c67-c1666555f5a6",
"crypto_deposit_id": "0750ead5-7f17-4470-8b8f-f13429f7232e"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '5d1aabf5-361e-4470-8b99-51d1ce3ef338',
account_id: '5bc098b7-027f-48a9-9c67-c1666555f5a6',
crypto_deposit_id: '0750ead5-7f17-4470-8b8f-f13429f7232e'
})
};
fetch('https://api.carbnconnect.com/payment/api/v1/offramp/payout', 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.carbnconnect.com/payment/api/v1/offramp/payout",
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([
'user_id' => '5d1aabf5-361e-4470-8b99-51d1ce3ef338',
'account_id' => '5bc098b7-027f-48a9-9c67-c1666555f5a6',
'crypto_deposit_id' => '0750ead5-7f17-4470-8b8f-f13429f7232e'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.carbnconnect.com/payment/api/v1/offramp/payout"
payload := strings.NewReader("{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.carbnconnect.com/payment/api/v1/offramp/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/payment/api/v1/offramp/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "5bb01569-77ac-437a-82ef-a8f1deca18d5",
"status": "PAYMENT_SUBMITTED",
"source_amount": 2,
"destination_amount": 115.25,
"rail_fee": 10,
"account_details": {
"accountId": "6704bfed-79da-4a1c-89ac-0444ccd88db8",
"currency": "PHP",
"userId": "b8aacdf0-876b-43c1-bbe1-2f2465bbed86",
"bank_account": {
"bank_name": "seabank",
"account_holder_name": "Jhoebe Kates Albino",
"recipient_account_number": "14313487142"
},
"bank_account_type": "INDIVIDUAL"
}
}Authorizations
API key for authentication. Must be included in the x-api-key header.
Body
The unique identifier of the user
"5d1aabf5-361e-4470-8b99-51d1ce3ef338"
The unique identifier of the registered destination account
"5bc098b7-027f-48a9-9c67-c1666555f5a6"
The unique identifier of the crypto deposit transaction
"0750ead5-7f17-4470-8b8f-f13429f7232e"
Response
Payout initiated successfully
Unique identifier for the payout transaction
"5bb01569-77ac-437a-82ef-a8f1deca18d5"
Current status of the payout transaction
"PAYMENT_SUBMITTED"
Amount of crypto being converted (source amount)
2
Amount of fiat to be received (destination amount)
115.25
Rail fee charged for the transfer
10
Show child attributes
Show child attributes
curl --request POST \
--url https://api.carbnconnect.com/payment/api/v1/offramp/payout \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_id": "5d1aabf5-361e-4470-8b99-51d1ce3ef338",
"account_id": "5bc098b7-027f-48a9-9c67-c1666555f5a6",
"crypto_deposit_id": "0750ead5-7f17-4470-8b8f-f13429f7232e"
}
'import requests
url = "https://api.carbnconnect.com/payment/api/v1/offramp/payout"
payload = {
"user_id": "5d1aabf5-361e-4470-8b99-51d1ce3ef338",
"account_id": "5bc098b7-027f-48a9-9c67-c1666555f5a6",
"crypto_deposit_id": "0750ead5-7f17-4470-8b8f-f13429f7232e"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_id: '5d1aabf5-361e-4470-8b99-51d1ce3ef338',
account_id: '5bc098b7-027f-48a9-9c67-c1666555f5a6',
crypto_deposit_id: '0750ead5-7f17-4470-8b8f-f13429f7232e'
})
};
fetch('https://api.carbnconnect.com/payment/api/v1/offramp/payout', 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.carbnconnect.com/payment/api/v1/offramp/payout",
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([
'user_id' => '5d1aabf5-361e-4470-8b99-51d1ce3ef338',
'account_id' => '5bc098b7-027f-48a9-9c67-c1666555f5a6',
'crypto_deposit_id' => '0750ead5-7f17-4470-8b8f-f13429f7232e'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.carbnconnect.com/payment/api/v1/offramp/payout"
payload := strings.NewReader("{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.carbnconnect.com/payment/api/v1/offramp/payout")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/payment/api/v1/offramp/payout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"5d1aabf5-361e-4470-8b99-51d1ce3ef338\",\n \"account_id\": \"5bc098b7-027f-48a9-9c67-c1666555f5a6\",\n \"crypto_deposit_id\": \"0750ead5-7f17-4470-8b8f-f13429f7232e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "5bb01569-77ac-437a-82ef-a8f1deca18d5",
"status": "PAYMENT_SUBMITTED",
"source_amount": 2,
"destination_amount": 115.25,
"rail_fee": 10,
"account_details": {
"accountId": "6704bfed-79da-4a1c-89ac-0444ccd88db8",
"currency": "PHP",
"userId": "b8aacdf0-876b-43c1-bbe1-2f2465bbed86",
"bank_account": {
"bank_name": "seabank",
"account_holder_name": "Jhoebe Kates Albino",
"recipient_account_number": "14313487142"
},
"bank_account_type": "INDIVIDUAL"
}
}