payables

Documentation

Index

• type API
  • func New(cfg *pagarme.Config) *API
  • func (api *API) Query(input *QueryInput) (*pagarme.Response, []pagarme.Payable, error)
• type QueryInput
  • func (qi *QueryInput) Amount(op pagarme.QueryOp, v int) *QueryInput
  • func (qi *QueryInput) Build() string
  • func (qi *QueryInput) BulkAnticipationID(v string) *QueryInput
  • func (qi *QueryInput) Count(v int) *QueryInput
  • func (qi *QueryInput) CreatedAt(op pagarme.QueryOp, t time.Time) *QueryInput
  • func (qi *QueryInput) GetCount() int
  • func (qi *QueryInput) ID(v string) *QueryInput
  • func (qi *QueryInput) Installment(op pagarme.QueryOp, v int) *QueryInput
  • func (qi *QueryInput) Page(v int) *QueryInput
  • func (qi *QueryInput) PaymentDate(op pagarme.QueryOp, t time.Time) *QueryInput
  • func (qi *QueryInput) RecipientID(v string) *QueryInput
  • func (qi *QueryInput) SplitRuleID(v string) *QueryInput
  • func (qi *QueryInput) Status(v pagarme.PayableStatus) *QueryInput
  • func (qi *QueryInput) TransactionID(v string) *QueryInput
  • func (qi *QueryInput) Type(v pagarme.PayableType) *QueryInput

Types

type API

type API struct {
	Config *pagarme.Config
}

API is the /1/payables API

func New

func New(cfg *pagarme.Config) *API

New /1/payables API

func (*API) Query

func (api *API) Query(input *QueryInput) (*pagarme.Response, []pagarme.Payable, error)

Query -> GET https://api.pagar.me/1/payables

type QueryInput

type QueryInput struct {
	// contains filtered or unexported fields
}

QueryInput is the input data of Query

func (*QueryInput) Amount

func (qi *QueryInput) Amount(op pagarme.QueryOp, v int) *QueryInput

Amount -> Filtro pelo valor do recebível

func (*QueryInput) Build

func (qi *QueryInput) Build() string

Build builds the payable query to a urlencoded format

func (*QueryInput) BulkAnticipationID

func (qi *QueryInput) BulkAnticipationID(v string) *QueryInput

BulkAnticipationID -> Filtro pelo id da antecipação

func (*QueryInput) Count

func (qi *QueryInput) Count(v int) *QueryInput

Count -> Parâmetro de quantos resultados devem ser retornados

func (*QueryInput) CreatedAt

func (qi *QueryInput) CreatedAt(op pagarme.QueryOp, t time.Time) *QueryInput

CreatedAt -> Filtro pela data de criação do payable

func (*QueryInput) GetCount

func (qi *QueryInput) GetCount() int

GetCount -> retorna quantos resultados devem ser retornados

func (*QueryInput) ID

func (qi *QueryInput) ID(v string) *QueryInput

ID -> Filtro pelo ID do recebível

func (*QueryInput) Installment

func (qi *QueryInput) Installment(op pagarme.QueryOp, v int) *QueryInput

Installment -> Filtro pelo installment do recebível - a qual parcela da transação o recebível se refere

func (*QueryInput) Page

func (qi *QueryInput) Page(v int) *QueryInput

Page -> Parâmetro de paginação: aplica um offset de page * count nos resultados

func (*QueryInput) PaymentDate

func (qi *QueryInput) PaymentDate(op pagarme.QueryOp, t time.Time) *QueryInput

PaymentDate -> Filtro pela data de pagamento do recebível

func (*QueryInput) RecipientID

func (qi *QueryInput) RecipientID(v string) *QueryInput

RecipientID -> Filtro pelo ID do recebedor atrelado

func (*QueryInput) SplitRuleID

func (qi *QueryInput) SplitRuleID(v string) *QueryInput

SplitRuleID -> Filtro pelo ID da regra de split atrelada

func (*QueryInput) Status

func (qi *QueryInput) Status(v pagarme.PayableStatus) *QueryInput

Status -> Filtro pelo status do recebível. paid ou waiting_funds

func (*QueryInput) TransactionID

func (qi *QueryInput) TransactionID(v string) *QueryInput

TransactionID -> Filtro pelo ID da transação referida pelo recebível

func (*QueryInput) Type

func (qi *QueryInput) Type(v pagarme.PayableType) *QueryInput

Type -> Filtro pelo type do recebível. Pode ser chargeback, refund, chargeback_refund ou credit