Get a payout RFI

curl --request GET \
  --url https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}', 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-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}",
  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-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}")

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

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "paymentId": "f4b26b87-0000-4c42-a8d6-000000000001",
    "status": "INFORMATION_REQUIRED",
    "level": "LEVEL_1",
    "expiresAt": "2020-04-17T02:13:30.000Z",
    "fieldRequirements": {
      "version": 1,
      "schema": {
        "type": "object",
        "required": [
          "purposeOfFunds"
        ],
        "properties": {
          "purposeOfFunds": {
            "type": "string"
          }
        }
      }
    },
    "fileRequirements": []
  }
}

{
  "code": 401,
  "message": "Malformed authorization."
}

{
  "code": 404,
  "message": "Not found."
}

GET

payouts

{id}

rfi

{rfiId}

Get a payout RFI

curl --request GET \
  --url https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}', 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-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}",
  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-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/payouts/{id}/rfi/{rfiId}")

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

{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "paymentId": "f4b26b87-0000-4c42-a8d6-000000000001",
    "status": "INFORMATION_REQUIRED",
    "level": "LEVEL_1",
    "expiresAt": "2020-04-17T02:13:30.000Z",
    "fieldRequirements": {
      "version": 1,
      "schema": {
        "type": "object",
        "required": [
          "purposeOfFunds"
        ],
        "properties": {
          "purposeOfFunds": {
            "type": "string"
          }
        }
      }
    },
    "fileRequirements": []
  }
}

{
  "code": 401,
  "message": "Malformed authorization."
}

{
  "code": 404,
  "message": "Not found."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

rfiId

string<uuid>

required

Universally unique identifier (UUID v4) of the RFI.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

Response

Successfully retrieved the payout RFI.

data

object

Details of a Request for Information (RFI) associated with a fiat payout.

Show child attributes

API overview

Fiat payouts

Managed Payments

Stablecoin payments

Circle Payments Network

Get a payout RFI

Authorizations

Path Parameters

Response