Payment

(Payment)

Overview

Available Operations

CreatePaymentLink - Create a link
CreatePaymentPayment - Create a payment
GetPaymentLink - Retrieve a link
GetPaymentPayment - Retrieve a payment
GetPaymentPayout - Retrieve a payout
GetPaymentRefund - Retrieve a refund
ListPaymentLinks - List all links
ListPaymentPayments - List all payments
ListPaymentPayouts - List all payouts
ListPaymentRefunds - List all refunds
PatchPaymentLink - Update a link
PatchPaymentPayment - Update a payment
RemovePaymentLink - Remove a link
RemovePaymentPayment - Remove a payment
UpdatePaymentLink - Update a link
UpdatePaymentPayment - Update a payment

CreatePaymentLink

Create a link

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.CreatePaymentLinkRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.CreatePaymentLink(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentLink != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.CreatePaymentLinkRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreatePaymentLinkResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

CreatePaymentPayment

Create a payment

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.CreatePaymentPaymentRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.CreatePaymentPayment(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayment != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.CreatePaymentPaymentRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreatePaymentPaymentResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

GetPaymentLink

Retrieve a link

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.GetPaymentLinkRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.GetPaymentLink(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentLink != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetPaymentLinkRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPaymentLinkResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

GetPaymentPayment

Retrieve a payment

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.GetPaymentPaymentRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.GetPaymentPayment(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayment != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetPaymentPaymentRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPaymentPaymentResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

GetPaymentPayout

Retrieve a payout

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.GetPaymentPayoutRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.GetPaymentPayout(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayout != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetPaymentPayoutRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPaymentPayoutResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

GetPaymentRefund

Retrieve a refund

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.GetPaymentRefundRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.GetPaymentRefund(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentRefund != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.GetPaymentRefundRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetPaymentRefundResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListPaymentLinks

List all links

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.ListPaymentLinksRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.ListPaymentLinks(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentLinks != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListPaymentLinksRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListPaymentLinksResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListPaymentPayments

List all payments

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.ListPaymentPaymentsRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.ListPaymentPayments(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayments != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListPaymentPaymentsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListPaymentPaymentsResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListPaymentPayouts

List all payouts

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.ListPaymentPayoutsRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.ListPaymentPayouts(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayouts != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListPaymentPayoutsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListPaymentPayoutsResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListPaymentRefunds

List all refunds

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.ListPaymentRefundsRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Payment.ListPaymentRefunds(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentRefunds != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.ListPaymentRefundsRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListPaymentRefundsResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

PatchPaymentLink

Update a link

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.PatchPaymentLinkRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.PatchPaymentLink(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentLink != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.PatchPaymentLinkRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.PatchPaymentLinkResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

PatchPaymentPayment

Update a payment

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.PatchPaymentPaymentRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.PatchPaymentPayment(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayment != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.PatchPaymentPaymentRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.PatchPaymentPaymentResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

RemovePaymentLink

Remove a link

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.RemovePaymentLinkRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.RemovePaymentLink(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.RemovePaymentLinkRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.RemovePaymentLinkResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

RemovePaymentPayment

Remove a payment

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.RemovePaymentPaymentRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.RemovePaymentPayment(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.RemovePaymentPaymentRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.RemovePaymentPaymentResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

UpdatePaymentLink

Update a link

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.UpdatePaymentLinkRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.UpdatePaymentLink(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentLink != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.UpdatePaymentLinkRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UpdatePaymentLinkResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

UpdatePaymentPayment

Update a payment

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.UpdatePaymentPaymentRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Payment.UpdatePaymentPayment(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.PaymentPayment != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.UpdatePaymentPaymentRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UpdatePaymentPaymentResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Payment

Overview

Available Operations

CreatePaymentLink

Example Usage

Parameters

Response

Errors

CreatePaymentPayment

Example Usage

Parameters

Response

Errors

GetPaymentLink

Example Usage

Parameters

Response

Errors

GetPaymentPayment

Example Usage

Parameters

Response

Errors

GetPaymentPayout

Example Usage

Parameters

Response

Errors

GetPaymentRefund

Example Usage

Parameters

Response

Errors

ListPaymentLinks

Example Usage

Parameters

Response

Errors

ListPaymentPayments

Example Usage

Parameters

Response

Errors

ListPaymentPayouts

Example Usage

Parameters

Response

Errors

ListPaymentRefunds

Example Usage

Parameters

Response

Errors

PatchPaymentLink

Example Usage

Parameters

Response

Errors

PatchPaymentPayment

Example Usage

Parameters

Response

Errors

RemovePaymentLink

Example Usage

Parameters

Response

Errors

RemovePaymentPayment

Example Usage

Parameters

Response

Errors

UpdatePaymentLink