Split com assinatura

post https://api.pagar.me/1/subscriptions/

Além de cobrar o seu cliente de forma recorrente, você também pode dividir as transações resultantes dessas assinaturas, entre dois ou mais recebedores de sua company. Os parâmetros a serem passados, além dos já existentes e explicados na seção anterior, são o conjunto split_rules:

time	status	user agent
Retrieving recent requests…

Loading…

Dados necessários para uma assinatura

📘
Dados obrigatórios
O email do cliente é uma informação obrigatória, uma vez que utilizamos ele para enviar emails de assinatura.

🚧
Antifraude
A primeira transação criada em uma assinatura passa por antifraude, logo, é obrigatório enviar todos os dados de customer.

Valores de uma assinatura

❗️
Dando descontos na assinatura
Apenas através de troca para um plano mais barato, mas vale ressaltar que isso gera uma nova periodicidade. Mais em: Fluxo de cobrança.

Observações

📘
ID do plano
Lembre-se de passar o id de seu plano em todas as requests, para que não seja necessário recriar todas assinaturas que ficaram com plan_id = null.

Body Params

plan_id

string

required

id do plano a ser associado a uma assinatura

payment_method

string

Método de pagamento da assinatura. Aceita dois tipos: credit_card e boleto

card_hash

string

required

Dados encriptados do cartão do cliente. Você também pode usar o card_id ao invés do card_hash

card_number

string

required

Número do cartão, se for uma assinatura de cartão

card_cvv

string

required

Cvv do cartão, se for uma assinatura paga com cartão

card_holder_name

string

required

Nome do detentor do cartão se for uma assinatura paga com cartão

card_expiration_date

string

required

Data de expiração do cartão, se for uma assinatura paga com cartão

card_id

string

required

Id do cartão a ser cobrado, se for uma assinatura paga com cartão

postback_url

string

URL onde nossa API irá enviar requisições informando alterações de status da assinatura em questão

split_rules

array of objects

required

Regras de split para transações criadas a partir de sua assinatura

split_rules*

customer

object

metadata

json

Você pode passar dados adicionais na criação da transação para facilitar uma futura análise de dados tanto em nossa dashboard, quanto por seus sistemas. Ex: metadata[ idProduto ]=13933139

reference_key

string

Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente. OBS: Não pode ser igual a um valor já usado em uma criação de transação

boleto_fine

object

boleto_interest

object

Responses

Language

Credentials

Query

Request


xxxxxxxxxx
38
1
curl -X POST https://api.pagar.me/1/subscriptions -H "Content-Type: application/json"  -d '{
2
  "api_key":"SUA API KEY",
3
  "card_number": "4242424242424242",
4
  "card_cvv": "122",
5
  "card_holder_name": "Aardvark Silva",
6
  "card_expiration_date": "1220",
7
  "payment_method": "credit_card",
8
  "customer":{
9
    "email":"aardvark.silva@pagar.me",
10
    "name":"nome",
11
    "document_number":"35965816804",
12
    "address":{
13
      "zipcode":"06350270",
14
      "neighborhood":"bairro",
15
      "street":"rua",
16
      "street_number":"122"
17
    },
18
    "phone": {
19
      "number":"87654321",
20
      "ddd":"11"
21
    }
22
  } ,
23
  "plan_id":"89226",
24
  "amount": 10000,
25
  "split_rules": [
26
    {
27
      "recipient_id": "re_cj2wd5ul500d4946do7qtjrvk",
28
      "percentage": 20,
29
      "liable": true,

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Split com assinatura

Dados necessários para uma assinatura

📘
Dados obrigatórios

🚧
Antifraude

Valores de uma assinatura

❗️
Dando descontos na assinatura

Observações

📘
ID do plano

Dados necessários para uma assinatura

📘Dados obrigatórios

🚧Antifraude

Valores de uma assinatura

❗️Dando descontos na assinatura

Observações

📘ID do plano

200200

400400

📘
Dados obrigatórios

🚧
Antifraude

❗️
Dando descontos na assinatura

📘
ID do plano