forward

Documentation

Index

• func NewDlocalSignature() *dlocalSignature
• func NewIdSource() *idSource
• func NewTokenSource() *tokenSource
• type AbstractSignature
• type AbstractSource
• type Client
  • func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client
  • func (c *Client) ForwardAnApiRequest(request ForwardRequest) (*ForwardAnApiResponse, error)
  • func (c *Client) GetForwardRequest(forwardId string) (*GetForwardResponse, error)
• type DestinationRequest
• type DestinationRequestResponse
• type DestinationResponse
• type DlocalParameters
• type ForwardAnApiResponse
• type ForwardRequest
• type GetForwardResponse
• type Headers
• type MethodType
• type NetworkToken
• type SignatureType
• type SourceType

Functions

func NewDlocalSignature

func NewDlocalSignature() *dlocalSignature

func NewIdSource

func NewIdSource() *idSource

func NewTokenSource

func NewTokenSource() *tokenSource

Types

type AbstractSignature

type AbstractSignature interface {
	GetType() SignatureType
}

type AbstractSource

type AbstractSource interface {
	GetType() SourceType
}

type Client

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

func NewClient

func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client

func (*Client) ForwardAnApiRequest

func (c *Client) ForwardAnApiRequest(request ForwardRequest) (*ForwardAnApiResponse, error)

func (*Client) GetForwardRequest

func (c *Client) GetForwardRequest(forwardId string) (*GetForwardResponse, error)

type DestinationRequest

type DestinationRequest struct {
	// The URL to forward the request to (Required, max 1024 characters)
	Url string `json:"url"`
	// The HTTP method to use for the forward request (Required)
	Method MethodType `json:"method"`
	// The HTTP headers to include in the forward request (Required)
	Headers *Headers `json:"headers"`
	// The HTTP message body to include in the forward request. If you provide source.id or source.token, you can
	// specify placeholder values in the body. The request will be enriched with the respective payment details
	// from the token or payment instrument you specified. For example, {{card_number}}
	// (Required, max 16384 characters)
	Body string `json:"body"`
	// Optional configuration to add a signature to the forwarded HTTP request. (Optional)
	Signature AbstractSignature `json:"signature,omitempty"`
}

type DestinationRequestResponse

type DestinationRequestResponse struct {
	// Url is the URL of the forward request. (Required: true)
	Url string `json:"url"`
	// Method is the HTTP method of the forward request. (Required: true)
	Method string `json:"method"`
	// Headers are the HTTP headers of the forward request. Encrypted and sensitive header values are redacted. (Required: true)
	Headers map[string]string `json:"headers"`
	// Body is the HTTP message body of the forward request. This is the original value used to initiate the request, with placeholder value text included. For example, {{card_number}} is not replaced with an actual card number. (Required: true)
	Body string `json:"body"`
}

type DestinationResponse

type DestinationResponse struct {
	// The HTTP status code of the destination response (Required)
	Status int `json:"status"`
	// The destination response's HTTP headers. (Required)
	Headers map[string][]string `json:"headers"`
	// The destination response's HTTP message body (Required)
	Body string `json:"body"`
}

type DlocalParameters

type DlocalParameters struct {
	// The secret key used to generate the request signature. This is part of the dLocal API credentials.
	SecretKey string `json:"secret_key"`
}

type ForwardAnApiResponse

type ForwardAnApiResponse struct {
	HttpMetadata common.HttpMetadata `json:"http_metadata,omitempty"`
	// The unique identifier for the forward request (Required)
	RequestId string `json:"request_id"`
	// The HTTP response received from the destination, if the forward request completed successfully. Sensitive PCI
	// data will be removed from the response (Optional)
	DestinationResponse *DestinationResponse `json:"destination_response,omitempty"`
}

type ForwardRequest

type ForwardRequest struct {
	// The payment source to enrich the forward request with. You can provide placeholder values in
	// destination_request.body. The request will be enriched with the respective payment credentials from the token or
	// payment instrument you specified. For example, {{card_number}} (Required)
	Source AbstractSource `json:"source"`
	// The parameters of the forward request (Required)
	DestinationRequest *DestinationRequest `json:"destination_request"`
	// The unique reference for the forward request (Optional, max 80 characters)
	Reference string `json:"reference,omitempty"`
	// The processing channel ID to associate the billing for the forward request with (Optional,
	// pattern ^(pc)_(\w{26})$)
	ProcessingChannelId string `json:"processing_channel_id,omitempty"`
	// Specifies if and how a network token should be used in the forward request (Optional)
	NetworkToken *NetworkToken `json:"network_token,omitempty"`
}

type GetForwardResponse

type GetForwardResponse struct {
	HttpMetadata common.HttpMetadata `json:"http_metadata,omitempty"`
	// The unique identifier for the forward request (Required)
	RequestId string `json:"request_id"`
	// The client entity linked to the forward request (Required)
	EntityId string `json:"entity_id"`
	// The parameters of the HTTP request forwarded to the destination (Required)
	DestinationRequest *DestinationRequestResponse `json:"destination_request"`
	// The date and time the forward request was created, in UTC (Required)
	CreatedOn time.Time `json:"created_on"`
	// The unique reference for the forward request (Optional)
	Reference string `json:"reference,omitempty"`
	// The HTTP response received from the destination. Sensitive PCI data is not included in the response
	// (Optional)
	DestinationResponse *DestinationResponse `json:"destination_response,omitempty"`
}

type Headers

type Headers struct {
	// The raw headers to include in the forward request (Required, max 16 characters)
	Raw map[string]string `json:"raw"`
	// The encrypted headers to include in the forward request, as a JSON object with string values encrypted
	// with JSON Web Encryption (JWE) (Optional, max 8192 characters)
	Encrypted string `json:"encrypted,omitempty"`
}

type MethodType

type MethodType string

const (
	GetMT     MethodType = "GET"
	PostMT    MethodType = "POST"
	PutMT     MethodType = "PUT"
	DeleteMT  MethodType = "DELETE"
	PatchMT   MethodType = "PATCH"
	HeadMT    MethodType = "HEAD"
	OptionsMT MethodType = "OPTIONS"
	TraceMT   MethodType = "TRACE"
)

type NetworkToken

type NetworkToken struct {
	// Specifies whether to use a network token (Optional)
	Enabled bool `json:"enabled,omitempty"`
	// Specifies whether to generate a cryptogram. For example, for customer-initiated transactions (CITs). If you
	// set network_token.enabled to true, you must provide this field (Optional)
	RequestCryptogram bool `json:"request_cryptogram,omitempty"`
}

type SignatureType

type SignatureType string

const (
	DlocalST SignatureType = "dlocal"
)

type SourceType

type SourceType string

const (
	IdST    SourceType = "id"
	TokenST SourceType = "token"
)