Get payment signature for a user

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments \
  --header 'Api-Key: <api-key>'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments"

headers = {"Api-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments', 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/issuing/users/{userId}/signatures/payments",
  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/issuing/users/{userId}/signatures/payments"

	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/issuing/users/{userId}/signatures/payments")

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

{
  "status": "ready",
  "signature": {
    "data": "<string>",
    "salt": "<string>"
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "amountCents": 123,
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

GET

issuing

users

{userId}

signatures

payments

Get payment signature for a user

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments \
  --header 'Api-Key: <api-key>'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments"

headers = {"Api-Key": "<api-key>"}

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

print(response.text)

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

fetch('https://api-dev.rain.xyz/v1/issuing/users/{userId}/signatures/payments', 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/issuing/users/{userId}/signatures/payments",
  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/issuing/users/{userId}/signatures/payments"

	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/issuing/users/{userId}/signatures/payments")

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

{
  "status": "ready",
  "signature": {
    "data": "<string>",
    "salt": "<string>"
  },
  "expiresAt": "2023-11-07T05:31:56Z",
  "amountCents": 123,
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Generating a signature authorizes a movement of funds, so this GET requires contractsAndSignatures:write — not read. See API key roles.

Authorizations

Api-Key

string

header

required

Path Parameters

userId

string<uuid>

required

Id of the user to get a payment signature for

Query Parameters

chainId

integer

The chain id - as a parsed base-10 number - that the smart contract is deployed on

token

string

required

The address of the token that the payment should be made in, as a hex string for EVM or base58 string for Solana

amount

string

required

The amount of token that is being paid, in cents unless isAmountNative is true

isAmountNative

boolean

Whether the amount is in the asset's native units. If false or omitted, amount is in cents.

adminAddress

string

required

The address making the payment, as a hex string for EVM or base58 string for Solana, which should be an admin of the smart contract

rainCollateralContractId

string<uuid>

Optional ID of the specific collateral contract to use for this signature

Response

Successful operation

status

enum<string>

required

Status of the signature

Available options:

ready

signature

object

required

Show child attributes

expiresAt

string<date-time>

The time at which the signature expires

amountCents

integer

The cents Rain prices the signed amounts at. Payment signatures only: create the pending payment for this value.

teamId

string<uuid>

The team ID associated with the user, useful for passing to makePaymentFromCollateral

Overview

Compliance

Cards

Payments

Webhooks

Webhook Events

Get payment signature for a user

Authorizations

Path Parameters

Query Parameters

Response