Skip to content

Latest commit

 

History

History
223 lines (168 loc) · 15.4 KB

README.md

File metadata and controls

223 lines (168 loc) · 15.4 KB
Raw

Guest

(Payments.Guest)

Available Operations

  • Initialize - Initialize a Bolt payment for guest shoppers
  • Update - Update an existing guest payment
  • PerformAction - Perform an irreversible action (e.g. finalize) on a pending guest payment

Initialize

Initialize a Bolt payment token that will be used to reference this payment to Bolt when it is updated or finalized for guest shoppers.

Example Usage

package main

import(
	boltgo "github.com/BoltApp/bolt-go"
	"github.com/BoltApp/bolt-go/models/components"
	"github.com/BoltApp/bolt-go/models/operations"
	"context"
	"log"
)

func main() {
    s := boltgo.New()


    var xPublishableKey string = "<value>"

    guestPaymentInitializeRequest := components.GuestPaymentInitializeRequest{
        Profile: components.ProfileCreationData{
            CreateAccount: true,
            FirstName: "Alice",
            LastName: "Baker",
            Email: "alice@example.com",
            Phone: boltgo.String("+14155550199"),
        },
        Cart: components.Cart{
            OrderReference: "order_100",
            OrderDescription: boltgo.String("Order #1234567890"),
            DisplayID: boltgo.String("215614191"),
            Total: components.Amount{
                Currency: components.CurrencyUsd,
                Units: 900,
            },
            Tax: components.Amount{
                Currency: components.CurrencyUsd,
                Units: 900,
            },
        },
        PaymentMethod: components.CreatePaymentMethodInputPaymentMethodPaypal(
                components.PaymentMethodPaypal{
                    DotTag: components.PaymentMethodPaypalTagPaypal,
                    SuccessURL: "https://www.example.com/paypal-callback/success",
                    CancelURL: "https://www.example.com/paypal-callback/cancel",
                },
        ),
    }

    operationSecurity := operations.GuestPaymentsInitializeSecurity{
            APIKey: "<YOUR_API_KEY_HERE>",
        }

    ctx := context.Background()
    res, err := s.Payments.Guest.Initialize(ctx, operationSecurity, xPublishableKey, guestPaymentInitializeRequest)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
security operations.GuestPaymentsInitializeSecurity ✔️ The security requirements to use for the request.
xPublishableKey string ✔️ The publicly viewable identifier used to identify a merchant division.
guestPaymentInitializeRequest components.GuestPaymentInitializeRequest ✔️ N/A

Response

*operations.GuestPaymentsInitializeResponse, error

Error Object Status Code Content Type
sdkerrors.GuestPaymentsInitializeResponseBody 4XX application/json
sdkerrors.SDKError 4xx-5xx /

Update

Update a pending guest payment

Example Usage

package main

import(
	boltgo "github.com/BoltApp/bolt-go"
	"github.com/BoltApp/bolt-go/models/components"
	"github.com/BoltApp/bolt-go/models/operations"
	"context"
	"log"
)

func main() {
    s := boltgo.New()


    var id string = "iKv7t5bgt1gg"

    var xPublishableKey string = "<value>"

    paymentUpdateRequest := components.PaymentUpdateRequest{}

    operationSecurity := operations.GuestPaymentsUpdateSecurity{
            APIKey: "<YOUR_API_KEY_HERE>",
        }

    ctx := context.Background()
    res, err := s.Payments.Guest.Update(ctx, operationSecurity, id, xPublishableKey, paymentUpdateRequest)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
security operations.GuestPaymentsUpdateSecurity ✔️ The security requirements to use for the request.
id string ✔️ The ID of the guest payment to update iKv7t5bgt1gg
xPublishableKey string ✔️ The publicly viewable identifier used to identify a merchant division.
paymentUpdateRequest components.PaymentUpdateRequest ✔️ N/A

Response

*operations.GuestPaymentsUpdateResponse, error

Error Object Status Code Content Type
sdkerrors.GuestPaymentsUpdateResponseBody 4XX application/json
sdkerrors.SDKError 4xx-5xx /

PerformAction

Perform an irreversible action on a pending guest payment, such as finalizing it.

Example Usage

package main

import(
	boltgo "github.com/BoltApp/bolt-go"
	"github.com/BoltApp/bolt-go/models/components"
	"github.com/BoltApp/bolt-go/models/operations"
	"context"
	"log"
)

func main() {
    s := boltgo.New()


    var id string = "iKv7t5bgt1gg"

    var xPublishableKey string = "<value>"

    paymentActionRequest := components.PaymentActionRequest{
        DotTag: components.PaymentActionRequestTagFinalize,
        RedirectResult: boltgo.String("eyJ0cmFuc"),
    }

    operationSecurity := operations.GuestPaymentsActionSecurity{
            APIKey: "<YOUR_API_KEY_HERE>",
        }

    ctx := context.Background()
    res, err := s.Payments.Guest.PerformAction(ctx, operationSecurity, id, xPublishableKey, paymentActionRequest)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description Example
ctx context.Context ✔️ The context to use for the request.
security operations.GuestPaymentsActionSecurity ✔️ The security requirements to use for the request.
id string ✔️ The ID of the guest payment to operate on iKv7t5bgt1gg
xPublishableKey string ✔️ The publicly viewable identifier used to identify a merchant division.
paymentActionRequest components.PaymentActionRequest ✔️ N/A

Response

*operations.GuestPaymentsActionResponse, error

Error Object Status Code Content Type
sdkerrors.GuestPaymentsActionResponseBody 4XX application/json
sdkerrors.SDKError 4xx-5xx /