Pagar.me v5 · Docs Legacy
Listar ciclos
Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles
Query Parameters
idstring
Código do ciclo. Formato: cycle_XXXXXXXXXXXXXXXX.
billing_atstring(date)
Data de cobrança do ciclo
cyclestring
Quantidade de ciclos na assinatura
start_atstring
Data de início do ciclo
end_atstring
Data final do ciclo
durationstring
created_atstring
Data de criação da assinatura
updated_atstring(date)
Data de atualização do ciclo da assinatura.
statusstring
Status dos ciclos. Valores possíveis: billed ou unbilled
Path Parameters
subscription_idstringrequired
Código da assinatura.
Response
application/json
Response
application/json
200
dataarray[object]
Show Child Parameters
pagingobject
Show Child Parameters
get/subscriptions/{subscription_id}/cycles
Authentication
Path Parameters
Query Parameters
application/json
Obter ciclo
Através do identificador do ciclo (cycle_id) é possível recuperar as informação do ciclo de uma assinatura.
get
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/cycles/{cycle_id}
Path Parameters
subscription_idstringrequired
Código da assinatura.
cycle_idstringrequired
Código do ciclo. Formato: cycle_XXXXXXXXXXXXXXXX.
Response
application/json
Response
application/json
200
idstring
Example:cycle_Qal5a0LCpphoDpnR
billing_atstring
Example:2019-04-30T00:00:00Z
cycleinteger
Default:0
Example:1
start_atstring
Example:2019-04-30T00:00:00Z
end_atstring
Example:2019-07-29T23:59:59Z
durationinteger
Default:0
Example:7862399
created_atstring
Example:2019-04-30T18:09:32Z
updated_atstring
Example:2019-04-30T18:09:33Z
statusstring
Example:billed
get/subscriptions/{subscription_id}/cycles/{cycle_id}
Authentication
Path Parameters
application/json
Editar regras do Split
Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível ativar, desativar ou alterar as regras do split na recorrência.
Para realizar a edição tem que ser enviado pelo menos um dos campos, enabled ou rules, ambos campos são opcionais e independentes.
patch
https://api.stone.com.br/core/v5/subscriptions/{subscription_id}/split
Path Parameters
subscription_idstringrequired
Código da Assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.
Body
application/json
Body
application/json
enabledboolean
Ativa ou desativa as regras de split na assinatura. Pode ser true ou False
rulesarray[object]
Show Child Parameters
Response
application/json
Response
application/json
200
idstring
Example:sub_WpkrQvNriRs6QKGz
codestring
Example:EP13T6I0KR
start_atstring
Example:2022-01-12T00:00:00Z
intervalstring
Example:month
interval_countinteger
Default:0
Example:1
billing_typestring
Example:postpaid
current_cycleobject
Show Child Parameters
next_billing_atstring
Example:2022-02-14T00:00:00Z
payment_methodstring
Example:credit_card
currencystring
Example:BRL
installmentsinteger
Default:0
Example:1
statusstring
Example:active
created_atstring
Example:2022-01-12T15:22:04Z
updated_atstring
Example:2022-01-12T15:59:58Z
customerobject
Show Child Parameters
cardobject
Show Child Parameters
itemsarray[object]
Show Child Parameters
splitobject
Show Child Parameters
metadataobject
Show Child Parameters
patch/subscriptions/{subscription_id}/split
Authentication
Path Parameters
Body
{}
application/json
Criar recebedor contrato antigo
Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.
post
https://api.stone.com.br/core/v5/recipients1
Body
application/json
Body
application/json
namestringrequired
Nome do recebedor. Max:128 caracteres
emailstring
E-mail do recebedor. Max: 64 caracteres
descriptionstring
Descrição do recebedor. Max:256 caracteres
documentstringrequired
CPF ou CNPJ do recebedor. Max: 16 caracteres
typestringrequired
Tipo de recebedor. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica)
codestring
Referencia externa única por recebedor
default_bank_accountobject
Dados da conta bancária do recebedor.
Show Child Parameters
transfer_settingsobject
Informações de transferência do recebedor
Show Child Parameters
automatic_anticipation_settingsobject
Informações de antecipação automática do recebedor
Show Child Parameters
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.
Response
application/json
Response
application/json
200
idstring
Example:rp_P6b2aBqtPsbwG7xw
namestring
Example:Tony Stark
emailstring
Example:tstark@avengers.com
documentstring
Example:26224451990
descriptionstring
Example:Recebedor tony stark
typestring
Example:individual
statusstring
Example:active
created_atstring
Example:2017-08-03T20:29:28Z
updated_atstring
Example:2017-08-03T20:29:28Z
transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
metadataobject
Show Child Parameters
post/recipients1
Authentication
Body
{
"name": "Teste campos",
"email": "tstark@avengers.com",
"description": "Recebedor tony stark",
"document": "26224451990",
"type": "individual",
"default_bank_account": {
"holder_name": "Tony Stark",
"holder_type": "individual",
"holder_document": "26224451990",
"bank": "341",
"branch_number": "1234",
"branch_check_digit": "6",
"account_number": "12345",
"account_check_digit": "6",
"type": "checking",
"metadata": {
"key": "value"
}
},
"transfer_settings": {
"transfer_enabled": false,
"transfer_interval": "Daily",
"transfer_day": 0
},
"automatic_anticipation_settings": {
"enabled": true,
"type": "full",
"volume_percentage": "50",
"delay": null
},
"metadata": {
"key": "value"
}
}
application/json
Criar recebedor
Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.
post
https://api.stone.com.br/core/v5/recipients
Body
application/json
Body
application/json
codestring
Referencia externa única por recebedor
register_informationobjectrequired
Dados cadastrais do recebedor. O objeto deve ser preenchido de acordo com o tipo do recebedor, Pessoa Física [PF] ou Pessoa Jurídica [PJ].
Show Child Parameters
default_bank_accountobjectrequired
Dados da conta bancária do recebedor.
Show Child Parameters
transfer_settingsobject
Informações de transferência do recebedor
Show Child Parameters
automatic_anticipation_settingsobject
Informações de antecipação automática do recebedor
Show Child Parameters
metadatastring
Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.
Response
application/json
Response
application/json
200
idstring
Example:re_clxnqkxk709sc019taqhmj4kf
namestring
Example:Antonio da Silva
emailstring
Example:tstark@avengers.com
codestring
Example:21875b51-d4c3-46d3-aeee-d8b3112aab55
documentstring
Example:26224451990
typestring
Example:individual
payment_modestring
Example:bank_transfer
statusstring
Example:active
created_atstring
Example:2024-06-20T20:50:31Z
updated_atstring
Example:2024-06-20T20:50:31Z
transfer_settingsobject
Show Child Parameters
default_bank_accountobject
Show Child Parameters
gateway_recipientsarray[object]
Show Child Parameters
automatic_anticipation_settingsobject
Show Child Parameters
metadataobject
Show Child Parameters
register_informationobject
Show Child Parameters
post/recipients
Authentication
Body
{
"code": "1234",
"register_information": {
"company_name": "Recebedor pessoa juridica",
"trading_name": "Empresa LTDA",
"email": "empresax@avengers.com",
"document": "77699131000133",
"type": "corporation",
"site_url": "http://www.site.com",
"annual_revenue": 1000000,
"corporation_type": "LTDA",
"founding_date": "2010-10-30",
"main_address": {
"street": "Av. General Justo",
"complementary": "Bloco A",
"street_number": "375",
"neighborhood": "Centro",
"city": "Rio de Janeiro",
"state": "RJ",
"zip_code": "20021130",
"reference_point": "Ao lado da banca de jornal"
},
"phone_numbers": [
{
"ddd": "21",
"number": "994647568",
"type": "mobile"
}
],
"managing_partners": [
{
"name": "Tony Stark",
"email": "tstark@avengers.com",
"document": "26224451990",
"type": "individual",
"mother_name": "Nome da mae",
"birthdate": "12/10/1995",
"monthly_income": 120000,
"professional_occupation": "Vendedor",
"self_declared_legal_representative": true,
"address": {
"street": "Av. General Justo",
"complementary": "Bloco A",
"street_number": "375",
"neighborhood": "Centro",
"city": "Rio de Janeiro",
"state": "RJ",
"zip_code": "20021130",
"reference_point": "Ao lado da banca de jornal"
},
"phone_numbers": [
{
"ddd": "27",
"number": "999992628",
"type": "mobile"
}
]
}
]
},
"transfer_settings": {
"transfer_enabled": "false",
"transfer_interval": "Daily",
"transfer_day": 0
},
"default_bank_account": {
"holder_name": "Tony Stark",
"holder_type": "individual",
"holder_document": "26224451990",
"bank": "341",
"branch_number": "1234",
"branch_check_digit": "6",
"account_number": "12345",
"account_check_digit": "6",
"type": "checking"
},
"automatic_anticipation_settings": {
"enabled": "true",
"type": "full",
"volume_percentage": "50",
"delay": "null"
}
}
application/json