Pagar.me v5 · Docs Legacy

Pagar.me v5 API (Legado)

Retornando um pagamento

get
https://api.stone.com.br/core/v5/settlements/{settlement_id}

Path Parameters

settlement_idstringrequired

ID do pagamento

Response

application/json

200

object
get/settlements/{settlement_id}
 
application/json

Criando uma transferência

Realiza uma transferência para uma conta bancária previamente criada.

post
https://api.stone.com.br/core/v5/transfers

Headers

Idempotency-Keystring

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.

Body

application/json
amountinteger(int32)required

Valor, em centavos, a ser transferido para uma determinada conta bancária (valor precisa estar entre 1 e 2147483647)

recipient_idstring

Indica que o valor da transferência sairá da conta do recebedor identificado por este parâmetro. OBS: Caso o recipient_id seja passado, não é necessário passar bank_account_id

metadatastring(json)

Você pode passar dados adicionais na criação da transferência para facilitar uma futura análise de dados por seus sistemas.

Response

application/json

200

objectstring

Example:transfer

idinteger

Default:0

Example:65485

amountinteger

Default:0

Example:100

typestring

Example:ted

statusstring

Example:pending_transfer

source_typestring

Example:recipient

source_idstring

Example:re_cix7pxz6f02ppcv6dn4ckcrcc

target_typestring

Example:bank_account

target_idstring

Example:17346045

feeinteger

Default:0

Example:367

funding_date
funding_estimated_datestring

Example:2017-02-18T02:00:00.000Z

transaction_id
date_createdstring

Example:2017-02-17T16:24:20.933Z

bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
post/transfers

Body

{ "amount": 0 }
 
application/json

Retornando transferências

Retorna os dados de todas as transferências previamente realizadas.

get
https://api.stone.com.br/core/v5/transfers

Query Parameters

countstring

Retorna n resultados, com um máximo de 1000

Default:10

cursorstring

Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando x-cursor-nextpage ou x-cursor-previouspage.

x-cursor-nextpagestring

Retornado nos headers da resposta contém o Token que permite acesso a próxima página.

x-cursor-previouspagestring

Retornado nos headers da resposta contém o Token que permite acesso a página anterior.

bank_account_idstring

Filtro de bank account id

amountstring

Filtro de amount

recipient_idstring

Filtro de recipient id

idstring

ID da transferência procurada

date_createdstring(date)

Filtro de data da criação da transferência

created_atstring(date)

Mesmo que date_created

statusstring

Filtro para um dos status: pending_transfer, transferred, failed, processing, canceled

date_updatedstring(date)

Filtro para data de último update

Response

application/json

200

objectstring

Example:transfer

idinteger

Default:0

Example:65485

amountinteger

Default:0

Example:100

typestring

Example:ted

statusstring

Example:pending_transfer

source_typestring

Example:recipient

source_idstring

Example:re_cix7pxz6f02ppcv6dn4ckcrcc

target_typestring

Example:bank_account

target_idstring

Example:17346045

feeinteger

Default:0

Example:367

funding_date
funding_estimated_datestring

Example:2017-02-18T02:00:00.000Z

transaction_id
date_createdstring

Example:2017-02-17T16:24:20.933Z

bank_response
bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
get/transfers
 
application/json

Retornando uma transferência

Retorna os dados de uma transferência em específico de sua conta.

get
https://api.stone.com.br/core/v5/transfers/{transfer_id}

Path Parameters

transfer_idstringrequired

ID da transferência desejada

Response

application/json

200

objectstring

Example:transfer

idinteger

Default:0

Example:65485

amountinteger

Default:0

Example:100

typestring

Example:ted

statusstring

Example:pending_transfer

source_typestring

Example:recipient

source_idstring

Example:re_cix7pxz6f02ppcv6dn4ckcrcc

target_typestring

Example:bank_account

target_idstring

Example:17346045

feeinteger

Default:0

Example:367

funding_date
funding_estimated_datestring

Example:2017-02-18T02:00:00.000Z

transaction_id
date_createdstring

Example:2017-02-17T16:24:20.933Z

bank_response
bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
get/transfers/{transfer_id}
 
application/json

Cancelando uma transferência

Cancela uma transferência previamente realizada. Só é possível cancelar transferências com status pending_transfer.

post
https://api.stone.com.br/core/v5/transfers/{transfer_id}/cancel

Path Parameters

transfer_idstringrequired

ID da transferência a ser cancelada

Response

application/json

200

objectstring

Example:transfer

idinteger

Default:0

Example:65485

amountinteger

Default:0

Example:100

typestring

Example:ted

statusstring

Example:canceled

source_typestring

Example:recipient

source_idstring

Example:re_cix7pxz6f02ppcv6dn4ckcrcc

target_typestring

Example:bank_account

target_idstring

Example:17346045

feeinteger

Default:0

Example:367

funding_date
funding_estimated_datestring

Example:2017-02-18T02:00:00.000Z

transaction_id
date_createdstring

Example:2017-02-17T16:24:20.933Z

bank_response
bank_accountobject
Show Child Parameters
metadataobject
Show Child Parameters
post/transfers/{transfer_id}/cancel
 
application/json