Create Payment

POST

payments

Create Payment

curl --request POST \
  --url https://api.purin.cash/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valueCents": 4990,
  "paymentMethod": "pix",
  "description": "Premium Plan",
  "callbackUrl": "https://seu-site.com/webhook",
  "customer": {
    "name": "Joao Silva",
    "email": "joao@email.com",
    "externalId": "user_123"
  },
  "metadata": "{\"orderId\": \"abc-123\"}"
}
'

import requests

url = "https://api.purin.cash/v1/payments"

payload = {
    "valueCents": 4990,
    "paymentMethod": "pix",
    "description": "Premium Plan",
    "callbackUrl": "https://seu-site.com/webhook",
    "customer": {
        "name": "Joao Silva",
        "email": "joao@email.com",
        "externalId": "user_123"
    },
    "metadata": "{\"orderId\": \"abc-123\"}"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    valueCents: 4990,
    paymentMethod: 'pix',
    description: 'Premium Plan',
    callbackUrl: 'https://seu-site.com/webhook',
    customer: {name: 'Joao Silva', email: 'joao@email.com', externalId: 'user_123'},
    metadata: '{"orderId": "abc-123"}'
  })
};

fetch('https://api.purin.cash/v1/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.purin.cash/v1/payments",
  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([
    'valueCents' => 4990,
    'paymentMethod' => 'pix',
    'description' => 'Premium Plan',
    'callbackUrl' => 'https://seu-site.com/webhook',
    'customer' => [
        'name' => 'Joao Silva',
        'email' => 'joao@email.com',
        'externalId' => 'user_123'
    ],
    'metadata' => '{"orderId": "abc-123"}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.purin.cash/v1/payments"

	payload := strings.NewReader("{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.purin.cash/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.purin.cash/v1/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}"

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

{
  "paymentId": "psa_a1b2c3d4e5f6...",
  "status": "pending",
  "type": "one_time",
  "paymentMethod": "pix",
  "amountCents": 4990,
  "currency": "BRL",
  "productName": "Premium Plan",
  "environment": "live",
  "pix": {
    "brCode": "00020126580014br.gov.bcb.pix0136...",
    "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  },
  "expiresAt": "2026-03-18T12:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Body

application/json

Envie productId ou valueCents. Um dos dois é obrigatório.

productId

string

ID (ObjectId) de um produto ativo. O valor do pagamento vem do preço do produto. Obrigatório se valueCents não for enviado. Produtos em moeda diferente de BRL são convertidos automaticamente para BRL na cobrança.

valueCents

integer

Valor em centavos (inteiro maior ou igual a 80, ou seja, R$ 0,80). Obrigatório se productId não for enviado.

Required range: x >= 80

paymentMethod

enum<string>

default:pix

Método de pagamento. "pix" (padrão) gera um BR Code PIX; "ltc" gera um endereço Litecoin com o valor convertido pela cotação atual. LTC não está disponível no modo sandbox.

Available options:

pix,

ltc

description

string

Descrição do pagamento (máx. 200 caracteres). Usada como nome do pagamento quando não há productId. Padrão "Pagamento".

Maximum string length: 200

expiresIn

integer

default:1800

Prazo de validade da cobrança, em SEGUNDOS. De 60 (1 minuto) a 604800 (7 dias). Padrão 1800 (30 minutos). Valor fora da faixa devolve 400 em vez de cair no padrão, pra o erro mais comum (mandar minutos achando que é o campo) não passar batido.

Required range: 60 <= x <= 604800

callbackUrl

string<uri>

URL HTTPS pública (máx. 500 caracteres) que recebe um POST com o evento payment.paid quando o pagamento é confirmado, assinado com HMAC-SHA256 no header X-Webhook-Signature.

Maximum string length: 500

customer

object

Dados do cliente (opcional).

Show child attributes

metadata

string

String JSON livre (máx. 2048 caracteres), devolvida nas consultas e no webhook.

Maximum string length: 2048

subaccountId

string

Subconta (sacc_...) que recebe o crédito no ledger quando o pagamento for confirmado. Não aceito com paymentMethod "ltc". Veja /v1/subaccounts. OMITA o campo para um pagamento sem atribuição: string vazia devolve 400 em vez de criar a venda sem dono, porque o padrão subaccountId: cliente.saccId || "" viraria perda silenciosa de atribuição.

subaccountFeeCents

integer

Taxa da plataforma NESTA venda, em centavos. Só com subaccountId (sem ele devolve 400). Quando o pagamento confirma, a subconta recebe o líquido menos esta taxa, e a taxa fica na conta principal, numa operação só (sem precisar de /v1/subaccounts/{id}/transfer depois). Substitui o markup configurado na subconta nesta venda, não soma; 0 = sem taxa nesta venda. Inteiro de 0 até o valor da cobrança. Se passar do líquido da venda, a subconta recebe zero (nunca fica negativa). O lançamento sale do extrato grava a taxa em feeCents, com refId = paymentId. Volta na resposta, nas consultas e no webhook.

Required range: x >= 0

Example:

150

supplier

object

Vínculo opcional com produto de fornecedor (split). O valor é dividido entre a loja e o fornecedor conforme o split configurado, e o conteúdo é entregue automaticamente após o pagamento.

Show child attributes

Response

Pagamento criado com sucesso. A resposta PIX traz o objeto pix (BR Code); a resposta LTC traz o objeto ltc (endereço e valor em Litecoin).

Pagamento PIX
Pagamento LTC

Resposta quando paymentMethod é "pix" (padrão).

paymentId

string

Identificador único do pagamento (prefixo psa_).

status

enum<string>

Status do pagamento. Sempre "pending" na criação.

Available options:

pending,

paid,

expired,

refunded

type

enum<string>

Tipo do pagamento ("one_time" para pagamentos avulsos).

Available options:

one_time,

subscription

paymentMethod

enum<string>

Método de pagamento utilizado.

Available options:

pix

amountCents

integer

Valor cobrado em centavos (BRL).

currency

string

Moeda do produto (padrão BRL). A cobrança PIX é sempre em BRL.

productName

string

Nome do produto vinculado ou a descrição enviada.

environment

enum<string>

Ambiente da chave de API utilizada.

Available options:

live,

sandbox

pix

object

Dados do PIX gerado.

Show child attributes

expiresAt

string<date-time>

Expiração do pagamento (30 minutos após a criação).

Create Payment

curl --request POST \
  --url https://api.purin.cash/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valueCents": 4990,
  "paymentMethod": "pix",
  "description": "Premium Plan",
  "callbackUrl": "https://seu-site.com/webhook",
  "customer": {
    "name": "Joao Silva",
    "email": "joao@email.com",
    "externalId": "user_123"
  },
  "metadata": "{\"orderId\": \"abc-123\"}"
}
'

import requests

url = "https://api.purin.cash/v1/payments"

payload = {
    "valueCents": 4990,
    "paymentMethod": "pix",
    "description": "Premium Plan",
    "callbackUrl": "https://seu-site.com/webhook",
    "customer": {
        "name": "Joao Silva",
        "email": "joao@email.com",
        "externalId": "user_123"
    },
    "metadata": "{\"orderId\": \"abc-123\"}"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    valueCents: 4990,
    paymentMethod: 'pix',
    description: 'Premium Plan',
    callbackUrl: 'https://seu-site.com/webhook',
    customer: {name: 'Joao Silva', email: 'joao@email.com', externalId: 'user_123'},
    metadata: '{"orderId": "abc-123"}'
  })
};

fetch('https://api.purin.cash/v1/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.purin.cash/v1/payments",
  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([
    'valueCents' => 4990,
    'paymentMethod' => 'pix',
    'description' => 'Premium Plan',
    'callbackUrl' => 'https://seu-site.com/webhook',
    'customer' => [
        'name' => 'Joao Silva',
        'email' => 'joao@email.com',
        'externalId' => 'user_123'
    ],
    'metadata' => '{"orderId": "abc-123"}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.purin.cash/v1/payments"

	payload := strings.NewReader("{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.purin.cash/v1/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.purin.cash/v1/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"valueCents\": 4990,\n  \"paymentMethod\": \"pix\",\n  \"description\": \"Premium Plan\",\n  \"callbackUrl\": \"https://seu-site.com/webhook\",\n  \"customer\": {\n    \"name\": \"Joao Silva\",\n    \"email\": \"joao@email.com\",\n    \"externalId\": \"user_123\"\n  },\n  \"metadata\": \"{\\\"orderId\\\": \\\"abc-123\\\"}\"\n}"

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

{
  "paymentId": "psa_a1b2c3d4e5f6...",
  "status": "pending",
  "type": "one_time",
  "paymentMethod": "pix",
  "amountCents": 4990,
  "currency": "BRL",
  "productName": "Premium Plan",
  "environment": "live",
  "pix": {
    "brCode": "00020126580014br.gov.bcb.pix0136...",
    "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  },
  "expiresAt": "2026-03-18T12:30:00.000Z"
}

Visão geral

Pagamentos

Cobranças

Splits

Cartão

Assinaturas

Produtos

Entregas

Subcontas

Carteira e saques

Disputas

Sandbox

Authorizations

Body

Response