Pagar.me

Track sales, balances, and transfers with Pagar.me

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 129 actions:

Action	Purpose	Parameters
get_v5_balance_operations_by_id	get Balance Operation By Id	id (string)
get_v5_balance_operations	get Balance Operations	status (string) created_since (string) created_until (string) recipient_id (string)
patch_v5_subscriptions_by_subscription_id_card	Updates the credit card from a subscription	subscriptionId (string) idempotency-key (string) data: { . card . card_id (string) . indirect_acceptor (string) } (object) required
post_v5_subscriptions_by_subscription_id_discounts	Creates a discount	subscriptionId (string) idempotency-key (string) data: { . value (number) . discount_type (string) . item_id (string) . cycles (number) . description (string) } (object) required
patch_v5_subscriptions_by_subscription_id_billing_date	Updates the billing date from a subscription	subscriptionId (string) idempotency-key (string) data: { . next_billing_at (string) } (object) required
patch_v5_subscriptions_by_subscription_id_start_at	Updates the start at date from a subscription	subscriptionId (string) idempotency-key (string) data: { . start_at (string) } (object) required
get_v5_subscriptions_by_subscription_id	Gets a subscription	subscriptionId (string)
delete_v5_subscriptions_by_subscription_id	Cancels a subscription	subscriptionId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_items_by_item_id_usages	Lists all usages from a subscription item	subscriptionId (string) itemId (string) page (string) size (string) code (string) group (string) used_since (string) used_until (string)
post_v5_subscriptions_by_subscription_id_items_by_item_id_usages	Creates a usage	subscriptionId (string) itemId (string) idempotency-key (string)
patch_v5_subscriptions_by_subscription_id_periods_latest_end_at	update Latest Period End At	subscriptionId (string) idempotency-key (string) data: { . end_at (string) } (object) required
delete_v5_subscriptions_by_subscription_id_discounts_by_discount_id	Deletes a discount	subscriptionId (string) discountId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_discounts_by_discount_id	get Discount By Id	subscriptionId (string) discountId (string)
patch_v5_subscriptions_by_subscription_id_payment_method	Updates the payment method from a subscription	subscriptionId (string) idempotency-key (string) data: { . payment_method (string) . card_id (string) . card . card_token (string) . indirect_acceptor (string) } (object) required
post_v5_subscriptions	Creates a new subscription	idempotency-key (string)
get_v5_subscriptions	Gets all subscriptions	page (string) size (string) code (string) billing_type (string) customer_id (string) plan_id (string) card_id (string) status (string) next_billing_since (string) next_billing_until (string) created_since (string) created_until (string)
patch_v5_subscriptions_by_subscription_id_gateway_affiliation_id	update Subscription Affiliation Id	subscriptionId (string) idempotency-key (string) data: { . gateway_affiliation_id (string) } (object) required
patch_v5_subscriptions_by_subscription_id_minimum_price	Atualização do valor mínimo da assinatura	subscriptionId (string) idempotency-key (string) data: { . minimum_price (number) } (object) required
get_v5_subscriptions_by_subscription_id_cycles_by_cycle_id	get Subscription Cycle By Id	subscriptionId (string) cycleId (string)
get_v5_subscriptions_by_subscription_id_periods_by_period_id_usages_report	get Usage Report	subscriptionId (string) periodId (string)
post_v5_subscriptions_by_subscription_id_cycles	renew Subscription	subscriptionId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_cycles	get Subscription Cycles	subscriptionId (string) page (string) size (string)
delete_v5_subscriptions_by_subscription_id_items_by_item_id_usages_by_usage_id	Deletes a usage	subscriptionId (string) itemId (string) usageId (string) idempotency-key (string)
patch_v5_subscriptions_by_subscription_id_cycle_status	update Current Cycle Status	subscriptionId (string) idempotency-key (string) data: { . status (string) } (object) required
get_v5_subscriptions_by_subscription_id_items_by_item_id	Get Subscription Item	subscriptionId (string) itemId (string)
put_v5_subscriptions_by_subscription_id_items_by_item_id	Updates a subscription item	subscriptionId (string) itemId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_increments_by_increment_id	get Increment By Id	subscriptionId (string) incrementId (string)
delete_v5_subscriptions_by_subscription_id_increments_by_increment_id	Deletes a increment	subscriptionId (string) incrementId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_discounts	get Discounts	subscriptionId (string) page (string) size (string)
patch_v5_subscriptions_by_subscription_id_boleto_due_days	Updates the boleto due days from a subscription	subscriptionId (string) idempotency-key (string) data: { . boleto_due_days (number) } (object) required
post_v5_subscriptions_by_subscription_id_items	Creates a new Subscription item	subscriptionId (string) idempotency-key (string) data: { . description (string) . id (string) . plan_item_id (string) . discounts (array) . name (string) . cycles (number) . quantity (number) . minimum_price (number) } (object) required
get_v5_subscriptions_by_subscription_id_items	Get Subscription Items	subscriptionId (string) page (string) size (string) name (string) code (string) status (string) description (string) created_since (string) created_until (string)
patch_v5_subscriptions_by_id_split	update Split Subscription	id (string) data: { . enabled (boolean) . rules (array) } (object) required
post_v5_subscriptions_by_subscription_id_increments	Creates a increment	subscriptionId (string) idempotency-key (string) data: { . value (number) . increment_type (string) . item_id (string) . cycles (number) . description (string) } (object) required
patch_v5_subscriptions_by_subscription_id_metadata	Updates the metadata from a subscription	subscriptionId (string) idempotency-key (string) data: { . metadata (string) } (object) required
delete_v5_subscriptions_by_subscription_id_items_by_subscription_item_id	Deletes a subscription item	subscriptionId (string) subscriptionItemId (string) idempotency-key (string)
get_v5_subscriptions_by_subscription_id_increments	get Increments	subscriptionId (string) page (string) size (string)
get_v5_payables	get Payables	type (string) split_id (string) bulk_anticipation_id (string) installment (string) status (string) recipient_id (string) amount (string) charge_id (string) payment_date_until (string) payment_date_since (string) updated_until (string) updated_since (string) created_until (string) created_since (string) liquidation_arrangement_id (string) page (string) size (string) gateway_id (string)
get_v5_payables_by_id	get Payable By Id	id (string)
delete_v5_orders_by_order_id_items	delete All Order Items	orderId (string) idempotency-key (string)
post_v5_orders_by_order_id_items	create Order Item	orderId (string) idempotency-key (string) data: { . amount (number) . description (string) . quantity (number) . category (string) . code (string) } (object) required
get_v5_orders_by_order_id_items_by_item_id	get Order Item	orderId (string) itemId (string)
delete_v5_orders_by_order_id_items_by_item_id	delete Order Item	orderId (string) itemId (string) idempotency-key (string)
put_v5_orders_by_order_id_items_by_item_id	update Order Item	orderId (string) itemId (string) idempotency-key (string) data: { . amount (number) . description (string) . quantity (number) . category (string) } (object) required
patch_v5_orders_by_order_id_metadata	Updates the metadata from an order	orderId (string) idempotency-key (string) data: { . metadata (string) } (object) required
get_v5_orders_by_order_id	Gets an order	orderId (string)
get_v5_orders	Gets all orders	page (string) size (string) code (string) status (string) created_since (string) created_until (string) customer_id (string)
post_v5_orders	Creates a new Order	idempotency-key (string)
patch_v5_orders_by_id_closed	close Order	id (string) idempotency-key (string) data: { . status (string) } (object) required
patch_v5_charges_by_charge_id_metadata	Updates the metadata from a charge	chargeId (string) idempotency-key (string) data: { . metadata (string) } (object) required
post_v5_charges_by_charge_id_capture	Captures a charge	chargeId (string) idempotency-key (string)
get_v5_charges_by_charge_id	Get a charge from its id	chargeId (string)
delete_v5_charges_by_charge_id	Cancel a charge	chargeId (string) idempotency-key (string)
post_v5_charges_by_charge_id_confirm_payment	confirm Payment	chargeId (string) idempotency-key (string)
get_v5_charges_by_charge_id_transactions	get Charge Transactions	chargeId (string) page (string) size (string)
patch_v5_charges_by_charge_id_card	Updates the card from a charge	chargeId (string) idempotency-key (string) data: { . update_subscription (boolean) . card_id (string) . card . recurrence (boolean) . initiated_type (string) . recurrence_model (string) . indirect_acceptor (string) } (object) required
post_v5_charges	Creates a new charge	idempotency-key (string) data: { . code (string) . amount (number) . customer_id (string) . payment . metadata (string) . due_at (string) . order_id (string) } (object) required
patch_v5_charges_by_charge_id_payment_method	Updates a charge's payment method	chargeId (string) idempotency-key (string) data: { . update_subscription (boolean) . payment_method (string) . debit_card . boleto . voucher . cash } (object) required
patch_v5_charges_by_charge_id_due_date	Updates the due date from a charge	chargeId (string) idempotency-key (string) data: { . due_at (string) } (object) required
get_v5_charges_summary	get Charges Summary	status (string) created_since (string) created_until (string)
post_v5_charges_by_charge_id_retry	Retries a charge	chargeId (string) idempotency-key (string)
get_v5_charges	Lists all charges	page (string) size (string) code (string) status (string) payment_method (string) customer_id (string) order_id (string) created_since (string) created_until (string)
get_v5_transfers_by_transfer_id	get Transfer By Id	transferId (string)
get_v5_transfers	Gets all transfers	No parameters
post_v5_transfers_recipients	create Transfer	data: { . amount (number) . source_id (string) . target_id (string) . metadata (string) } (object) required
put_v5_recipients_by_recipient_id	Updates a recipient	recipientId (string) idempotency-key (string) data: { . name (string) . email (string) . description (string) . type (string) . status (string) . metadata (string) } (object) required
get_v5_recipients_by_recipient_id	Retrieves recipient information	recipientId (string)
get_v5_recipients_by_recipient_id_withdrawals_by_withdrawal_id	get Withdraw By Id	recipientId (string) withdrawalId (string)
get_v5_recipients_by_recipient_id_balance	Get balance information for a recipient	recipientId (string)
get_v5_recipients	Retrieves paginated recipients information	page (string) size (string)
post_v5_recipients	Creates a new recipient	idempotency-key (string) data: { . name (string) . email (string) . description (string) . document (string) . type (string) . metadata (string) . code (string) . payment_mode (string) } (object) required
patch_v5_recipients_by_recipient_id_default_bank_account	Updates the default bank account from a recipient	recipientId (string) idempotency-key (string) data: { . bank_account . payment_mode (string) } (object) required
get_v5_recipients_by_recipient_id_transfers	Gets a paginated list of transfers for the recipient	recipientId (string) page (string) size (string) status (string) created_since (string) created_until (string)
post_v5_recipients_by_recipient_id_transfers	Creates a transfer for a recipient	recipientId (string) idempotency-key (string) data: { . amount (number) . metadata (string) } (object) required
get_v5_recipients_by_recipient_id_transfers_by_transfer_id	Gets a transfer	recipientId (string) transferId (string)
post_v5_recipients_by_recipient_id_withdrawals	create Withdraw	recipientId (string) data: { . amount (number) . metadata (string) } (object) required
get_v5_recipients_by_recipient_id_withdrawals	Gets a paginated list of transfers for the recipient	recipientId (string) page (string) size (string) status (string) created_since (string) created_until (string)
get_v5_recipients_by_recipient_id_anticipations_by_anticipation_id	Gets an anticipation	recipientId (string) anticipationId (string)
patch_v5_recipients_by_recipient_id_transfer_settings	update Recipient Transfer Settings	recipientId (string) idempotency-key (string) data: { . transfer_enabled (string) . transfer_interval (string) . transfer_day (string) } (object) required
get_v5_recipients_by_code	Retrieves recipient information	code (string)
patch_v5_recipients_by_recipient_id_automatic_anticipation_settings	Updates recipient metadata	recipientId (string) idempotency-key (string) data: { . enabled (boolean) . type (string) . volume_percentage (number) . delay (number) . days (number) } (object) required
get_v5_recipients_default	get Default Recipient	No parameters
post_v5_recipients_by_recipient_id_anticipations	Creates an anticipation	recipientId (string) idempotency-key (string) data: { . amount (number) . timeframe (string) . payment_date (string) } (object) required
get_v5_recipients_by_recipient_id_anticipations	Retrieves a paginated list of anticipations from a recipient	recipientId (string) page (string) size (string) status (string) timeframe (string) payment_date_since (string) payment_date_until (string) created_since (string) created_until (string)
get_v5_recipients_by_recipient_id_anticipation_limits	Gets the anticipation limits for a recipient	recipientId (string) timeframe (string) payment_date (string)
patch_v5_recipients_by_recipient_id_metadata	Updates recipient metadata	recipientId (string) idempotency-key (string) data: { . metadata (string) } (object) required
post_v5_recipients_by_recipient_id_kyc_link	Create a KYC link	recipientId (string)
patch_v5_recipients_by_recipient_id_code	Updates recipient code	recipientId (string) idempotency-key (string) data: { . code (string) } (object) required
post_v5_customers_by_customer_id_addresses	Creates a new address for a customer	customerId (string) idempotency-key (string) data: { . street (string) . number (string) . zip_code (string) . neighborhood (string) . city (string) . state (string) . country (string) . complement (string) . metadata (string) . line_1 (string) . line_2 (string) } (object) required
get_v5_customers_by_customer_id_addresses	Gets all adressess from a customer	customerId (string) page (string) size (string)
put_v5_customers_by_customer_id_cards_by_card_id	Updates a card	customerId (string) cardId (string) idempotency-key (string) data: { . holder_name (string) . exp_month (number) . exp_year (number) . billing_address_id (string) . billing_address . metadata (string) . label (string) } (object) required
delete_v5_customers_by_customer_id_cards_by_card_id	Delete a customer's card	customerId (string) cardId (string) idempotency-key (string)
get_v5_customers_by_customer_id_cards_by_card_id	Get a customer's card	customerId (string) cardId (string)
delete_v5_customers_by_customer_id_access_tokens_by_token_id	Delete a customer's access token	customerId (string) tokenId (string) idempotency-key (string)
get_v5_customers_by_customer_id_access_tokens_by_token_id	Get a Customer's access token	customerId (string) tokenId (string)
post_v5_customers	Creates a new customer	idempotency-key (string) data: { . name (string) . email (string) . document (string) . type (string) . address . metadata (string) . phones . code (string) . gender (string) . document_type (string) } (object) required
get_v5_customers	Get all Customers	name (string) document (string) page (string) size (string) email (string) Code (string)
get_v5_customers_by_customer_id_access_tokens	Delete a Customer's access tokens	customerId (string)
put_v5_customers_by_customer_id_addresses_by_address_id	Updates an address	customerId (string) addressId (string) idempotency-key (string) data: { . number (string) . complement (string) . metadata (string) . line_2 (string) } (object) required
get_v5_customers_by_customer_id_addresses_by_address_id	Get a customer's address	customerId (string) addressId (string)
delete_v5_customers_by_customer_id_addresses_by_address_id	Delete a Customer's address	customerId (string) addressId (string) idempotency-key (string)
get_v5_customers_by_customer_id_access_tokens	Delete a Customer's access tokens	customerId (string)
post_v5_customers_by_customer_id_access_tokens	Creates a access token for a customer	customerId (string) idempotency-key (string) data: { . expires_in (number) } (object) required
post_v5_customers_by_customer_id_cards	Creates a new card for a customer	customerId (string) idempotency-key (string) data: { . number (string) . holder_name (string) . exp_month (number) . exp_year (number) . cvv (string) . brand (string) . billing_address_id (string) . metadata (string) . type (string) . options . holder_document (string) . private_label (boolean) . label (string) . id (string) . token (string) } (object) required
get_v5_customers_by_customer_id_cards	Get all cards from a customer	customerId (string) page (string) size (string)
put_v5_customers_by_customer_id	Updates a customer	customerId (string) idempotency-key (string) data: { . name (string) . email (string) . document (string) . type (string) . address . metadata (string) . phones . code (string) . gender (string) . document_type (string) } (object) required
get_v5_customers_by_customer_id	Get a customer	customerId (string)
post_v5_customers_by_customer_id_cards_by_card_id_renew	Renew a card	customerId (string) cardId (string) idempotency-key (string)
patch_v5_customers_by_customer_id_metadata	Updates the metadata a customer	customerId (string) idempotency-key (string) data: { . metadata (string) } (object) required
get_v5_plans_by_plan_id	Gets a plan	planId (string)
put_v5_plans_by_plan_id	Updates a plan	planId (string) idempotency-key (string) data: { . name (string) . description (string) . installments (number) . statement_descriptor (string) . currency (string) . interval (string) . interval_count (number) . payment_methods (string) . billing_type (string) . status (string) . shippable (boolean) . billing_days (number) . metadata (string) . minimum_price (number) . trial_period_days (number) } (object) required
delete_v5_plans_by_plan_id	Deletes a plan	planId (string) idempotency-key (string)
delete_v5_plans_by_plan_id_items_by_plan_item_id	Removes an item from a plan	planId (string) planItemId (string) idempotency-key (string)
put_v5_plans_by_plan_id_items_by_plan_item_id	Updates a plan item	planId (string) planItemId (string) idempotency-key (string)
get_v5_plans_by_plan_id_items_by_plan_item_id	Gets a plan item	planId (string) planItemId (string)
patch_v5_plans_by_plan_id_metadata	Updates the metadata from a plan	planId (string) idempotency-key (string) data: { . metadata (string) } (object) required
post_v5_plans	Creates a new plan	idempotency-key (string)
get_v5_plans	Gets all plans	page (string) size (string) name (string) status (string) billing_type (string) created_since (string) created_until (string)
post_v5_plans_by_plan_id_items	Adds a new item to a plan	planId (string) idempotency-key (string) data: { . name (string) . id (string) . description (string) . cycles (number) . quantity (number) } (object) required
get_v5_invoices	Gets all invoices	page (string) size (string) code (string) customer_id (string) subscription_id (string) created_since (string) created_until (string) status (string) due_since (string) due_until (string) customer_document (string)
delete_v5_invoices_by_invoice_id	Cancels an invoice	invoiceId (string) idempotency-key (string)
get_v5_invoices_by_invoice_id	Gets an invoice	invoiceId (string)
patch_v5_invoices_by_invoice_id_status	Updates the status from an invoice	invoiceId (string) idempotency-key (string) data: { . status (string) } (object) required
patch_v5_invoices_by_invoice_id_metadata	Updates the metadata from an invoice	invoiceId (string) idempotency-key (string) data: { . metadata (string) } (object) required
get_v5_subscriptions_by_subscription_id_partial_invoice	get Partial Invoice	subscriptionId (string)
post_v5_subscriptions_by_subscription_id_cycles_by_cycle_id_pay	Create an Invoice	subscriptionId (string) cycleId (string) idempotency-key (string)
get_v5_transactions_by_transaction_id	get Transaction	transactionId (string)
get_v5_tokens_by_id_app_id_by_public_key	Gets a token from its id	id (string) publicKey (string)
post_v5_tokens_app_id_by_public_key	create Token	publicKey (string) idempotency-key (string) data: { . type (string) . card } (object) required