Skip to main content

MerchantProfile

Merchant Profile

type MerchantProfile {
id: ID!
accountId: ID!
merchantName: String!
merchantWebsite: String
merchantLogoUrl: String
statusInfo: MerchantProfileStatusInfo!
productType: ProductType!
expectedMonthlyPaymentVolume: Amount!
merchantPaymentMethods: [MerchantPaymentMethod!]
requestedMerchantProfileUpdates: [RequestMerchantProfileUpdate!] @deprecated
requestMerchantProfileUpdate: RequestMerchantProfileUpdate
expectedAverageBasket: Amount!
accentColor: String
createdAt: DateTime!
updatedAt: DateTime!
merchantPaymentLinks(
first: Int! = 50
after: String
orderBy: MerchantPaymentLinkOrderByInput
filters: MerchantPaymentLinkFiltersInput
): MerchantPaymentLinkConnection
merchantPayments(
first: Int! = 50
after: String
orderBy: MerchantPaymentOrderByInput
filters: MerchantPaymentFiltersInput
): MerchantPaymentConnection
}

Fields

MerchantProfile.id ● ID! non-null scalar

The Merchant Profile ID

MerchantProfile.accountId ● ID! non-null scalar

The Account ID this Merchant Profile is linked to

MerchantProfile.merchantName ● String! non-null scalar

Business name of the merchant, i.e. name that will be displayed on debtors' bank statements

MerchantProfile.merchantWebsite ● String scalar

Url of the merchant's website

MerchantProfile.merchantLogoUrl ● String scalar

Url of the merchant's logo

MerchantProfile.statusInfo ● MerchantProfileStatusInfo! non-null interface

The status of the merchant profile

MerchantProfile.productType ● ProductType! non-null enum

Type of product sold. List of value: Goods, Services, VirtualGoods, GiftsAndDonations. Gifts and donations can be club subscription or collection of donations (for associations), tips collection, contributions for local authorities

MerchantProfile.expectedMonthlyPaymentVolume ● Amount! non-null object

Expected annual activity volumes for all payment method

MerchantProfile.merchantPaymentMethods ● [MerchantPaymentMethod!] list interface

Payment Methods associated

MerchantProfile.requestedMerchantProfileUpdates ● [RequestMerchantProfileUpdate!] deprecated list object

DEPRECATED

No longer supported

Updates Requested associated

MerchantProfile.requestMerchantProfileUpdate ● RequestMerchantProfileUpdate object

Update Requested associated

MerchantProfile.expectedAverageBasket ● Amount! non-null object

expected average basket value.

MerchantProfile.accentColor ● String scalar

Your accent color, used in white label interfaces. This color would also be inherited in the Swan Merchant Payment page.

MerchantProfile.createdAt ● DateTime! non-null scalar

created date

MerchantProfile.updatedAt ● DateTime! non-null scalar

updated date

MerchantProfile.merchantPaymentLinks ● MerchantPaymentLinkConnection object

Returns a list of merchant payment links

Implements the Relay Connection interface, used to paginate list of element (Learn More)

MerchantProfile.merchantPaymentLinks.first ● Int! non-null scalar

the number of elements to load (maximum: 100)

MerchantProfile.merchantPaymentLinks.after ● String scalar

the index (a unique reference in string form) from which you will load the following elements

MerchantProfile.merchantPaymentLinks.orderBy ● MerchantPaymentLinkOrderByInput input

an order you can apply to your list of connections

MerchantProfile.merchantPaymentLinks.filters ● MerchantPaymentLinkFiltersInput input

a filtering table you can apply to your list of connections

MerchantProfile.merchantPayments ● MerchantPaymentConnection object

Returns a list of merchant payments

Implements the Relay Connection interface, used to paginate list of element (Learn More)

MerchantProfile.merchantPayments.first ● Int! non-null scalar

the number of elements to load (maximum: 100)

MerchantProfile.merchantPayments.after ● String scalar

the index (a unique reference in string form) from which you will load the following elements

MerchantProfile.merchantPayments.orderBy ● MerchantPaymentOrderByInput input

an order you can apply to your list of connections

MerchantProfile.merchantPayments.filters ● MerchantPaymentFiltersInput input

a filtering table you can apply to your list of connections

Returned By

merchantProfile query

Member Of

AddMerchantProfileSuccessPayload object ● CardInMerchant object ● CardMerchantPayment object ● CheckTransaction object ● DisableMerchantProfileSuccessPayload object ● InternalDirectDebitTransaction object ● MerchantPayment object ● MerchantPaymentLink object ● MerchantProfileEdge object ● RequestMerchantPaymentMethodsSuccessPayload object ● RequestMerchantProfileSuccessPayload object ● SEPADirectDebitTransaction object