Get Payin Recipient

Check whether a wallet’s address is registered (and approved) as an payin recipient with the provider.

GET /payins/recipients

Get Payin Recipient

cURL

curl --request GET \
  --url https://api.dfns.io/payins/recipients \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dfns.io/payins/recipients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dfns.io/payins/recipients', 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.dfns.io/payins/recipients",
  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.dfns.io/payins/recipients"

	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.dfns.io/payins/recipients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/payins/recipients")

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

200

{
  "provider": "CircleMint",
  "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
  "recipientAddressId": "<string>"
}

Authentication

✅ Organization User (CustomerEmployee)
✅ Delegated User (EndUser)
✅ Service Account

Required Permissions

Payins:Read: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Query Parameters

provider · enum<string> · required

The payin provider to check the recipient with.

Available options: CircleMint

walletId · string · required

The wallet whose recipient status to check.

Required string length: 1 - 64

currency · enum<string> · required

Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).

Available options: USD, EUR

Response

200 - application/json

Success

provider · enum<string> · required

Payin provider.

Available options: CircleMint

walletId · string · required

The wallet whose address is (to be) registered as a recipient.

Required string length: 1 - 64

Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

currency · enum<string> · required

Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).

Available options: USD, EUR

status · enum<string> · required

Recipient status.

Available options: NotRegistered, PendingVerification, Active

recipientAddressId · string

The provider's recipient-registry id, once registered.