Skip to content

MerchantsApi.md

Latest commit

 

History

History
215 lines (159 loc) · 6.88 KB

MerchantsApi.md

File metadata and controls

215 lines (159 loc) · 6.88 KB

\MerchantsApi

Method HTTP request Description
ListMerchantLocations Get /merchants/{merchant_guid}/merchant_locations List merchant locations
ListMerchants Get /merchants List merchants
ReadMerchant Get /merchants/{merchant_guid} Read merchant
ReadMerchantLocation Get /merchants/{merchant_guid}/merchant_locations/{merchant_location_guid} Read merchant location

ListMerchantLocations

MerchantLocationsResponseBody ListMerchantLocations(ctx, merchantGUID, optional) List merchant locations

Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go/v2"
  "github.com/antihax/optional"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  merchantGUID := "MCH-123" // string | The unique identifier for a `merchant`.
  opts := &atrium.ListMerchantLocationsOpts{ 
    Page: optional.NewInt32(1), // int32 | Specify current page.
    RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
  }

  response, _, err := client.Merchants.ListMerchantLocations(ctx, merchantGUID, , opts)
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
merchantGUID string The unique identifier for a `merchant`.
optional *ListMerchantLocationsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListMerchantLocationsOpts struct

Name Type Description Notes

page | optional.Int32| Specify current page. | recordsPerPage | optional.Int32| Specify records per page. |

Return type

MerchantLocationsResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListMerchants

MerchantsResponseBody ListMerchants(ctx, optional) List merchants

Returns a list of merchnants.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go/v2"
  "github.com/antihax/optional"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  opts := &atrium.ListMerchantsOpts{ 
    Page: optional.NewInt32(1), // int32 | Specify current page.
    RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
  }

  response, _, err := client.Merchants.ListMerchants(ctx, opts)
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ListMerchantsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListMerchantsOpts struct

Name Type Description Notes
page optional.Int32 Specify current page.
recordsPerPage optional.Int32 Specify records per page.

Return type

MerchantsResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadMerchant

MerchantResponseBody ReadMerchant(ctx, merchantGUID) Read merchant

Returns information about a particular merchant, such as a logo, name, and website.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go/v2"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  merchantGUID := "MCH-123" // string | The unique identifier for a `merchant`.

  response, _, err := client.Merchants.ReadMerchant(ctx, merchantGUID, )
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
merchantGUID string The unique identifier for a `merchant`.

Return type

MerchantResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReadMerchantLocation

MerchantLocationResponseBody ReadMerchantLocation(ctx, merchantGUID, merchantLocationGUID) Read merchant location

Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.

Example

package main

import (
  "context"
  "fmt"
  "github.com/mxenabled/atrium-go/v2"
)

func main() {
  client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
  ctx := context.Background()
  
  merchantGUID := "MCH-123" // string | The unique identifier for a `merchant`.
  merchantLocationGUID := "MCL-123" // string | The unique identifier for a `merchant_location`.

  response, _, err := client.Merchants.ReadMerchantLocation(ctx, merchantGUID, merchantLocationGUID)
  if err != nil {
    fmt.Printf("Error: %v\n", err)
  } else {
    fmt.Printf("Response: %s\n", response)
  }
}

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
merchantGUID string The unique identifier for a `merchant`.
merchantLocationGUID string The unique identifier for a `merchant_location`.

Return type

MerchantLocationResponseBody

[Back to top] [Back to API list] [Back to Model list] [Back to README]