MerchantProfile
Merchant Profile
type MerchantProfile {
id: ID!
supportingDocumentCollections(
first: Int! = 50
before: String
after: String
filters: SupportingDocumentCollectionFilterInput
): SupportingDocumentCollectionConnection!
accentColor: String
accountId: ID!
createdAt: DateTime!
customerRegion: MerchantProfileCustomerRegion
expectedAverageBasket: Amount!
expectedMonthlyPaymentVolume: Amount! @deprecated
expectedMonthlyMerchantProcessingVolume: ExpectedMonthlyMerchantProcessingVolume!
invoiceExampleUrl: String @deprecated
merchantLogoUrl: String
merchantName: String!
merchantPaymentLinks(
first: Int! = 50
after: String
orderBy: MerchantPaymentLinkOrderByInput
filters: MerchantPaymentLinkFiltersInput
): MerchantPaymentLinkConnection
merchantPaymentMethods: [MerchantPaymentMethod!]
merchantPayments(
first: Int! = 50
after: String
orderBy: MerchantPaymentOrderByInput
filters: MerchantPaymentFiltersInput
): MerchantPaymentConnection
merchantWebsite: String @deprecated
merchantWebsiteUrl: String
paymentFrequency: MerchantProfilePaymentFrequency
productType: ProductType!
requestedMerchantProfileUpdates: [RequestMerchantProfileUpdate!] @deprecated
requestMerchantProfileUpdate: RequestMerchantProfileUpdate
socialNetwork: String @deprecated
socialNetworkUrl: String
statusInfo: MerchantProfileStatusInfo!
supportWebsite: String @deprecated
supportWebsiteUrl: String
termsAndConditions: String @deprecated
termsAndConditionsUrl: String
updatedAt: DateTime!
additionalInformation: [AdditionalInformation!]!
}
Fields
MerchantProfile.id ● ID! non-null scalar
The Merchant Profile ID
MerchantProfile.supportingDocumentCollections ● SupportingDocumentCollectionConnection! non-null object
MerchantProfile.supportingDocumentCollections.first ● Int! non-null scalar
the number of elements to load (maximum: 100)
MerchantProfile.supportingDocumentCollections.before ● String scalar
the index (a unique reference in string form) from which you will load the preceding elements
MerchantProfile.supportingDocumentCollections.after ● String scalar
the index (a unique reference in string form) from which you will load the following elements
MerchantProfile.supportingDocumentCollections.filters ● SupportingDocumentCollectionFilterInput input
a filtering table you can apply to your list of connections
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.accountId ● ID! non-null scalar
The Account ID this Merchant Profile is linked to
MerchantProfile.createdAt ● DateTime! non-null scalar
created date
MerchantProfile.customerRegion ● MerchantProfileCustomerRegion enum
Where the payer are generally based.
MerchantProfile.expectedAverageBasket ● Amount! non-null object
expected average basket value.
MerchantProfile.expectedMonthlyPaymentVolume ● Amount! deprecated non-null object
use expectedMonthlyMerchantProcessingVolume instead
Expected annual activity volumes for all payment method
MerchantProfile.expectedMonthlyMerchantProcessingVolume ● ExpectedMonthlyMerchantProcessingVolume! non-null enum
Expected annual activity volumes for all payment method
MerchantProfile.invoiceExampleUrl ● String deprecated scalar
Unused, will be removed in future versions
Url of an example typical invoice issued by the merchant.
MerchantProfile.merchantLogoUrl ● String scalar
Url of the merchant's logo
MerchantProfile.merchantName ● String! non-null scalar
Business name of the merchant, i.e. name that will be displayed on debtors' bank statements
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.merchantPaymentMethods ● [MerchantPaymentMethod!] list interface
Payment Methods associated
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
MerchantProfile.merchantWebsite ● String deprecated scalar
Use merchantWebsiteUrl instead
Url of the merchant's website
MerchantProfile.merchantWebsiteUrl ● String scalar
Url of the merchant's website
MerchantProfile.paymentFrequency ● MerchantProfilePaymentFrequency enum
The type of payments accepted by the merchant. Can be OneOff (no returning payers in general), Recurrent (returning payers), or a mix of both OneOffAndRecurrent.
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.requestedMerchantProfileUpdates ● [RequestMerchantProfileUpdate!] deprecated list object
No longer supported
Updates Requested associated
MerchantProfile.requestMerchantProfileUpdate ● RequestMerchantProfileUpdate object
Update Requested associated
MerchantProfile.socialNetwork ● String deprecated scalar
use socialNetworkUrl instead
The URL of the main social network of the merchant.
MerchantProfile.socialNetworkUrl ● String scalar
The URL of the main social network of the merchant.
MerchantProfile.statusInfo ● MerchantProfileStatusInfo! non-null interface
The status of the merchant profile
MerchantProfile.supportWebsite ● String deprecated scalar
use supportWebsiteUrl instead
The URL of the support website or help center of the merchant.
MerchantProfile.supportWebsiteUrl ● String scalar
The URL of the support website or help center of the merchant.
MerchantProfile.termsAndConditions ● String deprecated scalar
use termsAndConditionsUrl instead
The URL of the terms and conditions of the merchant.
MerchantProfile.termsAndConditionsUrl ● String scalar
The URL of the terms and conditions of the merchant.
MerchantProfile.updatedAt ● DateTime! non-null scalar
updated date
MerchantProfile.additionalInformation ● [AdditionalInformation!]! non-null union
Additional information about the merchant profile
Returned By
merchantProfile query
Member Of
CardInMerchant object ● CardMerchantPayment object ● CardMerchantPaymentMethod object ● CheckMerchantPayment object ● CheckMerchantPaymentMethod object ● CheckTransaction object ● DisableMerchantProfileSuccessPayload object ● InPersonCardMerchantPaymentMethod object ● InternalDirectDebitB2BMerchantPaymentMethod object ● InternalDirectDebitStandardMerchantPaymentMethod object ● InternalDirectDebitTransaction object ● MerchantPayment interface ● MerchantPaymentLink object ● MerchantPaymentMethod interface ● MerchantProfileEdge object ● RequestMerchantPaymentMethodsSuccessPayload object ● RequestMerchantProfileSuccessPayload object ● RequestMerchantProfileUpdateSuccessPayload object ● SepaDirectDebitB2BMerchantPaymentMethod object ● SepaDirectDebitCoreMerchantPaymentMethod object ● SepaDirectDebitMerchantPayment object ● SEPADirectDebitTransaction object