Get a payment account

curl --request GET \
  --url https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId} \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}', 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-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

	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-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "externalFiatAccount",
  "nickname": "<string>",
  "externalFiatAccount": {
    "currency": "usd",
    "rail": "ach",
    "thirdParty": true,
    "beneficiaryFirstName": "<string>",
    "beneficiaryLastName": "<string>",
    "beneficiaryBusinessName": "<string>",
    "beneficiaryType": "individual",
    "beneficiaryAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>"
    },
    "bankName": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>"
    },
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "bankAccountType": "checking"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

{
  "statusCode": 403,
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "statusCode": 404,
  "error": "NotFoundError",
  "message": "Payment account not found"
}

{
  "statusCode": 500,
  "error": "InternalServerError",
  "message": "Internal server error"
}

GET

payment-accounts

{paymentAccountId}

Get a payment account

curl --request GET \
  --url https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId} \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}', 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-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

	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-dev.rain.xyz/v1/payment-accounts/{paymentAccountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "externalFiatAccount",
  "nickname": "<string>",
  "externalFiatAccount": {
    "currency": "usd",
    "rail": "ach",
    "thirdParty": true,
    "beneficiaryFirstName": "<string>",
    "beneficiaryLastName": "<string>",
    "beneficiaryBusinessName": "<string>",
    "beneficiaryType": "individual",
    "beneficiaryAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>"
    },
    "bankName": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "countryCode": "<string>",
      "addressLine2": "<string>"
    },
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "bankAccountType": "checking"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

{
  "statusCode": 403,
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "statusCode": 404,
  "error": "NotFoundError",
  "message": "Payment account not found"
}

{
  "statusCode": 500,
  "error": "InternalServerError",
  "message": "Internal server error"
}

Authorizations

Api-Key

string

header

required

Path Parameters

paymentAccountId

string<uuid>

required

ID of the payment account to retrieve

Response

Successful operation

string<uuid>

required

read-only

The unique identifier of the payment account

type

enum<string>

required

Available options:

externalFiatAccount

nickname

string

required

A friendly name for this payment account

Maximum string length: 64

externalFiatAccount

object

required

Show child attributes

createdAt

string<date-time>

required

read-only

When the payment account was created

userId

string<uuid>

User ID (present for individual teams; omit for company teams)

companyId

string<uuid>

Company ID (present for company teams; omit for individual teams)

Overview

Compliance

Cards

Payments

Webhooks

Webhook Events

Get a payment account

Authorizations

Path Parameters

Response