Charges

chargesController := client.ChargesController()

Class Name

ChargesController

Methods

Update Charge Metadata
Update Charge Payment Method
Get Charge Transactions
Update Charge Due Date
Get Charges
Capture Charge
Update Charge Card
Get Charge
Get Charges Summary
Retry Charge
Cancel Charge
Create Charge
Confirm Payment

Update Charge Metadata

Updates the metadata from a charge

UpdateChargeMetadata(
    ctx context.Context,
    chargeId string,
    request models.UpdateMetadataRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	The charge id
`request`	`models.UpdateMetadataRequest`	Body, Required	Request for updating the charge metadata
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

request := models.UpdateMetadataRequest{
    Metadata: map[string]string{
"key0" : "metadata3",
},
}

apiResponse, err := chargesController.UpdateChargeMetadata(ctx, chargeId, &request, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Update Charge Payment Method

Updates a charge's payment method

UpdateChargePaymentMethod(
    ctx context.Context,
    chargeId string,
    request models.UpdateChargePaymentMethodRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id
`request`	`models.UpdateChargePaymentMethodRequest`	Body, Required	Request for updating the payment method from a charge
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

requestCreditCard := models.CreateCreditCardPaymentRequest{
    Installments:         models.ToPointer(1),
    Capture:              models.ToPointer(true),
    RecurrencyCycle:      models.ToPointer("\"first\" or \"subsequent\""),
}

requestDebitCard := models.CreateDebitCardPaymentRequest{
}

requestBoletoBillingAddress := models.CreateAddressRequest{
    Street:       "street8",
    Number:       "number4",
    ZipCode:      "zip_code2",
    Neighborhood: "neighborhood4",
    City:         "city2",
    State:        "state6",
    Country:      "country2",
    Complement:   "complement6",
    Line1:        "line_18",
    Line2:        "line_26",
}

requestBoleto := models.CreateBoletoPaymentRequest{
    Retries:             226,
    Instructions:        "instructions2",
    DocumentNumber:      "document_number6",
    StatementDescriptor: "statement_descriptor0",
    BillingAddress:      requestBoletoBillingAddress,
}

requestVoucher := models.CreateVoucherPaymentRequest{
    RecurrencyCycle:     models.ToPointer("\"first\" or \"subsequent\""),
}

requestCash := models.CreateCashPaymentRequest{
    Description: "description0",
    Confirm:     false,
}

requestBankTransfer := models.CreateBankTransferPaymentRequest{
    Bank:    "bank0",
    Retries: 236,
}

requestPrivateLabel := models.CreatePrivateLabelPaymentRequest{
    Installments:         models.ToPointer(1),
    Capture:              models.ToPointer(true),
    RecurrencyCycle:      models.ToPointer("\"first\" or \"subsequent\""),
}

request := models.UpdateChargePaymentMethodRequest{
    UpdateSubscription: false,
    PaymentMethod:      "payment_method4",
    CreditCard:         requestCreditCard,
    DebitCard:          requestDebitCard,
    Boleto:             requestBoleto,
    Voucher:            requestVoucher,
    Cash:               requestCash,
    BankTransfer:       requestBankTransfer,
    PrivateLabel:       requestPrivateLabel,
}

apiResponse, err := chargesController.UpdateChargePaymentMethod(ctx, chargeId, &request, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Get Charge Transactions

GetChargeTransactions(
    ctx context.Context,
    chargeId string,
    page *int,
    size *int) (
    models.ApiResponse[models.ListChargeTransactionsResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge Id
`page`	`*int`	Query, Optional	Page number
`size`	`*int`	Query, Optional	Page size

Response Type

models.ListChargeTransactionsResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.GetChargeTransactions(ctx, chargeId, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Update Charge Due Date

Updates the due date from a charge

UpdateChargeDueDate(
    ctx context.Context,
    chargeId string,
    request models.UpdateChargeDueDateRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge Id
`request`	`models.UpdateChargeDueDateRequest`	Body, Required	Request for updating the due date
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

request := models.UpdateChargeDueDateRequest{
}

apiResponse, err := chargesController.UpdateChargeDueDate(ctx, chargeId, &request, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Get Charges

Lists all charges

GetCharges(
    ctx context.Context,
    page *int,
    size *int,
    code *string,
    status *string,
    paymentMethod *string,
    customerId *string,
    orderId *string,
    createdSince *time.Time,
    createdUntil *time.Time) (
    models.ApiResponse[models.ListChargesResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`page`	`*int`	Query, Optional	Page number
`size`	`*int`	Query, Optional	Page size
`code`	`*string`	Query, Optional	Filter for charge's code
`status`	`*string`	Query, Optional	Filter for charge's status
`paymentMethod`	`*string`	Query, Optional	Filter for charge's payment method
`customerId`	`*string`	Query, Optional	Filter for charge's customer id
`orderId`	`*string`	Query, Optional	Filter for charge's order id
`createdSince`	`*time.Time`	Query, Optional	Filter for the beginning of the range for charge's creation
`createdUntil`	`*time.Time`	Query, Optional	Filter for the end of the range for charge's creation

Response Type

models.ListChargesResponse

Example Usage

ctx := context.Background()

apiResponse, err := chargesController.GetCharges(ctx, nil, nil, nil, nil, nil, nil, nil, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Capture Charge

Captures a charge

CaptureCharge(
    ctx context.Context,
    chargeId string,
    request *models.CreateCaptureChargeRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id
`request`	`*models.CreateCaptureChargeRequest`	Body, Optional	Request for capturing a charge
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.CaptureCharge(ctx, chargeId, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Update Charge Card

Updates the card from a charge

UpdateChargeCard(
    ctx context.Context,
    chargeId string,
    request models.UpdateChargeCardRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id
`request`	`models.UpdateChargeCardRequest`	Body, Required	Request for updating a charge's card
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

requestCard := models.CreateCardRequest{
    Type:             models.ToPointer("credit"),
}

request := models.UpdateChargeCardRequest{
    UpdateSubscription: false,
    CardId:             "card_id2",
    Recurrence:         false,
    Card:               requestCard,
}

apiResponse, err := chargesController.UpdateChargeCard(ctx, chargeId, &request, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Get Charge

Get a charge from its id

GetCharge(
    ctx context.Context,
    chargeId string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.GetCharge(ctx, chargeId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Get Charges Summary

GetChargesSummary(
    ctx context.Context,
    status string,
    createdSince *time.Time,
    createdUntil *time.Time) (
    models.ApiResponse[models.GetChargesSummaryResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`status`	`string`	Query, Required	-
`createdSince`	`*time.Time`	Query, Optional	-
`createdUntil`	`*time.Time`	Query, Optional	-

Response Type

models.GetChargesSummaryResponse

Example Usage

ctx := context.Background()
status := "status8"

apiResponse, err := chargesController.GetChargesSummary(ctx, status, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Retry Charge

Retries a charge

RetryCharge(
    ctx context.Context,
    chargeId string,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.RetryCharge(ctx, chargeId, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Cancel Charge

Cancel a charge

CancelCharge(
    ctx context.Context,
    chargeId string,
    request *models.CreateCancelChargeRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	Charge id
`request`	`*models.CreateCancelChargeRequest`	Body, Optional	Request for cancelling a charge
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.CancelCharge(ctx, chargeId, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Create Charge

Creates a new charge

CreateCharge(
    ctx context.Context,
    request models.CreateChargeRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`request`	`models.CreateChargeRequest`	Body, Required	Request for creating a charge
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()

requestPayment := models.CreatePaymentRequest{
    PaymentMethod:        "payment_method4",
}

request := models.CreateChargeRequest{
    Amount:     242,
    OrderId:    "order_id0",
    Payment:    requestPayment,
}

apiResponse, err := chargesController.CreateCharge(ctx, &request, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Confirm Payment

ConfirmPayment(
    ctx context.Context,
    chargeId string,
    request *models.CreateConfirmPaymentRequest,
    idempotencyKey *string) (
    models.ApiResponse[models.GetChargeResponse],
    error)

Parameters

Parameter	Type	Tags	Description
`chargeId`	`string`	Template, Required	-
`request`	`*models.CreateConfirmPaymentRequest`	Body, Optional	Request for confirm payment
`idempotencyKey`	`*string`	Header, Optional	-

Response Type

models.GetChargeResponse

Example Usage

ctx := context.Background()
chargeId := "charge_id8"

apiResponse, err := chargesController.ConfirmPayment(ctx, chargeId, nil, nil)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Files

charges.md

Latest commit

History

charges.md

File metadata and controls

Charges

Class Name

Methods

Update Charge Metadata

Parameters

Response Type

Example Usage

Update Charge Payment Method

Parameters

Response Type

Example Usage

Get Charge Transactions

Parameters

Response Type

Example Usage

Update Charge Due Date

Parameters

Response Type

Example Usage

Get Charges

Parameters

Response Type

Example Usage

Capture Charge

Parameters

Response Type

Example Usage

Update Charge Card

Parameters

Response Type

Example Usage

Get Charge

Parameters

Response Type

Example Usage

Get Charges Summary

Parameters

Response Type

Example Usage

Retry Charge

Parameters

Response Type

Example Usage

Cancel Charge

Parameters

Response Type

Example Usage

Create Charge

Parameters

Response Type

Example Usage

Confirm Payment

Parameters

Response Type

Example Usage