Create a payment account
curl --request POST \
--url https://api-dev.rain.xyz/v1/payment-accounts \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "externalFiatAccount",
"nickname": "<string>",
"externalFiatAccount": {
"beneficiaryType": "individual",
"beneficiaryFirstName": "<string>",
"beneficiaryLastName": "<string>",
"currency": "usd",
"thirdParty": true,
"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>"
},
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-dev.rain.xyz/v1/payment-accounts"
payload = {
"type": "externalFiatAccount",
"nickname": "<string>",
"externalFiatAccount": {
"beneficiaryType": "individual",
"beneficiaryFirstName": "<string>",
"beneficiaryLastName": "<string>",
"currency": "usd",
"thirdParty": True,
"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>"
},
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'externalFiatAccount',
nickname: '<string>',
externalFiatAccount: {
beneficiaryType: 'individual',
beneficiaryFirstName: '<string>',
beneficiaryLastName: '<string>',
currency: 'usd',
thirdParty: true,
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>'
},
userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-dev.rain.xyz/v1/payment-accounts', 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",
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([
'type' => 'externalFiatAccount',
'nickname' => '<string>',
'externalFiatAccount' => [
'beneficiaryType' => 'individual',
'beneficiaryFirstName' => '<string>',
'beneficiaryLastName' => '<string>',
'currency' => 'usd',
'thirdParty' => true,
'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>'
],
'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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-dev.rain.xyz/v1/payment-accounts"
payload := strings.NewReader("{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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-dev.rain.xyz/v1/payment-accounts")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/payment-accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
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": 400,
"error": "BadRequestError",
"message": "Invalid request"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key"
}{
"statusCode": 403,
"error": "ForbiddenError",
"message": "Forbidden"
}{
"statusCode": 404,
"error": "NotFoundError",
"message": "Team not found"
}{
"statusCode": 500,
"error": "InternalServerError",
"message": "Internal server error"
}Payment Accounts
Create a payment account
Creates a payment account that can be used as a destination for payment routes and transfers. Supports external fiat accounts.
POST
/
payment-accounts
Create a payment account
curl --request POST \
--url https://api-dev.rain.xyz/v1/payment-accounts \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "externalFiatAccount",
"nickname": "<string>",
"externalFiatAccount": {
"beneficiaryType": "individual",
"beneficiaryFirstName": "<string>",
"beneficiaryLastName": "<string>",
"currency": "usd",
"thirdParty": true,
"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>"
},
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-dev.rain.xyz/v1/payment-accounts"
payload = {
"type": "externalFiatAccount",
"nickname": "<string>",
"externalFiatAccount": {
"beneficiaryType": "individual",
"beneficiaryFirstName": "<string>",
"beneficiaryLastName": "<string>",
"currency": "usd",
"thirdParty": True,
"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>"
},
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'externalFiatAccount',
nickname: '<string>',
externalFiatAccount: {
beneficiaryType: 'individual',
beneficiaryFirstName: '<string>',
beneficiaryLastName: '<string>',
currency: 'usd',
thirdParty: true,
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>'
},
userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-dev.rain.xyz/v1/payment-accounts', 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",
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([
'type' => 'externalFiatAccount',
'nickname' => '<string>',
'externalFiatAccount' => [
'beneficiaryType' => 'individual',
'beneficiaryFirstName' => '<string>',
'beneficiaryLastName' => '<string>',
'currency' => 'usd',
'thirdParty' => true,
'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>'
],
'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json"
],
]);
$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-dev.rain.xyz/v1/payment-accounts"
payload := strings.NewReader("{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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-dev.rain.xyz/v1/payment-accounts")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/payment-accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"externalFiatAccount\",\n \"nickname\": \"<string>\",\n \"externalFiatAccount\": {\n \"beneficiaryType\": \"individual\",\n \"beneficiaryFirstName\": \"<string>\",\n \"beneficiaryLastName\": \"<string>\",\n \"currency\": \"usd\",\n \"thirdParty\": true,\n \"beneficiaryAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"bankName\": \"<string>\",\n \"bankAddress\": {\n \"addressLine1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"addressLine2\": \"<string>\"\n },\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\"\n },\n \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
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": 400,
"error": "BadRequestError",
"message": "Invalid request"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key"
}{
"statusCode": 403,
"error": "ForbiddenError",
"message": "Forbidden"
}{
"statusCode": 404,
"error": "NotFoundError",
"message": "Team not found"
}{
"statusCode": 500,
"error": "InternalServerError",
"message": "Internal server error"
}Authorizations
Body
application/json
Payment account configuration
Available options:
externalFiatAccount A friendly name for this payment account
Maximum string length:
64- Individual Beneficiary Details
- Business Beneficiary Details
Show child attributes
Show child attributes
User ID (for individual teams; provide either userId or companyId)
Company ID (for company teams; provide either userId or companyId)
Response
Payment account created successfully
The unique identifier of the payment account
Available options:
externalFiatAccount A friendly name for this payment account
Maximum string length:
64Show child attributes
Show child attributes
When the payment account was created
User ID (present for individual teams; omit for company teams)
Company ID (present for company teams; omit for individual teams)