Skip to main content
POST
/
v1
/
cards
Store a card
curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/cards \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "card": {
    "number": "ev:abc123...",
    "expiry_month": "12",
    "expiry_year": "2030",
    "last_digits": "4242",
    "funding": "<string>",
    "issuer": "<string>",
    "country": "<string>",
    "bin": "<string>",
    "segment": "<string>",
    "currency": "<string>"
  }
}
'
import requests

url = "https://api-sandbox.rinne.com.br/core/v1/cards"

payload = { "card": {
        "number": "ev:abc123...",
        "expiry_month": "12",
        "expiry_year": "2030",
        "last_digits": "4242",
        "funding": "<string>",
        "issuer": "<string>",
        "country": "<string>",
        "bin": "<string>",
        "segment": "<string>",
        "currency": "<string>"
    } }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    card: {
      number: 'ev:abc123...',
      expiry_month: '12',
      expiry_year: '2030',
      last_digits: '4242',
      funding: '<string>',
      issuer: '<string>',
      country: '<string>',
      bin: '<string>',
      segment: '<string>',
      currency: '<string>'
    }
  })
};

fetch('https://api-sandbox.rinne.com.br/core/v1/cards', 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.rinne.com.br/core/v1/cards",
  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([
    'card' => [
        'number' => 'ev:abc123...',
        'expiry_month' => '12',
        'expiry_year' => '2030',
        'last_digits' => '4242',
        'funding' => '<string>',
        'issuer' => '<string>',
        'country' => '<string>',
        'bin' => '<string>',
        'segment' => '<string>',
        'currency' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.rinne.com.br/core/v1/cards"

	payload := strings.NewReader("{\n  \"card\": {\n    \"number\": \"ev:abc123...\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"2030\",\n    \"last_digits\": \"4242\",\n    \"funding\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"country\": \"<string>\",\n    \"bin\": \"<string>\",\n    \"segment\": \"<string>\",\n    \"currency\": \"<string>\"\n  }\n}")

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

	req.Header.Add("x-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-sandbox.rinne.com.br/core/v1/cards")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card\": {\n    \"number\": \"ev:abc123...\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"2030\",\n    \"last_digits\": \"4242\",\n    \"funding\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"country\": \"<string>\",\n    \"bin\": \"<string>\",\n    \"segment\": \"<string>\",\n    \"currency\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/cards")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card\": {\n    \"number\": \"ev:abc123...\",\n    \"expiry_month\": \"12\",\n    \"expiry_year\": \"2030\",\n    \"last_digits\": \"4242\",\n    \"funding\": \"<string>\",\n    \"issuer\": \"<string>\",\n    \"country\": \"<string>\",\n    \"bin\": \"<string>\",\n    \"segment\": \"<string>\",\n    \"currency\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_digits": "4242",
  "expiry_month": "12",
  "expiry_year": "2030",
  "funding": "<string>",
  "issuer": "<string>",
  "country": "<string>",
  "bin": "<string>",
  "segment": "<string>",
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation error",
    "status": 400,
    "details": {
      "issues": [
        {
          "field": "email",
          "type": "REQUIRED",
          "message": "Field 'email' is required",
          "value": "invalid_value",
          "constraints": {
            "min": 18,
            "max": 120
          }
        }
      ]
    },
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}
{
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Authentication required to access this resource",
    "status": 401,
    "details": {
      "reason": "Invalid API key"
    },
    "path": "/companies/me",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}
{
  "error": {
    "code": "AUTHORIZATION_ERROR",
    "message": "You need 'admin' permissions to access this resource",
    "status": 403,
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}
{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Company with ID '123' not found",
    "status": 404,
    "path": "/companies/me",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}
{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred",
    "status": 500,
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Body

application/json

Store a card for later reuse. The number is encrypted ciphertext; metadata that cannot be derived from ciphertext (last_digits, brand, BIN data) is supplied by the caller.

​
card
object
required

Response

The stored card

A stored card. The encrypted number is never returned.

​
id
string
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
source
enum<string>
required
Available options:
API,
TRANSACTION
​
status
enum<string>
required
Available options:
ACTIVE,
REPLACED,
CLOSED,
INVALID
​
brand
enum<string> | null
required
Available options:
VISA,
MASTERCARD,
AMEX,
ELO,
HIPERCARD,
DINERS,
DISCOVER,
JCB,
AURA,
CABAL,
OTHER
​
last_digits
string
required
Example:

"4242"

​
expiry_month
string
required
Example:

"12"

​
expiry_year
string
required
Example:

"2030"

​
funding
string | null
required
​
issuer
string | null
required
​
country
string | null
required
​
bin
string | null
required
​
segment
string | null
required
​
currency
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required