Bem-vindo à documentação pagar.me

Aqui você vai encontrar guias e exemplos para te ajudar
a integrar com a melhor API de Pagamentos do Brasil!

Começar

Você também pode buscar ou navegar pelas categorias

Cancelamento

É possível realizar o cancelamento de uma antecipação, caso você desista dela em algum momento antes do pagamento dela. Para realizar esse tipo de ação é necessário utilizar a rota a seguir, na qual deve ser informado qual antecipação você está cancelando.

OBS: O parâmetro id é o identificador da antecipação que você deseja antecipar. Ele pode ser obtido no momento da consulta de sua antecipação.

curl -X POST https://api.pagar.me/1/recipients/re_a123sd18das9d164/bulk_anticipations/ba_as2i4234js23in123/cancel -H 'content-type: application/json' -d '{
    "api_key": "SUA_API_KEY"
}'
require 'pagarme'
PagarMe.api_key = 'SUA_API_KEY'

PagarMe::BulkAnticipation.cancel(recipient.id, anticipation.id)
<?php
require("vendor/autoload.php");
$pagarme = new PagarMe\Client('SUA_CHAVE_DE_API');

$canceledAnticipation = $pagarme->bulkAnticipations()->cancel([
  'recipient_id' => 'ID_DO_RECEBEDOR',
  'bulk_anticipation_id' => 'ID_DA_ANTECIPAÇÃO',
]);
PagarMeService.DefaultApiKey = "SUA_API_KEY";

var recipient = PagarMeService.GetDefaultService().Recipients.Find("re_ci7nhf1ay0007n016wd5t22nl");

var anticipation = recipient.Anticipations.Find("ba_as2i4234js23in123");

recipient.CancelAnticipation(anticipation);
import pagarme from 'pagarme'

pagarme.client.connect({ api_key: 'SUA_API_KEY' })
  .then(client =>  client.bulkAnticipations.cancel({
    recipientId: 'recipient_id',
    id: 'anticipation_id',
  }))
import pagarme

pagarme.authentication_key('SUA_API_KEY')

canceled_bulk_anticipation = pagarme.bulk_anticipation.cancel(recipient['id'], bulk_anticipation['id'])

print(canceled_bulk_anticipation)

Updated 7 months ago


Próximo

Agora que você já sabe como criar, consultar e cancelar antecipações, é hora de aprender o que são postbacks.

Overview

Cancelamento


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.