refreshUserBankAccountStatus

curl --request POST \
  --url https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "refreshUserBankAccountStatus",
  "userId": "c4e7b290-1a63-4f85-b902-6d38a1e5f047",
  "employeePayAccountId": "3f9a6d12-8b40-4e57-a631-7c02d5b8e094"
}
'

import requests

url = "https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus"

payload = {
    "method": "refreshUserBankAccountStatus",
    "userId": "c4e7b290-1a63-4f85-b902-6d38a1e5f047",
    "employeePayAccountId": "3f9a6d12-8b40-4e57-a631-7c02d5b8e094"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'refreshUserBankAccountStatus',
    userId: 'c4e7b290-1a63-4f85-b902-6d38a1e5f047',
    employeePayAccountId: '3f9a6d12-8b40-4e57-a631-7c02d5b8e094'
  })
};

fetch('https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus', 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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus",
  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([
    'method' => 'refreshUserBankAccountStatus',
    'userId' => 'c4e7b290-1a63-4f85-b902-6d38a1e5f047',
    'employeePayAccountId' => '3f9a6d12-8b40-4e57-a631-7c02d5b8e094'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus"

	payload := strings.NewReader("{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}"

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

{
  "success": true,
  "bankAccountStatus": "ready",
  "message": "Employee bank account status is ready."
}

Sandbox

refreshUserBankAccountStatus

⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in production flows

Required inputs:

userId: The ID of the test employee.
employeePayAccountId: The ID returned when the employee’s bank account was added. The account must belong to the supplied employee.

Response:

Check that bankAccountStatus is ready or active before treating the account as approved.

Notes:

This endpoint loops through all employee bank acocunts to refresh their status. Please verify all accounts with a getUser call after hitting the endpoint
Employee bank account verification may take up to 1 hour in sandbox. If the status still won’t flip after this time please reach out to support

POST

sandbox

refreshUserBankAccountStatus

curl --request POST \
  --url https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "refreshUserBankAccountStatus",
  "userId": "c4e7b290-1a63-4f85-b902-6d38a1e5f047",
  "employeePayAccountId": "3f9a6d12-8b40-4e57-a631-7c02d5b8e094"
}
'

import requests

url = "https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus"

payload = {
    "method": "refreshUserBankAccountStatus",
    "userId": "c4e7b290-1a63-4f85-b902-6d38a1e5f047",
    "employeePayAccountId": "3f9a6d12-8b40-4e57-a631-7c02d5b8e094"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'refreshUserBankAccountStatus',
    userId: 'c4e7b290-1a63-4f85-b902-6d38a1e5f047',
    employeePayAccountId: '3f9a6d12-8b40-4e57-a631-7c02d5b8e094'
  })
};

fetch('https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus', 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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus",
  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([
    'method' => 'refreshUserBankAccountStatus',
    'userId' => 'c4e7b290-1a63-4f85-b902-6d38a1e5f047',
    'employeePayAccountId' => '3f9a6d12-8b40-4e57-a631-7c02d5b8e094'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus"

	payload := strings.NewReader("{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.rollfi.xyz/sandbox/refreshUserBankAccountStatus")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"method\": \"refreshUserBankAccountStatus\",\n  \"userId\": \"c4e7b290-1a63-4f85-b902-6d38a1e5f047\",\n  \"employeePayAccountId\": \"3f9a6d12-8b40-4e57-a631-7c02d5b8e094\"\n}"

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

{
  "success": true,
  "bankAccountStatus": "ready",
  "message": "Employee bank account status is ready."
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

default:refreshUserBankAccountStatus

required

userId

string<uuid>

required

The ID of the sandbox employee.

userPayAccountEntityId

string<uuid>

required

The ID of the employee's primary active bank account.

Response

200 - application/json

The current bank account result or an error response. Check the response body rather than relying on the HTTP status alone.

success

boolean

bankAccountStatus

string

The primary active account's status. Check for ready or active; an empty value is not confirmation of approval.

message

string

error

Show child attributes