GraphQL API Reference

API Endpoints

https://staging.kronor.io/v1/graphql

Queries

`version`

Response

Returns a String!

Example

Query

query version {
  version
}

Response

{"data": {"version": "xyz789"}}

Mutations

`addAcquirer`

Description

Add acquirer to be used with a payment method

Response

Returns an AddAcquirerResult!

Arguments

Name	Description
`acquirerInfo` - `AddAcquirerInput!`

Example

Query

mutation addAcquirer($acquirerInfo: AddAcquirerInput!) {
  addAcquirer(acquirerInfo: $acquirerInfo) {
    acquirerId
  }
}

Variables

{"acquirerInfo": AddAcquirerInput}

Response

{"data": {"addAcquirer": {"acquirerId": bigint}}}

Mutations

`addNewUser`

Description

Add new users.

Response

Returns an AddNewUserResult!

Arguments

Name	Description
`add` - `AddUserInput!`

Example

Query

mutation addNewUser($add: AddUserInput!) {
  addNewUser(add: $add) {
    usersAdded
  }
}

Variables

{"add": AddUserInput}

Response

{"data": {"addNewUser": {"usersAdded": 987}}}

Mutations

`addSessionDeviceInformation`

Description

Set customer device information for a given payment session.

Response

Returns an AddSessionDeviceInformationResult!

Arguments

Name	Description
`info` - `AddSessionDeviceInformationInput!`

Example

Query

mutation addSessionDeviceInformation($info: AddSessionDeviceInformationInput!) {
  addSessionDeviceInformation(info: $info) {
    result
  }
}

Variables

{"info": AddSessionDeviceInformationInput}

Response

{"data": {"addSessionDeviceInformation": {"result": true}}}

Mutations

`adjustInvoiceDueDate`

Description

Adjust the due date of an invoice.

Response

Returns an InvoiceDueDateAdjustResult!

Arguments

Name	Description
`adjustment` - `InvoiceDueDateAdjustInput!`

Example

Query

mutation adjustInvoiceDueDate($adjustment: InvoiceDueDateAdjustInput!) {
  adjustInvoiceDueDate(adjustment: $adjustment) {
    dueDate
    returnId
  }
}

Variables

{"adjustment": InvoiceDueDateAdjustInput}

Response

{
  "data": {
    "adjustInvoiceDueDate": {
      "dueDate": "abc123",
      "returnId": 123
    }
  }
}

Mutations

`authorizeAisSession`

Description

Authorize an AIS session

Response

Returns an AuthorizeAisSessionResult!

Arguments

Name	Description
`payload` - `AuthorizeAisSessionInput!`

Example

Query

mutation authorizeAisSession($payload: AuthorizeAisSessionInput!) {
  authorizeAisSession(payload: $payload) {
    success
  }
}

Variables

{"payload": AuthorizeAisSessionInput}

Response

{"data": {"authorizeAisSession": {"success": true}}}

Mutations

`authorizeInstalments`

Description

Authorize payment for future instalments

Response

Returns an AuthorizeInstalmentsResult!

Arguments

Name	Description
`instalment` - `AuthorizeInstalmentsInput!`

Example

Query

mutation authorizeInstalments($instalment: AuthorizeInstalmentsInput!) {
  authorizeInstalments(instalment: $instalment) {
    waitToken
  }
}

Variables

{"instalment": AuthorizeInstalmentsInput}

Response

{
  "data": {
    "authorizeInstalments": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`bankIdCancel`

Description

Cancel the bankId authentication.

Response

Returns a BankIdCancelResult!

Arguments

Name	Description
`bankId` - `BankIdCancelInput!`

Example

Query

mutation bankIdCancel($bankId: BankIdCancelInput!) {
  bankIdCancel(bankId: $bankId) {
    status
  }
}

Variables

{"bankId": BankIdCancelInput}

Response

{"data": {"bankIdCancel": {"status": true}}}

Mutations

`blockCustomer`

Description

Block a customer from making new purchases

Response

Returns [BlockCustomerResult!]!

Arguments

Name	Description
`block` - `BlockCustomerInput!`

Example

Query

mutation blockCustomer($block: BlockCustomerInput!) {
  blockCustomer(block: $block) {
    customerEmail
    customerId
    customerSsn
    merchantId
  }
}

Variables

{"block": BlockCustomerInput}

Response

{
  "data": {
    "blockCustomer": [
      {
        "customerEmail": "abc123",
        "customerId": 123,
        "customerSsn": "abc123",
        "merchantId": 987
      }
    ]
  }
}

Mutations

`blockCustomerById`

Description

Block a customer from making new purchases by customer id

Response

Returns a BlockCustomerResult!

Arguments

Name	Description
`block` - `BlockCustomerByIdInput!`

Example

Query

mutation blockCustomerById($block: BlockCustomerByIdInput!) {
  blockCustomerById(block: $block) {
    customerEmail
    customerId
    customerSsn
    merchantId
  }
}

Variables

{"block": BlockCustomerByIdInput}

Response

{
  "data": {
    "blockCustomerById": {
      "customerEmail": "xyz789",
      "customerId": 987,
      "customerSsn": "abc123",
      "merchantId": 987
    }
  }
}

Mutations

`blockToken`

Description

Blocks the specified token, after a successful operation, the given token will no longer work.

Response

Returns a BlockTokenResult!

Arguments

Name	Description
`token` - `BlockTokenInput!`

Example

Query

mutation blockToken($token: BlockTokenInput!) {
  blockToken(token: $token) {
    tokensBlocked
  }
}

Variables

{"token": BlockTokenInput}

Response

{"data": {"blockToken": {"tokensBlocked": 987}}}

Mutations

`cancelPayment`

Description

Cancel payment request.

Response

Returns a PaymentCancelResult!

Arguments

Name	Description
`cancel` - `PaymentCancelInput!`

Example

Query

mutation cancelPayment($cancel: PaymentCancelInput!) {
  cancelPayment(cancel: $cancel) {
    waitToken
  }
}

Variables

{"cancel": PaymentCancelInput}

Response

{
  "data": {
    "cancelPayment": {"waitToken": "xyz789"}
  }
}

Mutations

`cancelSwishPayment`

Description

Cancel payment request made using newSwishPayment.

Response

Returns a SwishPaymentCancelResult!

Arguments

Name	Description
`pay` - `SwishPaymentCancelInput!`

Example

Query

mutation cancelSwishPayment($pay: SwishPaymentCancelInput!) {
  cancelSwishPayment(pay: $pay) {
    waitToken
  }
}

Variables

{"pay": SwishPaymentCancelInput}

Response

{
  "data": {
    "cancelSwishPayment": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`capturePayPalPayment`

Description

Capture PayPal payment

Response

Returns a CapturePayPalPaymentResult!

Arguments

Name	Description
`pay` - `CapturePayPalPaymentInput!`

Example

Query

mutation capturePayPalPayment($pay: CapturePayPalPaymentInput!) {
  capturePayPalPayment(pay: $pay) {
    paymentId
  }
}

Variables

{"pay": CapturePayPalPaymentInput}

Response

{
  "data": {
    "capturePayPalPayment": {
      "paymentId": "abc123"
    }
  }
}

Mutations

`capturePaymentAll`

Description

Fully capture a payment and consider it paid, refund the user any remaining pre-authorized amount.

Response

Returns a PaymentCaptureResult!

Arguments

Name	Description
`capture` - `PaymentCaptureAllInput!`

Example

Query

mutation capturePaymentAll($capture: PaymentCaptureAllInput!) {
  capturePaymentAll(capture: $capture) {
    captureId
    captureTransactionId
  }
}

Variables

{"capture": PaymentCaptureAllInput}

Response

{
  "data": {
    "capturePaymentAll": {
      "captureId": bigint,
      "captureTransactionId": "abc123"
    }
  }
}

Mutations

`deleteOrganizationWebhookUrl`

Description

Delete a webhook URL

Response

Returns a DeleteOrganizationWebhookUrlResult!

Arguments

Name	Description
`deleteOrganizationWebhookUrl` - `DeleteOrganizationWebhookUrlInput!`

Example

Query

mutation deleteOrganizationWebhookUrl($deleteOrganizationWebhookUrl: DeleteOrganizationWebhookUrlInput!) {
  deleteOrganizationWebhookUrl(deleteOrganizationWebhookUrl: $deleteOrganizationWebhookUrl) {
    found
  }
}

Variables

{
  "deleteOrganizationWebhookUrl": DeleteOrganizationWebhookUrlInput
}

Response

{"data": {"deleteOrganizationWebhookUrl": {"found": false}}}

Mutations

`deleteWebhookUrl`

Description

Delete a webhook URL

Response

Returns a DeleteWebhookUrlResult!

Arguments

Name	Description
`deleteWebhookUrl` - `DeleteWebhookUrlInput!`

Example

Query

mutation deleteWebhookUrl($deleteWebhookUrl: DeleteWebhookUrlInput!) {
  deleteWebhookUrl(deleteWebhookUrl: $deleteWebhookUrl) {
    found
  }
}

Variables

{"deleteWebhookUrl": DeleteWebhookUrlInput}

Response

{"data": {"deleteWebhookUrl": {"found": true}}}

Mutations

`editPurchase`

Description

Edit a purchase that hasn't been captured yet.

Response

Returns a PurchaseEditResult!

Arguments

Name	Description
`edit` - `PurchaseEditInput!`

Example

Query

mutation editPurchase($edit: PurchaseEditInput!) {
  editPurchase(edit: $edit) {
    success
  }
}

Variables

{"edit": PurchaseEditInput}

Response

{"data": {"editPurchase": {"success": true}}}

Mutations

`editPurchaseAddress`

Description

Edit the purchase billing or shipping address.

Response

Returns a PurchaseEditAddressResult!

Arguments

Name	Description
`edit` - `PurchaseEditAddressInput!`

Example

Query

mutation editPurchaseAddress($edit: PurchaseEditAddressInput!) {
  editPurchaseAddress(edit: $edit) {
    customerId
  }
}

Variables

{"edit": PurchaseEditAddressInput}

Response

{"data": {"editPurchaseAddress": {"customerId": bigint}}}

Mutations

`editUserRole`

Description

Edit the role of users.

Response

Returns an EditUserResult!

Arguments

Name	Description
`edit` - `EditUserInput!`

Example

Query

mutation editUserRole($edit: EditUserInput!) {
  editUserRole(edit: $edit) {
    usersChanged
  }
}

Variables

{"edit": EditUserInput}

Response

{"data": {"editUserRole": {"usersChanged": 987}}}

Mutations

`generateAcquirerTransactionsCSV`

Description

Generates a new CSV file containing payment requests.

Response

Returns an GenerateAcquirerTransactionsCSVResult!

Arguments

Name	Description
`generate` - `GenerateAcquirerTransactionsCSVInput!`

Example

Query

mutation generateAcquirerTransactionsCSV($generate: GenerateAcquirerTransactionsCSVInput!) {
  generateAcquirerTransactionsCSV(generate: $generate) {
    acquirerTransactionsCsvId
  }
}

Variables

{"generate": GenerateAcquirerTransactionsCSVInput}

Response

{
  "data": {
    "generateAcquirerTransactionsCSV": {
      "acquirerTransactionsCsvId": bigint
    }
  }
}

Mutations

`generateAcquirerTransactionsCSVLink`

Description

Generates a new link to an existing CSV file containing Acquirer transactions.

Response

Returns an GenerateAcquirerTransactionsCSVLinkResult!

Arguments

Name	Description
`generate` - `GenerateAcquirerTransactionsCSVLinkInput!`

Example

Query

mutation generateAcquirerTransactionsCSVLink($generate: GenerateAcquirerTransactionsCSVLinkInput!) {
  generateAcquirerTransactionsCSVLink(generate: $generate) {
    id
  }
}

Variables

{"generate": GenerateAcquirerTransactionsCSVLinkInput}

Response

{
  "data": {
    "generateAcquirerTransactionsCSVLink": {"id": bigint}
  }
}

Mutations

`generateAisTransactionReport`

Description

Generate AIS transactions report.

Response

Returns a GenerateAisTransactionReportResult!

Arguments

Name	Description
`report` - `GenerateAisTransactionReportInput!`

Example

Query

mutation generateAisTransactionReport($report: GenerateAisTransactionReportInput!) {
  generateAisTransactionReport(report: $report) {
    success
  }
}

Variables

{"report": GenerateAisTransactionReportInput}

Response

{"data": {"generateAisTransactionReport": {"success": true}}}

Mutations

`generatePaymentRequestsCSV`

Description

Generates a new CSV file containing payment requests.

Response

Returns an GeneratePaymentRequestCSVResult!

Arguments

Name	Description
`generate` - `GeneratePaymentRequestCSVInput!`

Example

Query

mutation generatePaymentRequestsCSV($generate: GeneratePaymentRequestCSVInput!) {
  generatePaymentRequestsCSV(generate: $generate) {
    waitToken
  }
}

Variables

{"generate": GeneratePaymentRequestCSVInput}

Response

{
  "data": {
    "generatePaymentRequestsCSV": {"waitToken": bigint}
  }
}

Mutations

`generatePaymentsCSV`

Description

Generates a new CSV file containing payments.

Response

Returns an GeneratePaymentCSVResult!

Arguments

Name	Description
`generate` - `GeneratePaymentCSVInput!`

Example

Query

mutation generatePaymentsCSV($generate: GeneratePaymentCSVInput!) {
  generatePaymentsCSV(generate: $generate) {
    waitToken
  }
}

Variables

{"generate": GeneratePaymentCSVInput}

Response

{"data": {"generatePaymentsCSV": {"waitToken": bigint}}}

Mutations

`generatePurchasesCSV`

Description

Generates a new CSV file containing purchases.

Response

Returns an GeneratePurchaseCSVResult!

Arguments

Name	Description
`generate` - `GeneratePurchaseCSVInput!`

Example

Query

mutation generatePurchasesCSV($generate: GeneratePurchaseCSVInput!) {
  generatePurchasesCSV(generate: $generate) {
    waitToken
  }
}

Variables

{"generate": GeneratePurchaseCSVInput}

Response

{"data": {"generatePurchasesCSV": {"waitToken": bigint}}}

Mutations

`generateReconciliationCSV`

Description

Generates a new CSV file containing payments reconciliation.

Response

Returns an GenerateReconciliationCSVResult!

Arguments

Name	Description
`generate` - `GenerateReconciliationCSVInput!`

Example

Query

mutation generateReconciliationCSV($generate: GenerateReconciliationCSVInput!) {
  generateReconciliationCSV(generate: $generate) {
    waitToken
  }
}

Variables

{"generate": GenerateReconciliationCSVInput}

Response

{
  "data": {
    "generateReconciliationCSV": {"waitToken": bigint}
  }
}

Mutations

`generateReport`

Description

Generate settlement and transaction report.

Response

Returns a GenerateReportResult!

Arguments

Name	Description
`report` - `GenerateReportInput!`

Example

Query

mutation generateReport($report: GenerateReportInput!) {
  generateReport(report: $report) {
    waitToken
  }
}

Variables

{"report": GenerateReportInput}

Response

{"data": {"generateReport": {"waitToken": 123}}}

Mutations

`getDisputeFileDownloadLink`

Description

Get a dispute file link for the user to download it.

Response

Returns a GetDisputeFileDownloadLinkResult!

Arguments

Name	Description
`info` - `GetDisputeFileDownloadLinkInput!`

Example

Query

mutation getDisputeFileDownloadLink($info: GetDisputeFileDownloadLinkInput!) {
  getDisputeFileDownloadLink(info: $info) {
    disputeFileUploadId
  }
}

Variables

{"info": GetDisputeFileDownloadLinkInput}

Response

{
  "data": {
    "getDisputeFileDownloadLink": {
      "disputeFileUploadId": "abc123"
    }
  }
}

Mutations

`getReepayCheckoutEvents`

Description

Get events from the reepay checkout modal

Response

Returns a GetReepayCheckoutEventsResult!

Arguments

Name	Description
`paymentInfo` - `GetReepayCheckoutEventsInput!`

Example

Query

mutation getReepayCheckoutEvents($paymentInfo: GetReepayCheckoutEventsInput!) {
  getReepayCheckoutEvents(paymentInfo: $paymentInfo) {
    waitToken
  }
}

Variables

{"paymentInfo": GetReepayCheckoutEventsInput}

Response

{
  "data": {
    "getReepayCheckoutEvents": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`log`

Description

Log information about various stages of the payment component.

Response

Returns a LogResult!

Arguments

Name	Description
`info` - `LogInput!`

Example

Query

mutation log($info: LogInput!) {
  log(info: $info) {
    status
  }
}

Variables

{"info": LogInput}

Response

{"data": {"log": {"status": "xyz789"}}}

Mutations

`newBankIdInit`

Description

Initialize Strong Customer Authentication (BankId)

Response

Returns a BankIdInitResult!

Arguments

Name	Description
`bankId` - `BankIdInitInput!`

Example

Query

mutation newBankIdInit($bankId: BankIdInitInput!) {
  newBankIdInit(bankId: $bankId) {
    failureUrl
    id
    redirectDomain
    successUrl
  }
}

Variables

{"bankId": BankIdInitInput}

Response

{
  "data": {
    "newBankIdInit": {
      "failureUrl": "xyz789",
      "id": "abc123",
      "redirectDomain": "abc123",
      "successUrl": "xyz789"
    }
  }
}

Mutations

`newBankTransferPayment`

Description

Create a new payment request via bank transfer

Response

Returns a BankTransferPaymentResult!

Arguments

Name	Description
`pay` - `BankTransferPaymentInput!`

Example

Query

mutation newBankTransferPayment($pay: BankTransferPaymentInput!) {
  newBankTransferPayment(pay: $pay) {
    paymentRequestId
  }
}

Variables

{"pay": BankTransferPaymentInput}

Response

{
  "data": {
    "newBankTransferPayment": {
      "paymentRequestId": "abc123"
    }
  }
}

Mutations

`newCreditCardPayment`

Description

Create a new payment request to receive money via credit card

Response

Returns a CreditCardPaymentResult!

Arguments

Name	Description
`pay` - `CreditCardPaymentInput!`

Example

Query

mutation newCreditCardPayment($pay: CreditCardPaymentInput!) {
  newCreditCardPayment(pay: $pay) {
    authToken
    gateway
    waitToken
  }
}

Variables

{"pay": CreditCardPaymentInput}

Response

{
  "data": {
    "newCreditCardPayment": {
      "authToken": "abc123",
      "gateway": "abc123",
      "waitToken": "xyz789"
    }
  }
}

Mutations

`newInvoiceNote`

Description

Add a note to an invoice.

Response

Returns an InvoiceNoteResult!

Arguments

Name	Description
`note` - `InvoiceNoteInput!`

Example

Query

mutation newInvoiceNote($note: InvoiceNoteInput!) {
  newInvoiceNote(note: $note) {
    resultingNoteId
  }
}

Variables

{"note": InvoiceNoteInput}

Response

{"data": {"newInvoiceNote": {"resultingNoteId": bigint}}}

Mutations

`newItemDiscount`

Description

Add discount for a captured item in an invoice.

Response

Returns an ItemDiscountResult!

Arguments

Name	Description
`discount` - `ItemDiscountInput!`

Example

Query

mutation newItemDiscount($discount: ItemDiscountInput!) {
  newItemDiscount(discount: $discount) {
    captureItemDiscountIds
  }
}

Variables

{"discount": ItemDiscountInput}

Response

{"data": {"newItemDiscount": {"captureItemDiscountIds": [123]}}}

Mutations

`newMobilePayPayment`

Description

Create a new payment request to receive money via MobilePay, available only in Denmark and Finland.

Response

Returns a MobilePayPaymentResult!

Arguments

Name	Description
`pay` - `MobilePayPaymentInput!`

Example

Query

mutation newMobilePayPayment($pay: MobilePayPaymentInput!) {
  newMobilePayPayment(pay: $pay) {
    waitToken
  }
}

Variables

{"pay": MobilePayPaymentInput}

Response

{
  "data": {
    "newMobilePayPayment": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`newP24Payment`

Description

Create a new payment request to receive money via P24

Response

Returns a P24PaymentResult!

Arguments

Name	Description
`pay` - `P24PaymentInput!`

Example

Query

mutation newP24Payment($pay: P24PaymentInput!) {
  newP24Payment(pay: $pay) {
    paymentId
  }
}

Variables

{"pay": P24PaymentInput}

Response

{
  "data": {
    "newP24Payment": {"paymentId": "xyz789"}
  }
}

Mutations

`newPayPalPayment`

Description

Create a new payment request to receive money via PayPal

Response

Returns a PayPalPaymentResult!

Arguments

Name	Description
`pay` - `PayPalPaymentInput!`

Example

Query

mutation newPayPalPayment($pay: PayPalPaymentInput!) {
  newPayPalPayment(pay: $pay) {
    paymentId
  }
}

Variables

{"pay": PayPalPaymentInput}

Response

{
  "data": {
    "newPayPalPayment": {
      "paymentId": "abc123"
    }
  }
}

Mutations

`newPaymentCapture`

Description

Capture a payment.

Response

Returns a PaymentCaptureResult!

Arguments

Name	Description
`capture` - `PaymentCaptureInput!`

Example

Query

mutation newPaymentCapture($capture: PaymentCaptureInput!) {
  newPaymentCapture(capture: $capture) {
    captureId
    captureTransactionId
  }
}

Variables

{"capture": PaymentCaptureInput}

Response

{
  "data": {
    "newPaymentCapture": {
      "captureId": bigint,
      "captureTransactionId": "xyz789"
    }
  }
}

Mutations

`newPaymentSession`

Description

Create a new payment session to start a new stand alone payment. The token from the session can be used in subsequent calls for the payment flow.

Response

Returns a PaymentSessionResult!

Arguments

Name	Description
`payment` - `PaymentSessionInput!`

Example

Query

mutation newPaymentSession($payment: PaymentSessionInput!) {
  newPaymentSession(payment: $payment) {
    token
  }
}

Variables

{"payment": PaymentSessionInput}

Response

{
  "data": {
    "newPaymentSession": {"token": "xyz789"}
  }
}

Mutations

`newPaymentSessionWithReferenceCheck`

Description

Create a new payment session to start a new payment. The token from the session can be used in subsequent calls for the payment flow.

This mutation will also check if any other payment session with the same merchantReference exists and if so, it will return the token from that session, provided that the session is not expired, and the same amount is requested.

Response

Returns a PaymentSessionWithReferenceCheckResult!

Arguments

Name	Description
`payment` - `PaymentSessionWithReferenceCheckInput!`

Example

Query

mutation newPaymentSessionWithReferenceCheck($payment: PaymentSessionWithReferenceCheckInput!) {
  newPaymentSessionWithReferenceCheck(payment: $payment) {
    paymentId
    paymentTransactionId
    token
  }
}

Variables

{"payment": PaymentSessionWithReferenceCheckInput}

Response

{
  "data": {
    "newPaymentSessionWithReferenceCheck": {
      "paymentId": "xyz789",
      "paymentTransactionId": "xyz789",
      "token": "xyz789"
    }
  }
}

Mutations

`newPurchaseCapture`

Description

Capture a partial or complete purchase.

Response

Returns a PurchaseCaptureResult!

Arguments

Name	Description
`capture` - `PurchaseCaptureInput!`

Example

Query

mutation newPurchaseCapture($capture: PurchaseCaptureInput!) {
  newPurchaseCapture(capture: $capture) {
    captureId
  }
}

Variables

{"capture": PurchaseCaptureInput}

Response

{"data": {"newPurchaseCapture": {"captureId": bigint}}}

Mutations

`newPurchaseCaptureAll`

Description

Capture a complete purchase.

Response

Returns a PurchaseCaptureAllResult!

Arguments

Name	Description
`capture` - `PurchaseCaptureAllInput!`

Example

Query

mutation newPurchaseCaptureAll($capture: PurchaseCaptureAllInput!) {
  newPurchaseCaptureAll(capture: $capture) {
    captureId
  }
}

Variables

{"capture": PurchaseCaptureAllInput}

Response

{"data": {"newPurchaseCaptureAll": {"captureId": bigint}}}

Mutations

`newPurchaseCaptureAllBatch`

Description

Capture multiple complete purchases.

Response

Returns a PurchaseCaptureAllBatchResult!

Arguments

Name	Description
`capture` - `PurchaseCaptureAllBatchInput!`

Example

Query

mutation newPurchaseCaptureAllBatch($capture: PurchaseCaptureAllBatchInput!) {
  newPurchaseCaptureAllBatch(capture: $capture) {
    waitToken
  }
}

Variables

{"capture": PurchaseCaptureAllBatchInput}

Response

{
  "data": {
    "newPurchaseCaptureAllBatch": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`newPurchaseCaptureAllRange`

Description

Capture multiple purchases with a date range.

Response

Returns a PurchaseCaptureAllRangeResult!

Arguments

Name	Description
`capture` - `PurchaseCaptureAllRangeInput!`

Example

Query

mutation newPurchaseCaptureAllRange($capture: PurchaseCaptureAllRangeInput!) {
  newPurchaseCaptureAllRange(capture: $capture) {
    waitToken
  }
}

Variables

{"capture": PurchaseCaptureAllRangeInput}

Response

{
  "data": {
    "newPurchaseCaptureAllRange": {
      "waitToken": "xyz789"
    }
  }
}

Mutations

`newPurchaseCaptureWithItemReferences`

Description

Capture items in a purchase with their reference.

Response

Returns a PurchaseCaptureWithItemReferencesResult!

Arguments

Name	Description
`capture` - `PurchaseCaptureWithItemReferencesInput!`

Example

Query

mutation newPurchaseCaptureWithItemReferences($capture: PurchaseCaptureWithItemReferencesInput!) {
  newPurchaseCaptureWithItemReferences(capture: $capture) {
    captureId
  }
}

Variables

{"capture": PurchaseCaptureWithItemReferencesInput}

Response

{
  "data": {
    "newPurchaseCaptureWithItemReferences": {
      "captureId": bigint
    }
  }
}

Mutations

`newPurchaseOrderWithInstalments`

Description

create a purchase intent that will be paid by the customer in instalments.

Response

Returns a PurchaseOrderWithInstalmentsResult!

Arguments

Name	Description
`purchase` - `PurchaseOrderWithInstalmentsInput!`

Example

Query

mutation newPurchaseOrderWithInstalments($purchase: PurchaseOrderWithInstalmentsInput!) {
  newPurchaseOrderWithInstalments(purchase: $purchase) {
    id
    waitToken
  }
}

Variables

{"purchase": PurchaseOrderWithInstalmentsInput}

Response

{
  "data": {
    "newPurchaseOrderWithInstalments": {
      "id": "xyz789",
      "waitToken": "abc123"
    }
  }
}

Mutations

`newPurchaseOrderWithInvoice`

Description

create a purchase intent.

Response

Returns a PurchaseOrderWithInvoiceResult!

Arguments

Name	Description
`purchase` - `PurchaseOrderWithInvoiceInput!`

Example

Query

mutation newPurchaseOrderWithInvoice($purchase: PurchaseOrderWithInvoiceInput!) {
  newPurchaseOrderWithInvoice(purchase: $purchase) {
    id
    waitToken
  }
}

Variables

{"purchase": PurchaseOrderWithInvoiceInput}

Response

{
  "data": {
    "newPurchaseOrderWithInvoice": {
      "id": "abc123",
      "waitToken": "xyz789"
    }
  }
}

Mutations

`newPurchaseReturn`

Description

Return items.

Response

Returns a PurchaseReturnResult!

Arguments

Name	Description
`return` - `PurchaseReturnInput!`

Example

Query

mutation newPurchaseReturn($return: PurchaseReturnInput!) {
  newPurchaseReturn(return: $return) {
    returnId
  }
}

Variables

{"return": PurchaseReturnInput}

Response

{"data": {"newPurchaseReturn": {"returnId": bigint}}}

Mutations

`newPurchaseReturnAll`

Description

Return a complete purchase.

Response

Returns a PurchaseReturnAllResult!

Arguments

Name	Description
`return` - `PurchaseReturnAllInput!`

Example

Query

mutation newPurchaseReturnAll($return: PurchaseReturnAllInput!) {
  newPurchaseReturnAll(return: $return) {
    returnId
  }
}

Variables

{"return": PurchaseReturnAllInput}

Response

{"data": {"newPurchaseReturnAll": {"returnId": bigint}}}

Mutations

`newScaSession`

Description

Create a new SCA session to obtain a JWT that can initiate SCA checks.

Response

Returns a NewScaSessionResult!

Arguments

Name	Description
`session` - `NewScaSessionInput!`

Example

Query

mutation newScaSession($session: NewScaSessionInput!) {
  newScaSession(session: $session) {
    id
    token
  }
}

Variables

{"session": NewScaSessionInput}

Response

{
  "data": {
    "newScaSession": {
      "id": "abc123",
      "token": "xyz789"
    }
  }
}

Mutations

`newSwishPayment`

Description

Create a new payment request to receive money via swish

Response

Returns a SwishPaymentResult!

Arguments

Name	Description
`pay` - `SwishPaymentInput!`

Example

Query

mutation newSwishPayment($pay: SwishPaymentInput!) {
  newSwishPayment(pay: $pay) {
    waitToken
  }
}

Variables

{"pay": SwishPaymentInput}

Response

{
  "data": {
    "newSwishPayment": {
      "waitToken": "xyz789"
    }
  }
}

Mutations

`newVippsPayment`

Description

Create a new payment request to receive money via Vipps, available only in Norway.

Response

Returns a VippsPaymentResult!

Arguments

Name	Description
`pay` - `VippsPaymentInput!`

Example

Query

mutation newVippsPayment($pay: VippsPaymentInput!) {
  newVippsPayment(pay: $pay) {
    waitToken
  }
}

Variables

{"pay": VippsPaymentInput}

Response

{
  "data": {
    "newVippsPayment": {
      "waitToken": "xyz789"
    }
  }
}

Mutations

`onboardPayPalMerchant`

Description

Onboard a merchant on PayPal

Response

Returns a PayPalMerchantOnboardingResult!

Arguments

Name	Description
`merchant` - `PayPalMerchantOnboardingInput!`

Example

Query

mutation onboardPayPalMerchant($merchant: PayPalMerchantOnboardingInput!) {
  onboardPayPalMerchant(merchant: $merchant) {
    trackingId
  }
}

Variables

{"merchant": PayPalMerchantOnboardingInput}

Response

{
  "data": {
    "onboardPayPalMerchant": {
      "trackingId": "abc123"
    }
  }
}

Mutations

`p24Notification`

Description

P24 notification payload

Response

Returns a P24NotificationResult!

Arguments

Name	Description
`payload` - `P24NotificationInput!`

Example

Query

mutation p24Notification($payload: P24NotificationInput!) {
  p24Notification(payload: $payload) {
    status
  }
}

Variables

{"payload": P24NotificationInput}

Response

{
  "data": {
    "p24Notification": {"status": "abc123"}
  }
}

Mutations

`p24RefundNotification`

Description

P24 refund notification payload

Response

Returns a P24RefundNotificationResult!

Arguments

Name	Description
`payload` - `P24RefundNotificationInput!`

Example

Query

mutation p24RefundNotification($payload: P24RefundNotificationInput!) {
  p24RefundNotification(payload: $payload) {
    status
  }
}

Variables

{"payload": P24RefundNotificationInput}

Response

{
  "data": {
    "p24RefundNotification": {
      "status": "xyz789"
    }
  }
}

Mutations

`payInstalment`

Description

Pay the next instalment

Response

Returns a PayInstalmentResult!

Arguments

Name	Description
`instalment` - `PayInstalmentInput!`

Example

Query

mutation payInstalment($instalment: PayInstalmentInput!) {
  payInstalment(instalment: $instalment) {
    token
  }
}

Variables

{"instalment": PayInstalmentInput}

Response

{
  "data": {
    "payInstalment": {"token": "abc123"}
  }
}

Mutations

`prepareDisputeFileUpload`

Description

Prepare file upload for disputes.

Response

Returns a PrepareDisputeFileUploadResult!

Arguments

Name	Description
`info` - `PrepareDisputeFileUploadInput!`

Example

Query

mutation prepareDisputeFileUpload($info: PrepareDisputeFileUploadInput!) {
  prepareDisputeFileUpload(info: $info) {
    disputeFileUploadId
  }
}

Variables

{"info": PrepareDisputeFileUploadInput}

Response

{
  "data": {
    "prepareDisputeFileUpload": {
      "disputeFileUploadId": "abc123"
    }
  }
}

Mutations

`purchaseCancel`

Description

Cancel a purchase that might already have partial captures.

Response

Returns a PurchaseCancelResult!

Arguments

Name	Description
`cancel` - `PurchaseCancelInput!`

Example

Query

mutation purchaseCancel($cancel: PurchaseCancelInput!) {
  purchaseCancel(cancel: $cancel) {
    result
  }
}

Variables

{"cancel": PurchaseCancelInput}

Response

{"data": {"purchaseCancel": {"result": false}}}

Mutations

`purchaseOrderCancel`

Description

Cancel a purchase order.

Response

Returns a PurchaseOrderCancelResult!

Arguments

Name	Description
`cancel` - `PurchaseOrderCancelInput!`

Example

Query

mutation purchaseOrderCancel($cancel: PurchaseOrderCancelInput!) {
  purchaseOrderCancel(cancel: $cancel) {
    result
  }
}

Variables

{"cancel": PurchaseOrderCancelInput}

Response

{"data": {"purchaseOrderCancel": {"result": false}}}

Mutations

`reepayWebhook`

Description

Mutation used to translate reepay webhook rest calls

Response

Returns a ReepayWebhookResult!

Arguments

Name	Description
`webhook` - `ReepayWebhookInput!`

Example

Query

mutation reepayWebhook($webhook: ReepayWebhookInput!) {
  reepayWebhook(webhook: $webhook) {
    waitToken
  }
}

Variables

{"webhook": ReepayWebhookInput}

Response

{
  "data": {
    "reepayWebhook": {"waitToken": "abc123"}
  }
}

Mutations

`refreshAisAccountBalance`

Description

Fetch account balance

Response

Returns a RefreshAisAccountBalanceResult!

Arguments

Name	Description
`payload` - `RefreshAisAccountBalanceInput!`

Example

Query

mutation refreshAisAccountBalance($payload: RefreshAisAccountBalanceInput!) {
  refreshAisAccountBalance(payload: $payload) {
    result
  }
}

Variables

{"payload": RefreshAisAccountBalanceInput}

Response

{"data": {"refreshAisAccountBalance": {"result": false}}}

Mutations

`refundPayment`

Description

Refund a payment

Response

Returns a RefundPaymentResult!

Arguments

Name	Description
`refund` - `RefundPaymentInput!`

Example

Query

mutation refundPayment($refund: RefundPaymentInput!) {
  refundPayment(refund: $refund) {
    refundTransactionId
    waitToken
  }
}

Variables

{"refund": RefundPaymentInput}

Response

{
  "data": {
    "refundPayment": {
      "refundTransactionId": "xyz789",
      "waitToken": "abc123"
    }
  }
}

Mutations

`releasePayment`

Description

Release a payment that hasn't been captured yet

Response

Returns a ReleasePaymentResult!

Arguments

Name	Description
`release` - `ReleasePaymentInput!`

Example

Query

mutation releasePayment($release: ReleasePaymentInput!) {
  releasePayment(release: $release) {
    releaseId
  }
}

Variables

{"release": ReleasePaymentInput}

Response

{
  "data": {
    "releasePayment": {
      "releaseId": "abc123"
    }
  }
}

Mutations

`removeUser`

Description

Remove users.

Response

Returns a RemoveUserResult!

Arguments

Name	Description
`remove` - `RemoveUserInput!`

Example

Query

mutation removeUser($remove: RemoveUserInput!) {
  removeUser(remove: $remove) {
    usersDeleted
  }
}

Variables

{"remove": RemoveUserInput}

Response

{"data": {"removeUser": {"usersDeleted": 987}}}

Mutations

`renewNordeaKey`

Description

Start the process to renew a Nordea key that will be used to do payouts

Response

Returns a RenewNordeaKeyResult!

Arguments

Name	Description
`renew` - `RenewNordeaKeyInput!`

Example

Query

mutation renewNordeaKey($renew: RenewNordeaKeyInput!) {
  renewNordeaKey(renew: $renew) {
    nordeaKeyId
  }
}

Variables

{"renew": RenewNordeaKeyInput}

Response

{"data": {"renewNordeaKey": {"nordeaKeyId": bigint}}}

Mutations

`resendInvoiceEmail`

Description

Sends the invoice email to the customer.

Response

Returns a ResendInvoiceEmailResult!

Arguments

Name	Description
`generate` - `ResendInvoiceEmailInput!`

Example

Query

mutation resendInvoiceEmail($generate: ResendInvoiceEmailInput!) {
  resendInvoiceEmail(generate: $generate) {
    result
  }
}

Variables

{"generate": ResendInvoiceEmailInput}

Response

{"data": {"resendInvoiceEmail": {"result": false}}}

Mutations

`restartCaptureStatusCheck`

Description

Recheck refund status with payment provider.

Response

Returns a RestartCaptureStatusCheckResult!

Arguments

Name	Description
`info` - `RestartCaptureStatusCheckInput!`

Example

Query

mutation restartCaptureStatusCheck($info: RestartCaptureStatusCheckInput!) {
  restartCaptureStatusCheck(info: $info) {
    status
  }
}

Variables

{"info": RestartCaptureStatusCheckInput}

Response

{"data": {"restartCaptureStatusCheck": {"status": false}}}

Mutations

`restartPaymentStatusCheck`

Description

Recheck payment status with payment provider.

Response

Returns a RestartPaymentStatusCheckResult!

Arguments

Name	Description
`info` - `RestartPaymentStatusCheckInput!`

Example

Query

mutation restartPaymentStatusCheck($info: RestartPaymentStatusCheckInput!) {
  restartPaymentStatusCheck(info: $info) {
    status
  }
}

Variables

{"info": RestartPaymentStatusCheckInput}

Response

{"data": {"restartPaymentStatusCheck": {"status": true}}}

Mutations

`restartRefundStatusCheck`

Description

Recheck refund status with payment provider.

Response

Returns a RestartRefundStatusCheckResult!

Arguments

Name	Description
`info` - `RestartRefundStatusCheckInput!`

Example

Query

mutation restartRefundStatusCheck($info: RestartRefundStatusCheckInput!) {
  restartRefundStatusCheck(info: $info) {
    status
  }
}

Variables

{"info": RestartRefundStatusCheckInput}

Response

{"data": {"restartRefundStatusCheck": {"status": false}}}

Mutations

`revokeAisSession`

Description

Revoke an AIS session

Response

Returns a RevokeAisSessionResult!

Arguments

Name	Description
`payload` - `RevokeAisSessionInput!`

Example

Query

mutation revokeAisSession($payload: RevokeAisSessionInput!) {
  revokeAisSession(payload: $payload) {
    result
  }
}

Variables

{"payload": RevokeAisSessionInput}

Response

{"data": {"revokeAisSession": {"result": true}}}

Mutations

`scheduleCurrencyTrading`

Description

Schedule a currency trading operation.

Response

Returns a ScheduleCurrencyTradingResult!

Arguments

Name	Description
`schedule` - `ScheduleCurrencyTradingInput!`

Example

Query

mutation scheduleCurrencyTrading($schedule: ScheduleCurrencyTradingInput!) {
  scheduleCurrencyTrading(schedule: $schedule) {
    waitToken
  }
}

Variables

{"schedule": ScheduleCurrencyTradingInput}

Response

{
  "data": {
    "scheduleCurrencyTrading": {
      "waitToken": "xyz789"
    }
  }
}

Mutations

`setClearhausAcquirerInfo`

Description

Sets up clearhaus acquirer api, signing keys. Fetches account information from clearhaus and stores bin codes

Response

Returns a SetClearhausAcquirerInfoResult!

Arguments

Name	Description
`setInfo` - `SetClearhausAcquirerInfoInput!`

Example

Query

mutation setClearhausAcquirerInfo($setInfo: SetClearhausAcquirerInfoInput!) {
  setClearhausAcquirerInfo(setInfo: $setInfo) {
    acquirerSettingId
  }
}

Variables

{"setInfo": SetClearhausAcquirerInfoInput}

Response

{
  "data": {
    "setClearhausAcquirerInfo": {
      "acquirerSettingId": bigint
    }
  }
}

Mutations

`setOrganizationWebhookUrl`

Description

Set the url that will receive organization webhook notifications

Response

Returns a SetOrganizationWebhookUrlResult!

Arguments

Name	Description
`setOrganizationWebhookUrl` - `SetOrganizationWebhookUrlInput!`

Example

Query

mutation setOrganizationWebhookUrl($setOrganizationWebhookUrl: SetOrganizationWebhookUrlInput!) {
  setOrganizationWebhookUrl(setOrganizationWebhookUrl: $setOrganizationWebhookUrl) {
    hmacSecret
    webhookUrl
  }
}

Variables

{
  "setOrganizationWebhookUrl": SetOrganizationWebhookUrlInput
}

Response

{
  "data": {
    "setOrganizationWebhookUrl": {
      "hmacSecret": "xyz789",
      "webhookUrl": "abc123"
    }
  }
}

Mutations

`setWebhookUrl`

Description

Set the url that will receive webhook notifications

Response

Returns a SetWebhookUrlResult!

Arguments

Name	Description
`setWebhookUrl` - `SetWebhookUrlInput!`

Example

Query

mutation setWebhookUrl($setWebhookUrl: SetWebhookUrlInput!) {
  setWebhookUrl(setWebhookUrl: $setWebhookUrl) {
    hmacSecret
    webhookUrl
  }
}

Variables

{"setWebhookUrl": SetWebhookUrlInput}

Response

{
  "data": {
    "setWebhookUrl": {
      "hmacSecret": "abc123",
      "webhookUrl": "xyz789"
    }
  }
}

Mutations

`startAisAuthorization`

Description

Start AIS authorization

Response

Returns a StartAisAuthorizationResult!

Arguments

Name	Description
`payload` - `StartAisAuthorizationInput!`

Example

Query

mutation startAisAuthorization($payload: StartAisAuthorizationInput!) {
  startAisAuthorization(payload: $payload) {
    waitToken
  }
}

Variables

{"payload": StartAisAuthorizationInput}

Response

{
  "data": {
    "startAisAuthorization": {
      "waitToken": "abc123"
    }
  }
}

Mutations

`swishCallback`

Description

Swish callback payload

Response

Returns a SwishCallbackResult!

Arguments

Name	Description
`payload` - `SwishCallbackInput!`

Example

Query

mutation swishCallback($payload: SwishCallbackInput!) {
  swishCallback(payload: $payload) {
    status
  }
}

Variables

{"payload": SwishCallbackInput}

Response

{
  "data": {
    "swishCallback": {"status": "abc123"}
  }
}

Mutations

`swishRefundCallback`

Description

Swish refund callback payload

Response

Returns a SwishCallbackResult!

Arguments

Name	Description
`payload` - `SwishRefundCallbackInput!`

Example

Query

mutation swishRefundCallback($payload: SwishRefundCallbackInput!) {
  swishRefundCallback(payload: $payload) {
    status
  }
}

Variables

{"payload": SwishRefundCallbackInput}

Response

{
  "data": {
    "swishRefundCallback": {
      "status": "xyz789"
    }
  }
}

Mutations

`toggleAcquirerAvailability`

Description

Enable / disable acquirer

Response

Returns a ToggleAcquirerAvailabilityResult!

Arguments

Name	Description
`acquirerInfo` - `ToggleAcquirerAvailabilityInput!`

Example

Query

mutation toggleAcquirerAvailability($acquirerInfo: ToggleAcquirerAvailabilityInput!) {
  toggleAcquirerAvailability(acquirerInfo: $acquirerInfo) {
    acquirerId
  }
}

Variables

{"acquirerInfo": ToggleAcquirerAvailabilityInput}

Response

{
  "data": {
    "toggleAcquirerAvailability": {"acquirerId": bigint}
  }
}

Mutations

`togglePaymentMethodAvailability`

Description

Turn payment methods on or off

Response

Returns a TogglePaymentMethodAvailabilityResult!

Arguments

Name	Description
`payload` - `TogglePaymentMethodAvailabilityInput!`

Example

Query

mutation togglePaymentMethodAvailability($payload: TogglePaymentMethodAvailabilityInput!) {
  togglePaymentMethodAvailability(payload: $payload) {
    enabled
  }
}

Variables

{"payload": TogglePaymentMethodAvailabilityInput}

Response

{"data": {"togglePaymentMethodAvailability": {"enabled": false}}}

Mutations

`triggerPayPalOnboardingStatusCheck`

Description

Trigger PayPal onboarding status check

Response

Returns a TriggerPayPalMerchantOnboardingResult!

Arguments

Name	Description
`merchant` - `TriggerPayPalMerchantOnboardingCheckInput!`

Example

Query

mutation triggerPayPalOnboardingStatusCheck($merchant: TriggerPayPalMerchantOnboardingCheckInput!) {
  triggerPayPalOnboardingStatusCheck(merchant: $merchant) {
    result
  }
}

Variables

{"merchant": TriggerPayPalMerchantOnboardingCheckInput}

Response

{"data": {"triggerPayPalOnboardingStatusCheck": {"result": false}}}

Mutations

`unblockCustomer`

Description

Remove a customer from the blocked list

Response

Returns an UnblockCustomerResult!

Arguments

Name	Description
`unblock` - `UnblockCustomerInput!`

Example

Query

mutation unblockCustomer($unblock: UnblockCustomerInput!) {
  unblockCustomer(unblock: $unblock) {
    affectedCustomerIds
  }
}

Variables

{"unblock": UnblockCustomerInput}

Response

{"data": {"unblockCustomer": {"affectedCustomerIds": [123]}}}

Mutations

`updateBankTransferFlow`

Description

Update the frontend flow state of a bank transfer

Response

Returns a BankTransferFlowResult!

Arguments

Name	Description
`flow` - `BankTransferFlowInput!`

Example

Query

mutation updateBankTransferFlow($flow: BankTransferFlowInput!) {
  updateBankTransferFlow(flow: $flow) {
    waitToken
  }
}

Variables

{"flow": BankTransferFlowInput}

Response

{
  "data": {
    "updateBankTransferFlow": {
      "waitToken": "xyz789"
    }
  }
}

Mutations

`updateTransactionReportAccounts`

Description

Update transaction report settings for AIS accounts

Response

Returns an UpdateTransactionReportAccountsResult!

Arguments

Name	Description
`payload` - `UpdateTransactionReportAccountsInput!`

Example

Query

mutation updateTransactionReportAccounts($payload: UpdateTransactionReportAccountsInput!) {
  updateTransactionReportAccounts(payload: $payload) {
    success
  }
}

Variables

{"payload": UpdateTransactionReportAccountsInput}

Response

{"data": {"updateTransactionReportAccounts": {"success": true}}}

Types

AcquirerDisputeFileUploadLabel

Description

The label enum for dispute file uploads

Values

Enum Value	Description
`DOCUMENTATION`	Company documentation

Example

"DOCUMENTATION"

Types

AcquirerEnum

Description

The credit card acquirers we support

Values

Enum Value	Description
`CLEARHAUS`	Clearhaus acquirer
`NETS`	Nets acquirer
`SHIFT4`	Shift4 Acquirer

Example

"CLEARHAUS"

Types

AddAcquirerInput

Description

Add this acquirer to use for the supplied payment method.

Fields

Input Field	Description
`acquirer` - `AcquirerEnum!`	Acquirer to enable
`acquirerSettingId` - `bigint!`	Acquirer id, obtained from their respective tables like tenant.clearhaus_acquirer_setting
`country` - `Country!`	Country for which to enable this acquirer
`currency` - `SupportedCurrencyEnum!`
`currentUser` - `String`	Email of the user that is making the request.
`merchantId` - `bigint!`	Id of the merchant Max length: 20.
`paymentMethod` - `PaymentRequestMethod!`	Payment Method for which this acquirer should be enabled
`scheme` - `CreditCardSchemeEnum!`	Scheme for which this acquirer should be used

Example

{
  "acquirer": "CLEARHAUS",
  "acquirerSettingId": bigint,
  "country": "AT",
  "currency": "CHF",
  "currentUser": "xyz789",
  "merchantId": bigint,
  "paymentMethod": "BANK_TRANSFER",
  "scheme": "AMEX"
}

Types

AddAcquirerResult

Description

Result of calling addAcquirer

Fields

Field Name	Description
`acquirerId` - `bigint!`	ID of acquirer added

Example

{"acquirerId": bigint}

Types

AddNewUserResult

Description

Result of the addition

Fields

Field Name	Description
`usersAdded` - `Int!`	The number of users added.

Example

{"usersAdded": 123}

Types

AddSessionDeviceInformationInput

Description

Aguments for adding device information on a device related to a payment session.

Fields

Input Field	Description
`browserName` - `String!`	The customer device browser name. Max length: 64.
`browserVersion` - `String!`	The customer device browser version. Max length: 64.
`fingerprint` - `String!`	The customer device fingerprint. Max length: 64.
`merchantId` - `bigint!`	The merchant id related to the payment session.
`osName` - `String!`	The customer device os name. Max length: 64.
`osVersion` - `String!`	The customer device os version. Max length: 64.
`paymentReference` - `String!`	Reference of payment session to associate data to.
`userAgent` - `String!`	The customer device User-Agent string. Max length: 512.

Example

{
  "browserName": "xyz789",
  "browserVersion": "abc123",
  "fingerprint": "xyz789",
  "merchantId": bigint,
  "osName": "abc123",
  "osVersion": "xyz789",
  "paymentReference": "abc123",
  "userAgent": "xyz789"
}

Types

AddSessionDeviceInformationResult

Description

The result of adding information on the device related to a payment session.

Fields

Field Name	Description
`result` - `Boolean!`	True when customer device data has been stored correctly.

Example

{"result": false}

Types

AddUserInput

Description

Add new user to merchant pool.

Fields

Input Field	Description
`addUsers` - `[AddUserSingleInput!]!`	List of users that should be added.
`currentUser` - `String!`	Email of the user that is making the request.
`organizationId` - `bigint!`	Id of the organization Max length: 20.

Example

{
  "addUsers": [AddUserSingleInput],
  "currentUser": "xyz789",
  "organizationId": bigint
}

Types

AddUserSingleInput

Description

Add new user to merchant pool.

Fields

Input Field	Description
`email` - `String!`	Email of the user, for reference.
`role` - `String!`	One of "STAFF", "ADMIN" or "SUPERADMIN", role that this user should have.
`userType` - `String!`	One of "google", "password" or "webauthn", indicates the type of user to be added. Max length: 64.

Example

{
  "email": "xyz789",
  "role": "abc123",
  "userType": "xyz789"
}

Types

AddressInput

Description

A physical address for a customer.

Fields

Input Field	Description
`careOf` - `String`	Named intermediary. Max length: 100.
`city` - `String!`	City. Max length: 100.
`country` - `Country!`	Country. Example: `SE`, `DK`, `NO`, `IS`, `FI`
`email` - `String!`	E-mail address.
`firstName` - `String!`	First name or Given Name. Max length: 100.
`lastName` - `String!`	Last name or Family Name. Max length: 100.
`phoneNumber` - `String!`	Phone number Max length: 100.
`postalCode` - `String!`	Postal Code.
`region` - `String`	State or Region. Max length: 100.
`streetAddress` - `String!`	Street address, first line. This should contain any free text as given by the customer Max length: 10000.
`streetAddress2` - `String`	Street address, second line. This should contain any free text as given by the customer Max length: 10000.
`streetName` - `String`	Street name. Do not combine with streetAddress. Should only be used if this field has been validated by the merchant and known to be correct. Max length: 10000.
`streetNumber` - `String`	Street number. Do not combine with streetAddress. Should only be used if this field has been validated by the merchant and known to be correct. Max length: 10000.
`title` - `CustomerTitle`	Title used for addressing the customer. Max length: 100.

Example

{
  "careOf": "abc123",
  "city": "abc123",
  "country": "AT",
  "email": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "phoneNumber": "xyz789",
  "postalCode": "xyz789",
  "region": "xyz789",
  "streetAddress": "abc123",
  "streetAddress2": "abc123",
  "streetName": "xyz789",
  "streetNumber": "abc123",
  "title": "Miss"
}

Types

AuthorizeAisSessionInput

Description

Arguments for authorizing a new AIS session.

Fields

Input Field	Description
`authorizationCode` - `String!`	The authorization code used to create an AIS session
`authorizationId` - `String!`	The id of an authorization process
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	The organization who is initiating the authorization. Max length: 20.

Example

{
  "authorizationCode": "xyz789",
  "authorizationId": "abc123",
  "idempotencyKey": "xyz789",
  "organizationId": bigint
}

Types

AuthorizeAisSessionResult

Description

The result of authorizing an AIS session

Fields

Field Name	Description
`success` - `Boolean!`	Whether operation succeeded to schedule an authorization

Example

{"success": true}

Types

AuthorizeInstalmentsInput

Description

Arguments for authorizing future instalments for a purchase

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`paymentMethod` - `String!`	Currently 'recurring_debit'
`purchaseId` - `bigint!`	The purchaseId is the purchase for which the customer is authorizing the instalments for. Max length: 64.
`returnUrl` - `String!`	The url to return to after the authorization is done.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "paymentMethod": "abc123",
  "purchaseId": bigint,
  "returnUrl": "abc123"
}

Types

AuthorizeInstalmentsResult

Description

The result of initiating an authorization for instalments.

Fields

Field Name	Description
`waitToken` - `String!`	Once an authorization is initialized, we will start the payment workflow. You can use this token to query the current status of the authorization and where to redirect the user next for them to authorize the payments for the instalments.

Example

{"waitToken": "xyz789"}

Types

BankIdCancelInput

Description

An intent to proceed with SCA.

Fields

Input Field	Description
`bankIdAuthId` - `String!`	BankID auth id returned from the newBankIdInit mutation Max length: 64.
`merchantId` - `bigint!`	The merchant performing the SCA.
`purchaseOrderId` - `String`	The purchaseOrderId is the purchase on which we are initiating the strong customer authentication (BankID in this case). Max length: 64.
`scaSessionId` - `String`	The id of the SCA session, leave this as null if you don't know what it is. Max length: 37.

Example

{
  "bankIdAuthId": "abc123",
  "merchantId": bigint,
  "purchaseOrderId": "xyz789",
  "scaSessionId": "xyz789"
}

Types

BankIdCancelResult

Description

The result of cancelling BankId.

Fields

Field Name	Description
`status` - `Boolean!`	Status of the result for BankIdCancel, it is always true.

Example

{"status": false}

Types

BankIdInitInput

Description

An intent to proceed with SCA.

Fields

Input Field Description

merchantId - bigint! The merchant performing the SCA.

purchaseOrderId - String

The purchase_order_id is the purchase on which we are initiating the strong customer authentication (BankID in this case).

Max length: 64.

scaSessionId - String

The id of the SCA session, leave this as null if you don't know what it is.

Max length: 37.

Example

{
  "merchantId": bigint,
  "purchaseOrderId": "xyz789",
  "scaSessionId": "abc123"
}

Types

BankIdInitResult

Description

The result of initiating BankId.

Fields

Field Name	Description
`failureUrl` - `String!`	The url to redirect to in case of failure of bankId initialization. Max length: 10000.
`id` - `String!`	A token to poll the progress of the BankID verification Max length: 10000.
`redirectDomain` - `String!`	The domain used for verifying custom success redirect URLs. Max length: 10000.
`successUrl` - `String!`	The url to redirect to in case of success of bankId signature. Max length: 10000.

Example

{
  "failureUrl": "abc123",
  "id": "xyz789",
  "redirectDomain": "abc123",
  "successUrl": "xyz789"
}

Types

BankTransferFlowInput

Description

Arguments for finalizing bank transfer payment flow

Fields

Input Field Description

idempotencyKey - String!

Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed:

Max length: 64.

merchantId - bigint!

The merchant who is finalizing the payment flow.

Max length: 64.

paymentRequestId - String! The Payment Request Id whose flow should be marked as completed

Example

{
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "paymentRequestId": "xyz789"
}

Types

BankTransferFlowResult

Description

The result of updateBankTransferFlow

Fields

Field Name	Description
`waitToken` - `String!`	This token can be used to fetch status of payment

Example

{"waitToken": "xyz789"}

Types

BankTransferPaymentInput

Description

Arguments for creating a new direct debit payment

Fields

Input Field	Description
`allowExecutionDate` - `Boolean!`	Whether setting executionDate is allowed.
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`aspspId` - `bigint!`	The ID of the ASPSP to use for this payment.
`executionDate` - `String`	A date in yyyy-mm-dd format, nullable, determines the date to execute this payment. Has to be past today's date, up to 90 days in the future.
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. It is recommended that these are unique per merchant but this is not checked anywhere a payment. Max length: 64.
`merchantReturnUrl` - `String!`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying the session this payment belongs to. Multiple attempts can be made with the same paymentReference, changing the idempotency key, but there can be only one successful payment.
`requestRedirectState` - `String!`	State string passed back as a parameter in the return URL.
`returnUrl` - `String!`	The url to return to after the payment is done. If the payment screen is opened on a separate window, customer will be redirected here on payment success or error.

Example

{
  "allowExecutionDate": true,
  "amount": 123,
  "aspspId": bigint,
  "executionDate": "xyz789",
  "expiresAt": "abc123",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReturnUrl": "xyz789",
  "message": "xyz789",
  "paymentCategory": "Account",
  "paymentReference": "xyz789",
  "requestRedirectState": "xyz789",
  "returnUrl": "xyz789"
}

Types

BankTransferPaymentResult

Description

The result of initiating a direct debit payment.

Fields

Field Name	Description
`paymentRequestId` - `String!`	Once a payment is initialized, we will start the open banking payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.

Example

{"paymentRequestId": "xyz789"}

Types

BlockCustomerByIdInput

Description

Block customer from buying from merchant by customer id

Fields

Input Field	Description
`customerId` - `bigint!`	Id of the customer
`merchantId` - `bigint!`	Id of the merchant Max length: 64.

Example

{
  "customerId": bigint,
  "merchantId": bigint
}

Types

BlockCustomerInput

Description

Block customer from buying from merchant

Fields

Input Field	Description
`customerEmail` - `String`	Email of the customer
`customerSsn` - `String`	SSN of the customer
`merchantId` - `bigint!`	Id of the merchant Max length: 64.

Example

{
  "customerEmail": "abc123",
  "customerSsn": "abc123",
  "merchantId": bigint
}

Types

BlockCustomerResult

Description

Blocked customers

Fields

Field Name	Description
`customerEmail` - `String`	Email of the customer
`customerId` - `Int`	ID of the customer
`customerSsn` - `String`	SSN of the customer
`merchantId` - `Int!`	ID of the merchant blocking the customer

Example

{
  "customerEmail": "xyz789",
  "customerId": 987,
  "customerSsn": "xyz789",
  "merchantId": 123
}

Types

BlockTokenInput

Description

Arguments to for a blockToken mutation

Fields

Input Field	Description
`merchantId` - `bigint!`	The merchant requesting for the reports.
`tokenId` - `String!`	The id of the token to block, can be found inside the token as "tid". Must be a valid UUID string.

Example

{
  "merchantId": bigint,
  "tokenId": "xyz789"
}

Types

BlockTokenResult

Description

The result of a blockToken mutation.

Fields

Field Name	Description
`tokensBlocked` - `Int!`	The number of tokens blocked in this request, if no tokens are blocked, verify that the provided uuid is correct and that the token you are trying to block is not already expired.

Example

{"tokensBlocked": 987}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CapturePayPalPaymentInput

Description

Arguments for capturing a new PayPal payment

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint!

The merchant who is initiating the payment.

Max length: 64.

paymentId - String!

The payment id of a PayPal payment, this is obtained with newPayPalPayment.

Max length: 64.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "paymentId": "abc123"
}

Types

CapturePayPalPaymentResult

Description

The result of capturing a PayPal payment.

Fields

Field Name	Description
`paymentId` - `String!`	The result of starting the PayPal payment capture.

Example

{"paymentId": "abc123"}

Types

Country

Description

Supported countries

Values

Enum Value	Description
`AT`
`BE`
`CH`
`CY`
`CZ`
`DE`
`DK`
`EE`
`ES`
`FI`
`FR`
`GB`
`GR`
`HR`
`HU`
`IE`
`IS`
`IT`
`LT`
`LU`
`LV`
`MT`
`NL`
`NO`
`PL`
`PT`
`RO`
`SE`
`SI`
`SK`

Example

"AT"

Types

CreditCardPaymentInput

Description

Arguments for creating a new credit card payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. It is recommended that these are unique per merchant but this is not checked anywhere a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their credit card payment screen. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying the session this payment belongs to. Multiple attempts can be made with the same paymentReference, changing the idempotency key, but there can be only one successful payment.
`returnUrl` - `String!`	The url to return to after the payment is done. If the payment screen is opened on a separate window, customer will be redirected here on payment success or error.

Example

{
  "amount": 987,
  "expiresAt": "abc123",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReturnUrl": "abc123",
  "message": "abc123",
  "paymentCategory": "Account",
  "paymentReference": "xyz789",
  "returnUrl": "xyz789"
}

Types

CreditCardPaymentResult

Description

The result of initiating a credit card payment.

Fields

Field Name	Description
`authToken` - `String`	Once a payment is initialized, we will start the credit card payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.
`gateway` - `String!`	The gateway this credit card payment will use.
`waitToken` - `String!`	Once a payment is initialized, we will start the credit card payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.

Example

{
  "authToken": "xyz789",
  "gateway": "abc123",
  "waitToken": "xyz789"
}

Types

CreditCardSchemeEnum

Description

All supported credit card schemes

Values

Enum Value	Description
`AMEX`	American Express
`CHINA_UNION_PAY`	China Union Pay
`DANKORT`	Dankort
`DINERS`	Diners Club International
`DISCOVER`	Discover Card
`FORBRUGSFORENINGEN`	Forbrugsforeningen
`JCB`	JCB
`MAESTRO`	Maestro
`MASTERCARD`	Mastercard
`VISA`	Visa
`VISA_DK`	Visa DK
`VISA_ELECTRON`	Visa Electron

Example

"AMEX"

Types

CustomerTitle

Description

Customer's preferred title when addressed.

Values

Enum Value	Description
`Miss`
`Mr`
`Mrs`
`Ms`

Example

"Miss"

Types

DeleteOrganizationWebhookUrlInput

Description

Stops the sending of webhooks to the provided URL. Any queued up webhooks for that URL will be discarded.

Fields

Input Field Description

organizationId - bigint! The organization to whom the notification has to be sent via the webhook URL.

webhookUrl - String!

URL to which the webhook notifications will be sent

Max length: 1000.

Example

{
  "organizationId": bigint,
  "webhookUrl": "xyz789"
}

Types

DeleteOrganizationWebhookUrlResult

Description

The result of deleting a webhook URL.

Fields

Field Name	Description
`found` - `Boolean!`	Whether or not a webhook URL was deleted.

Example

{"found": false}

Types

DeleteWebhookUrlInput

Description

Stops the sending of webhooks to the provided URL. Any queued up webhooks for that URL will be discarded.

Fields

Input Field Description

merchantId - bigint! The merchant to whom the notification has to be sent via the webhook URL.

webhookUrl - String!

URL to which the webhook notifications will be sent

Max length: 1000.

Example

{
  "merchantId": bigint,
  "webhookUrl": "xyz789"
}

Types

DeleteWebhookUrlResult

Description

The result of deleting a webhook URL.

Fields

Field Name	Description
`found` - `Boolean!`	Whether or not a webhook URL was deleted.

Example

{"found": false}

Types

EditUserInput

Description

Edit user's role.

Fields

Input Field	Description
`currentUser` - `String!`	Email of the user that is making the request.
`editUsers` - `[EditUserSingleInput!]!`	List of users that should be changed.
`organizationId` - `bigint!`	Id of the organization Max length: 20.

Example

{
  "currentUser": "xyz789",
  "editUsers": [EditUserSingleInput],
  "organizationId": bigint
}

Types

EditUserResult

Description

Result of the editions

Fields

Field Name	Description
`usersChanged` - `Int!`	The number of users modified.

Example

{"usersChanged": 987}

Types

EditUserSingleInput

Description

The information needed to edit a user role.

Fields

Input Field	Description
`email` - `String!`	Email of the user, for reference.
`role` - `String!`	Role that this user should have.
`userType` - `String!`	One of "google", "password" or "webauthn", indicates the type of user to be modify. Max length: 64.

Example

{
  "email": "xyz789",
  "role": "xyz789",
  "userType": "xyz789"
}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

GenerateAcquirerTransactionsCSVInput

Description

Arguments to generate an acquirer transactions CSV

Fields

Input Field	Description
`endDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters acquirer transactions in CSV, only including acquirer transactions created till this date. Has to be greater than or equal to start_date and no dates bigger than current date in UTC are allowed.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	The merchant requesting for the reports.
`startDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters acquirer transactions in CSV, only including acquirer transactions created from this date. Has to be smaller than or equal to end_date.

Example

{
  "endDate": "xyz789",
  "idempotencyKey": "abc123",
  "organizationId": bigint,
  "startDate": "abc123"
}

Types

GenerateAcquirerTransactionsCSVLinkInput

Description

Arguments to generate presigned URLs for a Acquirer transactions CSV file

Fields

Input Field Description

csvId - bigint! The ID of the CSV file that is requested.

idempotencyKey - String!

Max length: 64.

organizationId - bigint! The organization that report belongs to.

Example

{
  "csvId": bigint,
  "idempotencyKey": "abc123",
  "organizationId": bigint
}

Types

GenerateAcquirerTransactionsCSVLinkResult

Description

The result of a generateAcquirerTransactionsCSVLink mutation.

Fields

Field Name	Description
`id` - `bigint!`	You can use this id to query the acquirer transaction CSV link.

Example

{"id": bigint}

Types

GenerateAcquirerTransactionsCSVResult

Description

The result of a generateAcquirerTransactionsCSV mutation.

Fields

Field Name	Description
`acquirerTransactionsCsvId` - `bigint!`	You can use this id to query the generated acquirer transactions csv link.

Example

{"acquirerTransactionsCsvId": bigint}

Types

GenerateAisTransactionReportInput

Description

Arguments to generate a report of AIS transactions for the organization

Fields

Input Field	Description
`fromDate` - `String!`	The start date (UTC) of the period for which the report is generated.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	The organization who is initiating the report generation. Max length: 20.
`sessionId` - `String!`	The session from which AIS transactions are retrieved to generate the report.
`toDate` - `String!`	The end date (UTC) of the period for which the report is generated.

Example

{
  "fromDate": "abc123",
  "idempotencyKey": "abc123",
  "organizationId": bigint,
  "sessionId": "abc123",
  "toDate": "xyz789"
}

Types

GenerateAisTransactionReportResult

Description

The result of a generateAisTransactionReport mutation.

Fields

Field Name	Description
`success` - `Boolean!`	Whether operation succeeded to schedule a report generation

Example

{"success": false}

Types

GeneratePaymentCSVInput

Description

Arguments to generate presigned URLs for the merchant

Fields

Input Field	Description
`endDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters payments in CSV, only including payments created till this date. Has to be greater or equal than start_date and no dates bigger than current date in UTC are allowed.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant requesting for the reports.
`startDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters payments in CSV, only including payments created from this date. Has to be smaller or equal than end_date.

Example

{
  "endDate": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "startDate": "xyz789"
}

Types

GeneratePaymentCSVResult

Description

The result of a generatePaymentCSV mutation.

Fields

Field Name	Description
`waitToken` - `bigint!`	You can use this token to query the generated payments csv link.

Example

{"waitToken": bigint}

Types

GeneratePaymentRequestCSVInput

Description

Arguments to generate presigned URLs for the merchant

Fields

Input Field	Description
`creditCardNumber` - `String`	The credit card number of the payment request.
`creditCardTypeIn` - `[String!]`	List of credit card types to be included in the CSV.
`currencyIn` - `[String!]`	List of currencies to be included in the CSV.
`customerEmail` - `String`	The email address of the customer that initiated the payment request.
`customerName` - `String`	The name of the customer that initiated the payment request.
`customerPhoneNumber` - `String`	The phone number of the customer that initiated the payment request.
`endDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters payment requests in CSV, only including payment requests created till this date. Has to be greater than or equal to start_date and no dates bigger than current date in UTC are allowed.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`maxAmount` - `Int`	The highest amount, in minor units, to include.
`merchantId` - `bigint!`	The merchant requesting for the reports.
`minAmount` - `Int`	The lowest amount, in minor units, to include.
`paymentMethodIn` - `[PaymentRequestMethod!]`	List of payment methods to be included in the CSV.
`reference` - `String`	The reference number of the payment request.
`refundStatusIn` - `[PaymentRequestRefundStatus!]`	List of refund statuses to be included in the CSV.
`startDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters payment requests in CSV, only including payment requests created from this date. Has to be smaller than or equal to end_date.
`statusIn` - `[PaymentRequestStatus!]`	List of statuses to be included in the CSV.

Example

{
  "creditCardNumber": "xyz789",
  "creditCardTypeIn": ["xyz789"],
  "currencyIn": ["xyz789"],
  "customerEmail": "abc123",
  "customerName": "abc123",
  "customerPhoneNumber": "abc123",
  "endDate": "abc123",
  "idempotencyKey": "abc123",
  "maxAmount": 123,
  "merchantId": bigint,
  "minAmount": 123,
  "paymentMethodIn": ["BANK_TRANSFER"],
  "reference": "abc123",
  "refundStatusIn": ["FULLY_REFUNDED"],
  "startDate": "xyz789",
  "statusIn": ["ACCEPTED"]
}

Types

GeneratePaymentRequestCSVResult

Description

The result of a generatePaymentRequestCSV mutation.

Fields

Field Name	Description
`waitToken` - `bigint!`	You can use this token to query the generated payment requests csv link.

Example

{"waitToken": bigint}

Types

GeneratePurchaseCSVInput

Description

Arguments to generate presigned URLs for the merchant

Fields

Input Field	Description
`endDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters purchases in CSV, only including purchases created before this date. Has to be greater or equal than start_date and no dates bigger than current date in UTC are allowed.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant requesting for the reports.
`purchaseStatus` - `[String!]!`	A list of statuses to filter, will only include purchases in CSV that contain one of the given statuses, empty list will omit this filter.
`startDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters purchases in CSV, only including purchases created after this date. Has to be smaller or equal than end_date.

Example

{
  "endDate": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "purchaseStatus": ["abc123"],
  "startDate": "xyz789"
}

Types

GeneratePurchaseCSVResult

Description

The result of a generatePurchaseCSV mutation.

Fields

Field Name	Description
`waitToken` - `bigint!`	You can use this token to query the generated purchases csv link.

Example

{"waitToken": bigint}

Types

GenerateReconciliationCSVInput

Description

Arguments to generate presigned URLs for the merchant for a reconciliation report

Fields

Input Field	Description
`endDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters elements in CSV, only including elements created before this date. Has to be greater or equal than start_date and no dates bigger than current date in UTC are allowed.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant requesting for the reports.
`startDate` - `String!`	A date in yyyy-mm-dd format, non-nullable, filters elements in CSV, only including elements created after this date. Has to be smaller or equal than end_date.

Example

{
  "endDate": "abc123",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "startDate": "abc123"
}

Types

GenerateReconciliationCSVResult

Description

The result of a generateReconciliationCSV mutation.

Fields

Field Name	Description
`waitToken` - `bigint!`	You can use this token to query the generated reconciliation csv link.

Example

{"waitToken": bigint}

Types

GenerateReportInput

Description

Arguments to generate presigned URLs for the merchant

Fields

Input Field	Description
`endDate` - `String!`	The end date till when the report is to be generated for. Provide the dates in the merchant's own time zone. Only CET for now.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant requesting for the reports.
`startDate` - `String!`	The start date from when the report is to be generated for. Provide the dates in the merchant's own time zone. Only CET for now.

Example

{
  "endDate": "xyz789",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "startDate": "xyz789"
}

Types

GenerateReportResult

Description

The result of a generateReport mutation.

Fields

Field Name	Description
`waitToken` - `Int!`	You can use this token to query the generated reports link.

Example

{"waitToken": 987}

Types

GetDisputeFileDownloadLinkInput

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

organizationId - bigint! Id of the organization Max length: 20.

uploadId - String! Id of the dispute upload

Example

{
  "idempotencyKey": "abc123",
  "organizationId": bigint,
  "uploadId": "abc123"
}

Types

GetDisputeFileDownloadLinkResult

Description

The result ID of the dispute file upload. Poll it to get the download link.

Fields

Field Name	Description
`disputeFileUploadId` - `String!`	The ID of the dispute file upload.

Example

{"disputeFileUploadId": "xyz789"}

Types

GetReepayCheckoutEventsInput

Description

Input type to get reepay checkout events

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint! The merchant requesting

paymentRequestId - String! Payment request UUID

Example

{
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "paymentRequestId": "abc123"
}

Types

GetReepayCheckoutEventsResult

Description

Result of the mutation GetReepayCheckoutEvents

Fields

Field Name	Description
`waitToken` - `String!`	Token to wait on the reepayCheckoutEvents query

Example

{"waitToken": "xyz789"}

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

InvoiceDueDateAdjustInput

Description

A new date for an invoiced purchase

Fields

Input Field	Description
`dueDate` - `String!`	The new invoice due date. Only CET for now. The due date should be within 60 days of the current date.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant performing the adjustment.
`purchaseId` - `bigint!`	This is the id of the purchase associated with the invoice.

Example

{
  "dueDate": "abc123",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

InvoiceDueDateAdjustResult

Description

The result of processing an invoice due date adjustment.

Fields

Field Name	Description
`dueDate` - `String!`	The adjusted due date.
`returnId` - `Int!`	The id of the newly created adjustment.

Example

{"dueDate": "xyz789", "returnId": 123}

Types

InvoiceNoteInput

Description

Arguments for adding a note to an invoice

Fields

Input Field	Description
`createdBy` - `String!`	Who is creating the note. Max length: 100.
`invoiceNumber` - `bigint!`	The invoice the note corresponds to.
`merchantId` - `bigint!`	The merchant to which the invoice and the purchase belongs. Max length: 64.
`message` - `String!`	The message the admin wants to add to the invoice. Max length: 1000.
`purchaseId` - `bigint!`	The purchaseId corresponding to the invoice to which the note is to be added.

Example

{
  "createdBy": "abc123",
  "invoiceNumber": bigint,
  "merchantId": bigint,
  "message": "abc123",
  "purchaseId": bigint
}

Types

InvoiceNoteResult

Description

The result of adding a note to the invoice.

Fields

Field Name	Description
`resultingNoteId` - `bigint!`	The resulting id of adding a note to the invoice.

Example

{"resultingNoteId": bigint}

Types

ItemDiscountInput

Description

A list of discounts to apply on items that has been captured and are in an invoice.

Fields

Input Field Description

discounts - [ItemDiscountLineInput!]! List of discounts to apply.

idempotencyKey - String!

Max length: 64.

merchantId - bigint! The merchant performing the discount.

Example

{
  "discounts": [ItemDiscountLineInput],
  "idempotencyKey": "xyz789",
  "merchantId": bigint
}

Types

ItemDiscountLineInput

Description

List of discount items that are part of this request.

Fields

Input Field	Description
`discountAmount` - `Int!`	Total amount of the discount. Includes tax discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`.
`itemReference` - `String!`	Merchant's own internal item number or any other reference that may help the merchant in identifying this purchase.
`purchaseId` - `bigint!`	Id of the purchase

Example

{
  "discountAmount": 123,
  "itemReference": "xyz789",
  "purchaseId": bigint
}

Types

ItemDiscountResult

Description

The result of adding the item discount.

Fields

Field Name	Description
`captureItemDiscountIds` - `[Int!]!`	Ids of the discounts created.

Example

{"captureItemDiscountIds": [987]}

Types

Language

Description

Supported languages

Values

Enum Value	Description
`CS`
`DA`
`DE`
`EL`
`EN`
`ES`
`ET`
`FI`
`FR`
`HR`
`HU`
`IS`
`IT`
`LB`
`LT`
`LV`
`MT`
`NL`
`NO`
`PL`
`PT`
`RO`
`SK`
`SL`
`SV`

Example

"CS"

Types

LogInput

Description

Arguments for sending a log

Fields

Input Field	Description
`additionalData` - `String`	Any additional data you want to send, preferably a json encoded string
`clientSessionId` - `String!`	Unique client identifier
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`stateContext` - `String!`	State context
`stateName` - `String!`	Name of the state to log

Example

{
  "additionalData": "xyz789",
  "clientSessionId": "xyz789",
  "idempotencyKey": "xyz789",
  "stateContext": "abc123",
  "stateName": "abc123"
}

Types

LogResult

Description

The result of log.

Fields

Field Name	Description
`status` - `String!`	Placeholder response to return, always an empty string

Example

{"status": "xyz789"}

Types

MerchantWebhookEventEnum

Description

The possible events for merchant webhooks

Values

Enum Value	Description
`CaptureStateUpdate`	capture state update
`InvoiceUpdate`	invoice update
`PaymentStateUpdate`	payment state update
`PurchaseInstalmentFinalReminder`	second reminder for purchase instalment
`PurchaseInstalmentFirstReminder`	first reminder for purchase instalment
`PurchaseStateUpdate`	purchase state update
`RefundStateUpdate`	refund state update

Example

"CaptureStateUpdate"

Types

MerchantWebhookEventSetting

Description

The combination of an event name and a boolean indicating if it is enabled or not

Fields

Input Field	Description
`enabled` - `Boolean!`	Enabled or disabled
`event` - `MerchantWebhookEventEnum!`	The event that gets turned on or off

Example

{"enabled": true, "event": "CaptureStateUpdate"}

Types

MobilePayPaymentInput

Description

Arguments for creating a new MobilePay payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. It is recommended that these are unique per merchant but this is not checked anywhere a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their MobilePay payment screen. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying the session this payment belongs to. Multiple attempts can be made with the same paymentReference, changing the idempotency key, but there can be only one successful payment.
`returnUrl` - `String!`	The url to return to after the payment is done. If the payment screen is opened on a separate window, customer will be redirected here on payment success or error.

Example

{
  "amount": 987,
  "expiresAt": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "abc123",
  "merchantReturnUrl": "xyz789",
  "message": "xyz789",
  "paymentCategory": "Account",
  "paymentReference": "abc123",
  "returnUrl": "abc123"
}

Types

MobilePayPaymentResult

Description

The result of initiating a MobilePay payment.

Fields

Field Name	Description
`waitToken` - `String!`	Once a payment is initialized, we will start the MobilePay payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.

Example

{"waitToken": "xyz789"}

Types

NewScaSessionInput

Description

Arguments for creating a new SCA session.

Fields

Input Field	Description
`expiresAt` - `String`	Session expiry timestamp in ISO8601 format. E.g. '1970-01-01T00:00:00Z' Max is 24 hours from creation of session. Defaults to 24 hours.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the SCA. Max length: 64.
`onSuccessRedirectUrl` - `String!`	The URL that the end user will be redirected to after successful SCA Max length: 300.
`sePersonalNumber` - `String`	The personal number (personnummer) of the person that is expected to sign with BankID. If it is provided the signing will fail if someone else tries to sign Max length: 12.

Example

{
  "expiresAt": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "onSuccessRedirectUrl": "abc123",
  "sePersonalNumber": "xyz789"
}

Types

NewScaSessionResult

Description

The result of starting a new payment session.

Fields

Field Name	Description
`id` - `String!`	The id of the SCA session, use this to query for successful SCA attempts from the backend
`token` - `String!`	Use this token to start SCA flow.

Example

{
  "id": "abc123",
  "token": "xyz789"
}

Types

P24NotificationInput

Description

Arguments from P24 for transaction status notification

Fields

Input Field	Description
`amount` - `bigint!`	Amount of paid transaction expressed in lowest currency unit, e.g. 1.23 PLN = 123
`currency` - `String!`	Currency compatible with ISO, e.g. PLN
`merchantId` - `bigint!`	The kronor merchant id used to create the p24 transaction
`methodId` - `bigint!`	Payment method used by customer
`orderId` - `bigint!`	Transaction number assigned by P24
`originAmount` - `bigint!`	Amount of the transaction when registered the token expressed in lowest currency unit, e.g. 1.23 PLN = 123
`p24MerchantId` - `bigint!`	Merchant identification number from p24
`posId` - `bigint!`	Shop identification number (defaults to merchant ID)
`sessionId` - `String!`	Unique identifier from merchant's system
`sign` - `String!`	Checksum
`statement` - `String!`	Payment title

Example

{
  "amount": bigint,
  "currency": "abc123",
  "merchantId": bigint,
  "methodId": bigint,
  "orderId": bigint,
  "originAmount": bigint,
  "p24MerchantId": bigint,
  "posId": bigint,
  "sessionId": "abc123",
  "sign": "abc123",
  "statement": "abc123"
}

Types

P24NotificationResult

Description

The result of P24 notification callback.

Fields

Field Name	Description
`status` - `String!`	Placeholder response to return to P24 when they post the transaction notification

Example

{"status": "xyz789"}

Types

P24PaymentInput

Description

Arguments for creating a new P24 payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. It is recommended that these are unique per merchant but this is not checked anywhere a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their P24 payment screen. It could be an order id or a reference. Max length: 50.
`p24RegulationAccept` - `Boolean`	true - consent for p24 regulations given false - consent not given, consent dialog will be shown on p24 website Default value is false. When paymentMethodId is null, this will always default to false
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentMethodId` - `bigint`	The p24 id of the payment method selected from the list of payment methods displayed. When not passed, all the payment methods are displayed on p24 website
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying the session this payment belongs to. Multiple attempts can be made with the same paymentReference, changing the idempotency key, but there can be only one successful payment.
`returnUrl` - `String!`	The url to return to after the payment is done. If the payment screen is opened on a separate window, customer will be redirected here on payment success or error.

Example

{
  "amount": 987,
  "expiresAt": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReturnUrl": "abc123",
  "message": "xyz789",
  "p24RegulationAccept": true,
  "paymentCategory": "Account",
  "paymentMethodId": bigint,
  "paymentReference": "xyz789",
  "returnUrl": "abc123"
}

Types

P24PaymentResult

Description

The result of initiating a P24 payment.

Fields

Field Name	Description
`paymentId` - `String!`	Once a payment is initialized, we will start the P24 payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.

Example

{"paymentId": "abc123"}

Types

P24RefundNotificationInput

Description

Arguments from P24 for refund status notification

Fields

Input Field	Description
`amount` - `bigint!`	Refund amount expressed in lowest currency unit, e.g. 1.23 PLN = 123
`currency` - `String!`	Currency compatible with ISO, e.g. PLN
`merchantId` - `bigint!`	The kronor merchant id used to create the p24 transaction
`orderId` - `bigint!`	Transaction number assigned by P24
`p24MerchantId` - `bigint!`	Merchant identification number from p24
`refundsUuid` - `String!`	ID of refund request in Partner's system provided in transaction/refund
`requestId` - `String!`	ID of refund request provided in transaction/refund
`sessionId` - `String!`	Unique identifier from merchant's system
`sign` - `String!`	Checksum
`status` - `bigint!`	Status of the executed refund. The parameter always takes the value 0, which means success
`timestamp` - `bigint!`	Time of sending the refund notification provided in UNIX timestamp

Example

{
  "amount": bigint,
  "currency": "xyz789",
  "merchantId": bigint,
  "orderId": bigint,
  "p24MerchantId": bigint,
  "refundsUuid": "abc123",
  "requestId": "abc123",
  "sessionId": "xyz789",
  "sign": "xyz789",
  "status": bigint,
  "timestamp": bigint
}

Types

P24RefundNotificationResult

Description

The result of P24 refund notification callback.

Fields

Field Name	Description
`status` - `String!`	Placeholder response to return to P24 when they post the refund notification

Example

{"status": "abc123"}

Types

PayInstalmentInput

Description

Arguments for paying an instalment

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint!

The merchant who is initiating the payment.

Max length: 64.

purchaseId - bigint!

The purchaseId is the purchase for which the customer is paying the instalment.

Max length: 64.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

PayInstalmentResult

Description

The result of initiating a payment for an instalment.

Fields

Field Name	Description
`token` - `String!`	Once a payment is initialized, we will return a bearer token. You can use this token to start the payment flow with swish.

Example

{"token": "xyz789"}

Types

PayPalMerchantOnboardingInput

Description

Arguments for onboarding a new PayPal merchant

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint!

The merchant who is being onboarded on the platform.

Max length: 64.

returnUrl - String! The url to return to after the merchant is onboarded.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "returnUrl": "xyz789"
}

Types

PayPalMerchantOnboardingResult

Description

The result of starting the PayPal onboarding process.

Fields

Field Name	Description
`trackingId` - `String!`	The result of starting the PayPal onboarding process.

Example

{"trackingId": "abc123"}

Types

PayPalPaymentInput

Description

Arguments for creating a new PayPal payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. These have to be globally unique but they should be reused for retrying a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their bank statement. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying this payment.
`returnUrl` - `String!`	The url to return to after the payment is done.

Example

{
  "amount": 987,
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "abc123",
  "merchantReturnUrl": "xyz789",
  "message": "xyz789",
  "paymentCategory": "Account",
  "paymentReference": "xyz789",
  "returnUrl": "xyz789"
}

Types

PayPalPaymentResult

Description

The result of initiating a PayPal payment.

Fields

Field Name	Description
`paymentId` - `String!`	Once a payment is initialized, we will start the PayPal payment workflow. You can use this id to query the current status of the payment.

Example

{"paymentId": "abc123"}

Types

PaymentCancelInput

Description

Arguments for cancelling payment

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint!

The merchant who is initiating the payment.

Max length: 64.

paymentReference - String! The payment reference to cancel.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "paymentReference": "xyz789"
}

Types

PaymentCancelResult

Description

The result of cancelling a payment request.

Fields

Field Name	Description
`waitToken` - `String`	The returned token can be used to query whether the payment has been cancelled or not.

Example

{"waitToken": "abc123"}

Types

PaymentCaptureAllInput

Description

Arguments for fully capturing a payment.

Fields

Input Field	Description
`amount` - `Int`	The amount to capture in minor units. So 100,56 kr would be 10056. Amount should be in between 0 and authorized amount. If omited, a capture would be created for the amount required to capture all that was authorized. If lower than authorized amount - amount paid, a refund will be created if the capture is successful.
`createdBy` - `String`	Who is creating the capture. Max length: 100.
`generatedFrom` - `String`	Optional, where the capture is being created from. Max length: 100.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is capturing the payment. Max length: 64.
`message` - `String`	A message to be displayed on the portal associated with this capture. Message will appear in the customer's account statement. Max length: 50.
`paymentId` - `bigint`	Id of the payment to capture.
`paymentTransactionId` - `String`	Transaction ID of the payment to capture.
`refundMessage` - `String`	A message to be displayed to the customer in case a refund is made when returning excess amount. This message will appear in the customer's account statement if any refund is made. Max length: 50.

Example

{
  "amount": 123,
  "createdBy": "abc123",
  "generatedFrom": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "message": "xyz789",
  "paymentId": bigint,
  "paymentTransactionId": "xyz789",
  "refundMessage": "xyz789"
}

Types

PaymentCaptureInput

Description

Arguments for partially capturing a payment.

Fields

Input Field	Description
`amount` - `Int!`	The amount to capture in minor units. So 100,56 kr would be 10056. Amount should be in between 0 and authorized amount.
`createdBy` - `String`	Who is creating the capture. Max length: 100.
`generatedFrom` - `String`	Optional, where the capture is being created from. Max length: 100.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is capturing the payment. Max length: 64.
`message` - `String`	A message to be displayed on the portal associated with this capture. Message will appear in the customer's account statement. Max length: 50.
`paymentId` - `bigint`	Id of the payment to capture.
`paymentTransactionId` - `String`	Transaction ID of the payment to capture.

Example

{
  "amount": 123,
  "createdBy": "xyz789",
  "generatedFrom": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "message": "xyz789",
  "paymentId": bigint,
  "paymentTransactionId": "xyz789"
}

Types

PaymentCaptureResult

Description

The result of capturing a payment.

Fields

Field Name	Description
`captureId` - `bigint!`	Once a payment is captured. We will start processing the capture. You can use this token to query the created capture.
`captureTransactionId` - `String!`	Transaction ID of the capture.

Example

{
  "captureId": bigint,
  "captureTransactionId": "xyz789"
}

Types

PaymentCategory

Description

Payment Category that determines the payment flow

Values

Enum Value	Description
`Account`
`Instalment`
`Invoice`
`StandAlone`

Example

"Account"

Types

PaymentRequestMethod

Description

Payment method

Values

Enum Value	Description
`BANK_TRANSFER`	Pay with Enable Banking PIS
`CREDIT_CARD`	Credit or Debit cards
`DIRECT_DEBIT`	Pay with direct debit
`FINSHARK_DIRECT_DEBIT`	Open Banking direct debit via Finshark
`FINSHARK_RECURRING_DEBIT`	Open Banking recurring debit via Finshark
`MOBILEPAY`	Pay with MobilePay Online
`P24`	Pay with Przelewy24
`PAYPAL`	Pay with PayPal
`SWISH`	Swish
`VIPPS`	Pay with Vipps

Example

"BANK_TRANSFER"

Types

PaymentRequestRefundStatus

Description

The refund status of the resulting payment

Values

Enum Value	Description
`FULLY_REFUNDED`	The payment is fully refunded
`NO_REFUND`	The payment has no refunds
`PARTIALLY_REFUNDED`	The payment is partially refunded

Example

"FULLY_REFUNDED"

Types

PaymentRequestStatus

Description

Payment status

Values

Enum Value	Description
`ACCEPTED`	Payment is ACCEPTED. Money is likely debited from the customer now. Wait for the PAID status before shipping the order
`AUTHORIZED`	Payment is authorized. Can be captured now.
`CANCELLED`	Payment was cancelled.
`CANCELLING`	Attempting to cancel the payment.
`CAPTURE_DECLINED`	Payment capture is declined. Please create a new payment. (Only applicable for payments that support reservation)
`DECLINED`	Payment was declined by the customer.
`ERROR`	Payment errored.
`FLOW_COMPLETED`	Completed the frontend flow of a direct debit payment.
`INITIALIZING`	Payment is initialising.
`PAID`	Payment is paid.
`PARTIALLY_CAPTURED`	Payment is partially captured. (Only applicable for payments that support reservation)
`PRE_FLIGHT_CHECK`	Payment is undergoing check.
`RELEASED`	Payment reservation is released. (Only applicable for payments that support reservation)
`WAITING_FOR_PAYMENT`	Payment is requested and waiting for confirmation.
`WAITING_FOR_PROMOTION`	The payment request is being promoted to a payment

Example

"ACCEPTED"

Types

PaymentSessionAdditionalData

Description

Arguments for adding additional data to a payment.

Fields

Input Field	Description
`email` - `String!`	The E-mail address of the customer.
`ip` - `String!`	IP address of the customer attempting the payment.
`language` - `Language!`	Language in which the payment is being handled Only languages in two-letter `ISO-639-1` format are recognized. Example: `SV`, `DA`, `NO`, `IS`, `EN`.
`name` - `String!`	The name of the customer that the payment is associated with. Max length: 100.
`orderLines` - `[PurchaseOrderLineInput!]`	A list with all purchase items in this order.
`phoneNumber` - `String`	Phone number Max length: 100.
`shippingAddress` - `AddressInput`	Shipping Address for the order.

Example

{
  "email": "xyz789",
  "ip": "abc123",
  "language": "CS",
  "name": "xyz789",
  "orderLines": [PurchaseOrderLineInput],
  "phoneNumber": "abc123",
  "shippingAddress": AddressInput
}

Types

PaymentSessionInput

Description

Arguments for creating a new payment session.

Fields

Input Field	Description
`additionalData` - `PaymentSessionAdditionalData`	Additional data about the customer attempting the payment.
`allowExecutionDate` - `Boolean`	Whether setting an execution date is allowed for payments in this session.
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056
`country` - `Country`	The country where the payment is taking place. Example: `SE`, `DK`, `NO`, `IS`, `FI`
`currency` - `SupportedCurrencyEnum`	When `currency` is not set, it defaults to the merchant's default currency. When no payment method is available for the given currency, then `newPaymentSession` fails with an error. Similarly, attempting to create a payment with a payment method that is not available for the given currency also results in an error.
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format. E.g. '1970-01-01T00:00:00Z' Max is 24 hrs from creation of session.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. These have to be globally unique but they should be reused for retrying a payment. Max length: 64.
`merchantReference2` - `String`	An additional merchant's reference that may help the merchant in identifying this payment. These need not be be unique. Can store any information. Max length: 1000.
`message` - `String!`	A message to show to the customer. It could be an order id or a reference. Only alphanumeric, Swedish characters, and the following are allowed: ':' ';' '.' ',' '?' '!' '(' ')' '”' '"' ' ' Max length: 50.
`preferredGateway` - `String`	The preferred gateway to use for this payment session. Only "Kronor" is supported at the moment. Leave empty if you don't know why you need this. Talk to us before using this.

Example

{
  "additionalData": PaymentSessionAdditionalData,
  "allowExecutionDate": true,
  "amount": 123,
  "country": "AT",
  "currency": "CHF",
  "expiresAt": "xyz789",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReference2": "xyz789",
  "message": "abc123",
  "preferredGateway": "abc123"
}

Types

PaymentSessionResult

Description

The result of starting a new payment session.

Fields

Field Name	Description
`token` - `String!`	Once a payment session is initialized, you can use this token to start the payment flow.

Example

{"token": "xyz789"}

Types

PaymentSessionWithReferenceCheckInput

Description

Arguments for creating a new payment session.

Fields

Input Field	Description
`additionalData` - `PaymentSessionAdditionalData`	Additional data about the customer attempting the payment.
`allowExecutionDate` - `Boolean`	Whether setting an execution date is allowed for payments in this session.
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056
`country` - `Country!`	The country where the payment is taking place. Example: `SE`, `DK`, `NO`, `IS`, `FI`
`currency` - `SupportedCurrencyEnum!`	The currency the customer pays in. When no payment method is available for the given currency, then `newPaymentSession` fails with an error. Similarly, attempting to create a payment with a payment method that is not available for the given currency also results in an error.
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format. E.g. '1970-01-01T00:00:00Z' Max is 24 hrs from creation of session.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. This identifier will be used for checking existing payment sessions, if another session with the same merchantReference and merchantReference2 exists, and the amount and currency are the same, then the existing session will be returned. If a paid payment exists with same merchantReference, the paid payment is returned. Max length: 64.
`merchantReference2` - `String`	An additional merchant's reference that may help the merchant in identifying this payment. These need not be be unique. Can store any information. Max length: 1000.
`message` - `String!`	A message to show to the customer. It could be an order id or a reference. Only alphanumeric, Swedish characters, and the following are allowed: ':' ';' '.' ',' '?' '!' '(' ')' '”' '"' ' ' Max length: 50.
`preferredGateway` - `String`	The preferred gateway to use for this payment session. Only "Kronor" is supported at the moment. Leave empty if you don't know why you need this. Talk to us before using this.

Example

{
  "additionalData": PaymentSessionAdditionalData,
  "allowExecutionDate": true,
  "amount": 987,
  "country": "AT",
  "currency": "CHF",
  "expiresAt": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReference2": "xyz789",
  "message": "xyz789",
  "preferredGateway": "xyz789"
}

Types

PaymentSessionWithReferenceCheckResult

Description

The result of starting a new payment session.

Fields

Field Name	Description
`paymentId` - `String`	If a successfult payment was already made for the same `merchantReference`, this field will contain the ID of the payment.
`paymentTransactionId` - `String`	If a successfult payment was already made for the same `merchantReference`, this field will contain the transaction ID of the payment.
`token` - `String!`	Once a payment session is initialized, you can use this token to start the payment flow.

Example

{
  "paymentId": "xyz789",
  "paymentTransactionId": "xyz789",
  "token": "xyz789"
}

Types

PrepareDisputeFileUploadInput

Fields

Input Field	Description
`disputeId` - `String!`	Id of the dispute
`fileContentType` - `String!`	Content type of the file that will be uploaded.
`fileLabel` - `AcquirerDisputeFileUploadLabel!`	The label of the file
`fileName` - `String!`	Name of the file
`fileSize` - `Int!`	Size of the file that will be uploaded
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	Id of the organization Max length: 20.

Example

{
  "disputeId": "abc123",
  "fileContentType": "xyz789",
  "fileLabel": "DOCUMENTATION",
  "fileName": "xyz789",
  "fileSize": 123,
  "idempotencyKey": "abc123",
  "organizationId": bigint
}

Types

PrepareDisputeFileUploadResult

Description

The result of starting a dispute file upload

Fields

Field Name	Description
`disputeFileUploadId` - `String!`	The ID of the dispute file upload.

Example

{"disputeFileUploadId": "abc123"}

Types

PurchaseCancelInput

Description

A purchase cancellation made when we are waiting for captures or we already have a capture

Fields

Input Field	Description
`merchantId` - `bigint!`	The merchant performing the purchase cancellation intent.
`purchaseId` - `bigint!`	This is the id of the purchase to cancel.

Example

{
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

PurchaseCancelResult

Description

The result of cancelling a purchase.

Fields

Field Name	Description
`result` - `Boolean!`	We return True for success and False for failure.

Example

{"result": true}

Types

PurchaseCaptureAllBatchInput

Description

A complete shipment of multiple purchases.

Fields

Input Field	Description
`description` - `String`	Description of the purchase capture. Max length: 10000.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the capture to us.
`purchaseIds` - `[bigint!]!`	Id of the purchase

Example

{
  "description": "xyz789",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "purchaseIds": [bigint]
}

Types

PurchaseCaptureAllBatchResult

Description

The result of initiating a full capture of multiple purchases.

Fields

Field Name	Description
`waitToken` - `String!`	Once a capture for multiple purchases is received, we will start processing the capture for each purchase. We can use the waitToken to query the status of capture for each of the purchases.

Example

{"waitToken": "xyz789"}

Types

PurchaseCaptureAllInput

Description

A complete shipment of a purchase.

Fields

Input Field	Description
`description` - `String`	Description of the purchase capture. Max length: 10000.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the capture to us.
`purchaseId` - `bigint!`	Id of the purchase

Example

{
  "description": "xyz789",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

PurchaseCaptureAllRangeFilterByInput

Description

A set of purchase filters to use for performing a full capture.

Fields

Input Field	Description
`status` - `[PurchaseCaptureStatus!]!`	Purchase status to filter by for full capture

Example

{"status": ["CAPTURE_DONE"]}

Types

PurchaseCaptureAllRangeInput

Description

A complete shipment of multiple purchases.

Fields

Input Field	Description
`description` - `String`	Description of the purchase capture. Max length: 10000.
`endDate` - `String!`	End date (inclusive) to filter for purchases.
`filterBy` - `PurchaseCaptureAllRangeFilterByInput!`	A set of filters to filter the purchase by.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the capture to us.
`startDate` - `String!`	Start date (inclusive) from when to filter for purchases.

Example

{
  "description": "abc123",
  "endDate": "abc123",
  "filterBy": PurchaseCaptureAllRangeFilterByInput,
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "startDate": "xyz789"
}

Types

PurchaseCaptureAllRangeResult

Description

The result of initiating a full capture for the date range and/or purchase status filter.

Fields

Field Name	Description
`waitToken` - `String!`	Once a capture for multiple purchases is received, we will start processing the capture for each purchase. We can use the waitToken to query the status of capture for purchases in the date range and the purchase status filter used.

Example

{"waitToken": "abc123"}

Types

PurchaseCaptureAllResult

Description

The result of capturing a purchase.

Fields

Field Name	Description
`captureId` - `bigint!`	Once a purchase is captured. We will start processing the payout to the merchant. You can use this token to query the created capture.

Example

{"captureId": bigint}

Types

PurchaseCaptureInput

Description

A partial or complete shipment of a purchase.

Fields

Input Field	Description
`captureItems` - `[PurchaseCaptureItemInput!]!`	List of items captured in this purchase.
`description` - `String`	Description of the purchase capture. Max length: 10000.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the capture to us.
`purchaseId` - `bigint!`	Id of the purchase

Example

{
  "captureItems": [PurchaseCaptureItemInput],
  "description": "xyz789",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

PurchaseCaptureItemInput

Description

An item from the purchase order

Fields

Input Field	Description
`pricePerItem` - `Int!`	Unit price including tax in minor units.
`quantity` - `Int!`	Number of items captured sharing the same reference.
`reference` - `String!`	Unique item identification reference.'; Max length: 64.
`taxRate` - `Int!`	The tax rate in percent with two implicit decimals. Non-negative. Example: 1500 = 15%
`totalAmount` - `Int!`	Total amount (including tax and discounts) in minor units for the items being captured.
`totalTaxAmount` - `Int!`	Total tax amount on all the captured items of this type in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.

Example

{
  "pricePerItem": 123,
  "quantity": 987,
  "reference": "abc123",
  "taxRate": 987,
  "totalAmount": 987,
  "totalTaxAmount": 987
}

Types

PurchaseCaptureResult

Description

The result of capturing a purchase.

Fields

Field Name	Description
`captureId` - `bigint!`	Once a purchase is captured. We will start processing the payout to the merchant. You can use this token to query the created capture.

Example

{"captureId": bigint}

Types

PurchaseCaptureStatus

Description

Purchase capture status to be used for filtering

Values

Enum Value	Description
`CAPTURE_DONE`
`PARTIALLY_CAPTURED`
`WAITING_FOR_CAPTURE`

Example

"CAPTURE_DONE"

Types

PurchaseCaptureWithItemReferencesInput

Description

A partial or complete shipment of the items in a purchase.

Fields

Input Field	Description
`description` - `String`	Description of the purchase capture. Max length: 10000.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`itemReferences` - `[String!]!`	List of items references in the purchase to be captured.
`merchantId` - `bigint!`	ID of the merchant sending the capture to us.
`purchaseId` - `bigint!`	ID of the purchase

Example

{
  "description": "xyz789",
  "idempotencyKey": "abc123",
  "itemReferences": ["abc123"],
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

PurchaseCaptureWithItemReferencesResult

Description

The result of capturing the items in the purchase.

Fields

Field Name	Description
`captureId` - `bigint!`	Once a purchase is captured, we will start processing the payout to the merchant. You can use this token to query the created capture.

Example

{"captureId": bigint}

Types

PurchaseEditAddressInput

Description

Edit a purchase address (billing or shipping).

Fields

Input Field	Description
`addressId` - `bigint!`	Id of the address that will be changed.
`city` - `String!`	City of the customer.
`country` - `String!`	Country of the customer.
`email` - `String!`	Email of the customer.
`firstName` - `String!`	Customer's first name.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`lastName` - `String!`	Customer's last name.
`line1` - `String!`	Line 1 of the customer address.
`line2` - `String`	Line 2 of the customer address.
`merchantId` - `bigint!`	The merchant performing the edit.
`phoneNumber` - `String!`	Phone number of the customer.
`postalCode` - `String!`	Postal code of the customer.
`purchaseId` - `bigint!`	Id of the purchase to edit.

Example

{
  "addressId": bigint,
  "city": "abc123",
  "country": "xyz789",
  "email": "xyz789",
  "firstName": "xyz789",
  "idempotencyKey": "abc123",
  "lastName": "xyz789",
  "line1": "xyz789",
  "line2": "abc123",
  "merchantId": bigint,
  "phoneNumber": "xyz789",
  "postalCode": "abc123",
  "purchaseId": bigint
}

Types

PurchaseEditAddressResult

Description

Result of editing an address of a purchase (billing or shipping).

Fields

Field Name	Description
`customerId` - `bigint!`	Customer who made the purchase.

Example

{"customerId": bigint}

Types

PurchaseEditInput

Description

Edit a purchase that hasn't been captured yet.

Fields

Input Field	Description
`addPurchaseItems` - `[PurchaseOrderLineInput!]`	A list with new purchase items to add to this order.
`deliveryMethod` - `String`	Edit the delivery method for the purchase. Max length: 100.
`editPurchaseItems` - `[PurchaseItemEditInput!]`	A list with all purchase items to edit.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant performing the purchase intent. Max length: 64.
`merchantReference` - `String`	Merchant's own internal order number or any other reference that may help the merchant in identifying this edit of the purchase. Max length: 64.
`purchaseId` - `bigint!`	Id of the purchase to edit.
`purchaseTaxAmount` - `Int`	Total tax amount of all the order in minor units. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must be within ±1 of: totalAmount - totalAmount * 10000 / (10000 + taxRate).
`purchaseTotalAmount` - `Int`	Total amount of all the order in minor units. Includes tax and discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must fulfill equation: total_amount = (quantity x pricePerItem) - totalDiscountAmount

Example

{
  "addPurchaseItems": [PurchaseOrderLineInput],
  "deliveryMethod": "abc123",
  "editPurchaseItems": [PurchaseItemEditInput],
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "purchaseId": bigint,
  "purchaseTaxAmount": 123,
  "purchaseTotalAmount": 123
}

Types

PurchaseEditResult

Description

The result of editing a purchase.

Fields

Field Name	Description
`success` - `Boolean!`	True if a purchase has been successfully edited, False otherwise

Example

{"success": true}

Types

PurchaseItemEditInput

Description

Purchase item to add to a purchase or edit an existing item in the purchase."

Fields

Input Field	Description
`imageUrl` - `String`	URL to an image that can be used later in communications between kronor and the customer. Max length: 10000.
`itemUrl` - `String`	URL to item in the merchant catalog, that will be used in communications between kronor and the customer. Max length: 10000.
`name` - `String`	The name of the purchased item Max length: 100.
`pricePerItem` - `Int`	Price per item in this line in minor units. It should include tax, but not any discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`.
`quantity` - `Int`	Number of items ordered by the customer. Needs to be a positive number.
`reference` - `String!`	The reference of the item to edit the purchase item. Reference can be queried from the 'purchase' query. Max length: 64.
`taxRate` - `Int`	Tax rate on the items ordered in this line. Needs to be a non-negative number. Example: `15%` discount should be represented as `1500`.
`totalAmount` - `Int`	Total tax amount on all the items in this line in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.
`totalDiscountAmount` - `Int`	Discount applied on all the items in this line in minor units. This value should include any applicable tax. Example: `1500,25` SEk should be `150025`. Example `100` SEK should be `10000`.
`totalTaxAmount` - `Int`	Total tax amount on all the items in this line in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.

Example

{
  "imageUrl": "xyz789",
  "itemUrl": "xyz789",
  "name": "xyz789",
  "pricePerItem": 987,
  "quantity": 123,
  "reference": "xyz789",
  "taxRate": 123,
  "totalAmount": 987,
  "totalDiscountAmount": 987,
  "totalTaxAmount": 123
}

Types

PurchaseOrderCancelInput

Description

A purchase cancellation intent by a customer that is yet to be fully authenticated.

Fields

Input Field Description

merchantId - bigint! The merchant performing the purchase cancellation intent.

purchaseOrderId - String!

This is the id of the order to cancel.

Max length: 64.

Example

{
  "merchantId": bigint,
  "purchaseOrderId": "abc123"
}

Types

PurchaseOrderCancelResult

Description

The result of cancelling a purchase order.

Fields

Field Name	Description
`result` - `Boolean!`	We return True for success and False for failure.

Example

{"result": true}

Types

PurchaseOrderLineInput

Description

List of order items which are part of this checkout.

Fields

Input Field	Description
`imageUrl` - `String`	URL to an image that can be used later in communications between kronor and the customer. Max length: 10000.
`itemUrl` - `String`	URL to item in the merchant catalog, that will be used in communications between kronor and the customer. Max length: 10000.
`name` - `String!`	The name of the purchased item Max length: 100.
`pricePerItem` - `Int!`	Price per item in this line in minor units. It should include tax, but not any discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`.
`quantity` - `Int!`	Number of items ordered by the customer. Needs to be a positive number.
`reference` - `String`	Merchant's own internal item number or any other reference that may help the merchant in identifying this purchase. Max length: 64.
`taxRate` - `Int!`	Tax rate on the items ordered in this line. Needs to be a non-negative number. Example: `15%` discount should be represented as `1500`.
`totalAmount` - `Int!`	Total tax amount on all the items in this line in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.
`totalDiscountAmount` - `Int`	Discount applied on all the items in this line in minor units. This value should include any applicable tax. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`.
`totalTaxAmount` - `Int!`	Total tax amount on all the items in this line in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.

Example

{
  "imageUrl": "xyz789",
  "itemUrl": "xyz789",
  "name": "abc123",
  "pricePerItem": 123,
  "quantity": 123,
  "reference": "xyz789",
  "taxRate": 123,
  "totalAmount": 123,
  "totalDiscountAmount": 987,
  "totalTaxAmount": 123
}

Types

PurchaseOrderWithInstalmentsInput

Description

A purchase intent by a customer that is yet to be fully authenticated, uses instalments in contrast to PurchaseOrderWithInvoiceInput, and a fee will be added to each instalment.

Fields

Input Field	Description
`billingAddress` - `AddressInput!`	The billing address for the customer making the purchase.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant performing the purchase intent. Max length: 64.
`merchantReference` - `String`	Merchant's own internal order number or any other reference that may help the merchant in identifying this purchase. Max length: 64.
`nationalIdentificationNumber` - `String!`	National identification number for the customer. This will be use to perform strong customer authentication, that is, making sure of the customer's identity.
`purchaseCountry` - `Country!`	Country where the purchase is taking place. Example: `Sweden`, `Denmark`, `Norway`, `Iceland`
`purchaseLanguage` - `Language!`	Language in which the purchase is being handled Only languages in two-letter `ISO-639-1` format are recognized. Example: `SV`, `DA`, `NO`, `IS`, `EN`.
`purchaseLines` - `[PurchaseOrderLineInput!]!`	A list with all purchase items in this order.
`purchaseTaxAmount` - `Int!`	Total tax amount of all the order in minor units. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must be within ±1 of: totalAmount - totalAmount * 10000 / (10000 + taxRate).
`purchaseTotalAmount` - `Int!`	Total amount of all the order in minor units. Includes tax and discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must fulfill equation: totalAmount = (quantity x pricePerItem) - totalDiscountAmount
`shippingAddress` - `AddressInput`	The address the customer wants to ship the purchased items to.

Example

{
  "billingAddress": AddressInput,
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "abc123",
  "nationalIdentificationNumber": "xyz789",
  "purchaseCountry": "AT",
  "purchaseLanguage": "CS",
  "purchaseLines": [PurchaseOrderLineInput],
  "purchaseTaxAmount": 987,
  "purchaseTotalAmount": 987,
  "shippingAddress": AddressInput
}

Types

PurchaseOrderWithInstalmentsResult

Description

The result of initiating a purchase order with instalments.

Fields

Field Name	Description
`id` - `String!`	The resulting purchase order ID (same as the idempotency key)
`waitToken` - `String!`	Once a purchase order is received, we will start processing for fraud and final approval. You can use this token to query the current status.

Example

{
  "id": "abc123",
  "waitToken": "xyz789"
}

Types

PurchaseOrderWithInvoiceInput

Description

A purchase intent by a customer that is yet to be fully authenticated.

Fields

Input Field	Description
`billingAddress` - `AddressInput!`	The billing address for the customer making the purchase.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant performing the purchase intent. Max length: 64.
`merchantReference` - `String`	Merchant's own internal order number or any other reference that may help the merchant in identifying this purchase. Max length: 64.
`nationalIdentificationNumber` - `String!`	National identification number for the customer. This will be use to perform strong customer authentication, that is, making sure of the customer's identity.
`purchaseCountry` - `Country!`	Country where the purchase is taking place. Example: `Sweden`, `Denmark`, `Norway`, `Iceland`
`purchaseLanguage` - `Language!`	Language in which the purchase is being handled Only languages in two-letter `ISO-639-1` format are recognized. Example: `SV`, `DA`, `NO`, `IS`, `EN`.
`purchaseLines` - `[PurchaseOrderLineInput!]!`	A list with all purchase items in this order.
`purchaseTaxAmount` - `Int!`	Total tax amount of all the order in minor units. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must be within ±1 of: totalAmount - totalAmount * 10000 / (10000 + taxRate).
`purchaseTotalAmount` - `Int!`	Total amount of all the order in minor units. Includes tax and discounts. Example: `1500,25` SEK should be `150025`. Example `100` SEK should be `10000`. Must fulfill equation: totalAmount = (quantity x pricePerItem) - totalDiscountAmount
`shippingAddress` - `AddressInput`	The address the customer wants to ship the purchased items to.

Example

{
  "billingAddress": AddressInput,
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "nationalIdentificationNumber": "abc123",
  "purchaseCountry": "AT",
  "purchaseLanguage": "CS",
  "purchaseLines": [PurchaseOrderLineInput],
  "purchaseTaxAmount": 123,
  "purchaseTotalAmount": 987,
  "shippingAddress": AddressInput
}

Types

PurchaseOrderWithInvoiceResult

Description

The result of initiating a purchase order with invoice.

Fields

Field Name	Description
`id` - `String!`	The resulting purchase order ID (same as the idempotency key)
`waitToken` - `String!`	Once a purchase order is received, we will start processing for fraud and final approval. You can use this token to query the current status.

Example

{
  "id": "xyz789",
  "waitToken": "abc123"
}

Types

PurchaseReturnAllInput

Description

A complete return of a purchase.

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the return to us. Max length: 64.
`purchaseId` - `bigint!`	Id of the purchase
`reason` - `String`	Reason for the purchase return. Max length: 10000.
`returnFee` - `Int`	Any return fee charged.

Example

{
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "purchaseId": bigint,
  "reason": "abc123",
  "returnFee": 987
}

Types

PurchaseReturnAllResult

Description

The result of returning a purchase.

Fields

Field Name	Description
`returnId` - `bigint!`	Once a purchase is returned, you can use this token to query the status of return.

Example

{"returnId": bigint}

Types

PurchaseReturnInput

Description

Purchase return.

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	Id of the merchant sending the return to us. Max length: 64.
`purchaseId` - `bigint!`	Id of the purchase
`returnFee` - `Int`	Any return fee charged.
`returnItems` - `[PurchaseReturnItemInput!]!`	List of items returned.
`returnReason` - `String`	Reason for returning the items. Max length: 1000.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "purchaseId": bigint,
  "returnFee": 123,
  "returnItems": [PurchaseReturnItemInput],
  "returnReason": "abc123"
}

Types

PurchaseReturnItemInput

Description

Item return.

Fields

Input Field	Description
`pricePerItem` - `Int!`	Price per item in this line in minor units. It should include tax, but not any discounts. Example: `1500,25` SEK should be `150025`. Example: `100` SEK should be `10000`.
`quantity` - `Int!`	Number of items captured sharing the same reference.
`reference` - `String!`	Unique item identification reference. Max length: 64.
`taxRate` - `Int!`	Tax rate on the items ordered in this line. Needs to be a non-negative number. Example: `15%` discount should be represented as `1500`.
`totalAmount` - `Int!`	Total amount including tax on all the items in this line in minor units. Example: 1500,25 SEK should be 150025. Example: 100 SEK should be 10000.
`totalTaxAmount` - `Int!`	Total tax amount on all the returned items of this type in minor units. Example: 1500,25 SEk should be 150025. Example 100 SEK should be 10000.

Example

{
  "pricePerItem": 987,
  "quantity": 987,
  "reference": "xyz789",
  "taxRate": 123,
  "totalAmount": 123,
  "totalTaxAmount": 987
}

Types

PurchaseReturnResult

Description

The result of processing an item return.

Fields

Field Name	Description
`returnId` - `bigint!`	Query the status of an item return.

Example

{"returnId": bigint}

Types

ReepayWebhookInput

Description

Arguments from Reepay webhook post json

Fields

Input Field	Description
`credit` - `String`	Credit id. Included if the event is an invoice credit.
`creditNote` - `String`	Credit note id. Included if the event relates to an invoice refund or an invoice credit.
`customer` - `String`	Customer handle. Included if event relates to a customer resource.
`eventId` - `String!`	Id of event triggering webhook (see events).
`eventType` - `String!`	The event type (see below and events).
`id` - `String!`	Unique id for webhook. If multiple URL’s are used each request will have different id’s but same event_id.
`invoice` - `String`	Invoice handle. Is inv- if invoice was created automatically for subscription. Included if event relates to an invoice resource.
`paymentMethod` - `String`	Payment method id. Included for the customer_payment_method_added event.
`paymentMethodReference` - `String`	Payment method reference. For a Checkout session the reference will be the session id if it has not been explicitly defined when creating the session.
`signature` - `String!`	Signature to verify the authenticity of the webhook. See below.
`subscription` - `String`	Subscription handle. Included if event relates to a subscription resource.
`timestamp` - `String!`	Timestamp in ISO-8601 when the webhook was triggered.
`transaction` - `String`	For invoice events a transaction id is included if the event was result of a transaction, e.g. a card settle transaction. The transaction id the same as refund id for refunds.

Example

{
  "credit": "xyz789",
  "creditNote": "xyz789",
  "customer": "xyz789",
  "eventId": "xyz789",
  "eventType": "abc123",
  "id": "xyz789",
  "invoice": "xyz789",
  "paymentMethod": "abc123",
  "paymentMethodReference": "xyz789",
  "signature": "abc123",
  "subscription": "xyz789",
  "timestamp": "abc123",
  "transaction": "abc123"
}

Types

ReepayWebhookResult

Description

The result of Repaay Webhook.

Fields

Field Name	Description
`waitToken` - `String!`	Unique reference per unique webhook to return to Reepay when they post webhook notifications

Example

{"waitToken": "xyz789"}

Types

RefreshAisAccountBalanceInput

Description

Arguments for refreshing the account balance for an account using AIS.

Fields

Input Field Description

accountIdentifierId - bigint! The account for which to fetch the balance for.

idempotencyKey - String!

Max length: 64.

organizationId - bigint!

The organization who is initiating the account balance refresh.

Max length: 20.

Example

{
  "accountIdentifierId": bigint,
  "idempotencyKey": "xyz789",
  "organizationId": bigint
}

Types

RefreshAisAccountBalanceResult

Description

The result of refreshing an AIS balance refresh.

Fields

Field Name	Description
`result` - `Boolean!`	The result of initiating an AIS balance refresh.

Example

{"result": false}

Types

RefundBankAccountInfoInput

Description

Information to refund money directly to a bank account

Fields

Input Field	Description
`bic` - `String!`	The BIC of the bank
`ibanAccountNumber` - `String!`	The IBAN account number that the money will be refunded to, e.g. SE3930000000040161303419"
`name` - `String!`	The name of the account holder

Example

{
  "bic": "abc123",
  "ibanAccountNumber": "xyz789",
  "name": "abc123"
}

Types

RefundPaymentInput

Description

Arguments for performing a refund of a paid payment.

Fields

Input Field	Description
`amount` - `Int!`	The amount to be refunded in minor units. So 100,56 kr would be 10056
`bankAccountInfo` - `RefundBankAccountInfoInput`	Bank account information for the refund. If supplied the refund will be directly to the bank account
`createdBy` - `String`	Who is creating the refund. Max length: 100.
`generatedFrom` - `String`	Optional, where is the refund being created, will default to "Portal" when creating a refund from the kronor portal. Max length: 100.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String`	Optional, merchantReference has to be unique across all (non failed) refunds. An error will be returned if there's a collision. Max length: 100.
`message` - `String!`	A message to show to the customer for the refund. Only alphanumeric, Swedish characters, and the following are allowed: ':' ';' '.' ',' '?' '!' '(' ')' '”' '"' ' ' Max length: 50.
`paymentId` - `bigint`	Generated id for the payment after a successful payment.
`paymentTransactionId` - `String`	Transaction ID of the payment to refund.

Example

{
  "amount": 987,
  "bankAccountInfo": RefundBankAccountInfoInput,
  "createdBy": "abc123",
  "generatedFrom": "xyz789",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "message": "abc123",
  "paymentId": bigint,
  "paymentTransactionId": "abc123"
}

Types

RefundPaymentResult

Description

The result of performing a refund of a payment.

Fields

Field Name	Description
`refundTransactionId` - `String!`	Transaction ID of the refund.
`waitToken` - `String!`	Once a refund is initiated, you can use this waitToken to check the status of the refund.

Example

{
  "refundTransactionId": "xyz789",
  "waitToken": "abc123"
}

Types

ReleasePaymentInput

Description

Arguments for performing a release of an uncaptured payment.

Fields

Input Field	Description
`amount` - `Int!`	The amount to be released in minor units. So 100,56 kr would be 10056
`createdBy` - `String`	Who is releasing the payment. Max length: 100.
`generatedFrom` - `String`	Optional, where is the release being created, will default to "Portal" when releasing from the kronor portal. Max length: 100.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String`	Optional, merchantReference has to be unique across all (non failed) releases. An error will be returned if there's a collision. Max length: 100.
`paymentId` - `bigint`	Generated id for the payment after a successful payment.
`paymentTransactionId` - `String`	Transaction ID of the payment to release.

Example

{
  "amount": 123,
  "createdBy": "abc123",
  "generatedFrom": "abc123",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "paymentId": bigint,
  "paymentTransactionId": "abc123"
}

Types

ReleasePaymentResult

Description

The result of performing a release of a payment.

Fields

Field Name	Description
`releaseId` - `String!`	The id of the release attempt.

Example

{"releaseId": "xyz789"}

Types

RemoveUserInput

Description

Remove an user from merchant's pool.

Fields

Input Field	Description
`currentUser` - `String!`	Email of the user that is making the request.
`organizationId` - `bigint!`	Id of the organization Max length: 20.
`removeUsers` - `[RemoveUserSingleInput!]!`	List of users that should be removed.

Example

{
  "currentUser": "xyz789",
  "organizationId": bigint,
  "removeUsers": [RemoveUserSingleInput]
}

Types

RemoveUserResult

Description

Result of the remotion

Fields

Field Name	Description
`usersDeleted` - `Int!`	The number of users deleted.

Example

{"usersDeleted": 123}

Types

RemoveUserSingleInput

Description

Remove users from merchant pool.

Fields

Input Field	Description
`email` - `String!`	Email of the user, for reference.
`userType` - `String!`	One of "google", "password" or "webauthn", indicates the type of user to be remove. Max length: 64.

Example

{
  "email": "abc123",
  "userType": "xyz789"
}

Types

RenewNordeaKeyInput

Description

Starts the renewal of the signing key for the given authorizer.

Fields

Input Field	Description
`currentUser` - `String!`	Email of the user that is making the request.
`nordeaAuthorizerId` - `bigint!`	ID of the authorizer whose signing key need to be renewed
`organizationId` - `bigint!`	Id of the organization Max length: 20.

Example

{
  "currentUser": "xyz789",
  "nordeaAuthorizerId": bigint,
  "organizationId": bigint
}

Types

RenewNordeaKeyResult

Description

Result of adding a new Nordea key

Fields

Field Name	Description
`nordeaKeyId` - `bigint!`	The ID of the new Nordea key

Example

{"nordeaKeyId": bigint}

Types

ResendInvoiceEmailInput

Description

Used to resend the invoice email

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`invoiceId` - `bigint!`	Id of the invoice Max length: 64.
`merchantId` - `bigint!`	Id of the merchant Max length: 64.
`purchaseId` - `bigint!`	Id of the purchase Max length: 64.

Example

{
  "idempotencyKey": "xyz789",
  "invoiceId": bigint,
  "merchantId": bigint,
  "purchaseId": bigint
}

Types

ResendInvoiceEmailResult

Description

The result of the email resend request.

Fields

Field Name	Description
`result` - `Boolean!`	What happened with the email resent request.

Example

{"result": false}

Types

RestartCaptureStatusCheckInput

Description

Arguments needed to recheck the capture status.

Fields

Input Field Description

captureId - bigint! The capture to have its status rechecked.

idempotencyKey - String!

Max length: 64.

merchantId - bigint! The merchant requesting the recheck.

Example

{
  "captureId": bigint,
  "idempotencyKey": "xyz789",
  "merchantId": bigint
}

Types

RestartCaptureStatusCheckResult

Description

The result of restarting a refund status check/polling.

Fields

Field Name	Description
`status` - `Boolean!`	Result of the recheck attempt.

Example

{"status": true}

Types

RestartPaymentStatusCheckInput

Description

Arguments need to recheck the payment status.

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint! The merchant requesting the recheck.

paymentId - String! The payment to have its status rechecked.

Example

{
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "paymentId": "abc123"
}

Types

RestartPaymentStatusCheckResult

Description

The result of restarting a payment status check/polling.

Fields

Field Name	Description
`status` - `Boolean!`	Result of the recheck attempt.

Example

{"status": true}

Types

RestartRefundStatusCheckInput

Description

Arguments need to recheck the refund status.

Fields

Input Field Description

idempotencyKey - String!

Max length: 64.

merchantId - bigint! The merchant requesting the recheck.

refundId - String! The refund to have its status rechecked.

Example

{
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "refundId": "xyz789"
}

Types

RestartRefundStatusCheckResult

Description

The result of restarting a refund status check/polling.

Fields

Field Name	Description
`status` - `Boolean!`	Result of the recheck attempt.

Example

{"status": true}

Types

RevokeAisSessionInput

Description

Arguments for revoking an authorized AIS session.

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	The organization who is initiating the AIS session revoke operation. Max length: 20.
`revokedBy` - `String`	The user who is revoking the AIS session.
`sessionId` - `String!`	The session that will be revoked.

Example

{
  "idempotencyKey": "xyz789",
  "organizationId": bigint,
  "revokedBy": "abc123",
  "sessionId": "xyz789"
}

Types

RevokeAisSessionResult

Description

The result of revoking an AIS authorized session.

Fields

Field Name	Description
`result` - `Boolean!`	The result of revoking an AIS authorized session.

Example

{"result": true}

Types

ScheduleCurrencyTradingInput

Description

Arguments for starting a new currency trading operation.

Fields

Input Field	Description
`amount` - `Int!`	The amount of currency to trade. See `nominalCurrency` for more information.
`currencyToBuy` - `SupportedCurrencyEnum!`	Currency to buy
`currencyToPayWith` - `SupportedCurrencyEnum!`	Currency to pay with
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`nominalCurrency` - `SupportedCurrencyEnum!`	This is the currency the amount field is considered to be in. For example: If you want to buy as many USD as you can get for 1000 SEK, the amount is 1000 and nominal currency is SEK, the currencyToBuy is USD and currencyToPayWith is SEK. If you just want to buy exactly 1000 USD, the amount is 1000 and nominal currency is USD, the currencyToBuy is USD and the currencyToPayWith is SEK.
`organizationId` - `bigint!`	The organization that is initiating the payment. Max length: 20.
`settlementDate` - `String`	Settlement date of the contract. A spot rate with settlement date as the current day will be used when the value is not sent.

Example

{
  "amount": 987,
  "currencyToBuy": "CHF",
  "currencyToPayWith": "CHF",
  "idempotencyKey": "abc123",
  "nominalCurrency": "CHF",
  "organizationId": bigint,
  "settlementDate": "xyz789"
}

Types

ScheduleCurrencyTradingResult

Description

The result of starting a new currency trading operation.

Fields

Field Name	Description
`waitToken` - `String!`	Id of the row in the treasury.fx_forward table representing this request

Example

{"waitToken": "xyz789"}

Types

SetClearhausAcquirerInfoInput

Description

Sets clearhaus api key and related account information to use them as acquirer for credit card payments.

Fields

Input Field	Description
`acquirerApiKey` - `String!`	API key, this is the username `-u` in curl requests Note that the country and currency for which to use these credentials will be set to the values returned in the account information from clearhaus for this api key
`acquirerPrivateKey` - `String`	POST requests to clearhaus will be signed using this key. The public key should be shared with Clearhaus during integration
`acquirerSigningKey` - `String`	The signing key identifies Clearhaus' partner
`currentUser` - `String`	Email of the user that is making the request.
`merchantId` - `bigint!`	Id of the merchant Max length: 20.
`useDefaultPrivateSigningKey` - `Boolean!`	When set to True, Kronor's existing private and signing key registered with clearhaus will be used. When set to False, acquirerPrivateKey and acquirerSigningKey must be set

Example

{
  "acquirerApiKey": "abc123",
  "acquirerPrivateKey": "xyz789",
  "acquirerSigningKey": "abc123",
  "currentUser": "abc123",
  "merchantId": bigint,
  "useDefaultPrivateSigningKey": true
}

Types

SetClearhausAcquirerInfoResult

Description

Result of calling SetClearhausAcquirerInfo

Fields

Field Name	Description
`acquirerSettingId` - `bigint!`	IDs of clearhaus acquirer setting. Can subscribe on this id to later to fetch any clearhaus account related information

Example

{"acquirerSettingId": bigint}

Types

SetOrganizationWebhookUrlInput

Description

Once a notification is sent to this URL, the server must respond with the string [accepted] within 10 seconds to acknowledge the webhook.

Otherwise, the notification will be retried at a later time and all future notifications will be queued until they can get properly acknowledged.

Fields

Input Field Description

organizationId - bigint! The organization to whom the notification has to be sent via the webhook URL.

webhookUrl - String!

URL to which the webhook notifications will be sent

Max length: 1000.

Example

{
  "organizationId": bigint,
  "webhookUrl": "xyz789"
}

Types

SetOrganizationWebhookUrlResult

Description

The result of setting a webhook URL.

Fields

Field Name	Description
`hmacSecret` - `String!`	The secret used to sign webhook requests with HMAC
`webhookUrl` - `String!`	URL to which the webhook notifications will be sent

Example

{
  "hmacSecret": "abc123",
  "webhookUrl": "xyz789"
}

Types

SetWebhookUrlInput

Description

Once a notification is sent to this URL, the server must respond with the string [accepted] within 10 seconds to acknowledge the webhook.

Otherwise, the notification will be retried at a later time and all future notifications will be queued until they can get properly acknowledged.

Fields

Input Field Description

eventSettings - [MerchantWebhookEventSetting!]! List of event settings for which the webhook notifications will be sent.

merchantId - bigint! The merchant to whom the notification has to be sent via the webhook URL.

webhookUrl - String!

URL to which the webhook notifications will be sent

Max length: 1000.

Example

{
  "eventSettings": [MerchantWebhookEventSetting],
  "merchantId": bigint,
  "webhookUrl": "xyz789"
}

Types

SetWebhookUrlResult

Description

The result of setting a webhook URL.

Fields

Field Name	Description
`hmacSecret` - `String!`	The secret used to sign webhook requests with HMAC
`webhookUrl` - `String!`	URL to which the webhook notifications will be sent

Example

{
  "hmacSecret": "xyz789",
  "webhookUrl": "xyz789"
}

Types

StartAisAuthorizationInput

Description

Arguments for starting a new AIS authorization.

Fields

Input Field	Description
`authConfigId` - `bigint!`	The authorization config to use for this authorization
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`organizationId` - `bigint!`	The organization who is initiating the authorization. Max length: 20.
`returnUrl` - `String!`	The return URL the user will be redirected to after the authorization is completed

Example

{
  "authConfigId": bigint,
  "idempotencyKey": "xyz789",
  "organizationId": bigint,
  "returnUrl": "abc123"
}

Types

StartAisAuthorizationResult

Description

The result of attempting an AIS authorization.

Fields

Field Name	Description
`waitToken` - `String!`	The token used for polling the authorization status

Example

{"waitToken": "xyz789"}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

SupportedCurrencyEnum

Description

List of currencies supported by us.

Values

Enum Value	Description
`CHF`	Swiss Franc, the currency of Switzerland
`CZK`	Czech Koruna, the currency of the Czech Republic
`DKK`	Danish Krone, currency of Denmark
`EUR`	Euro, Currency for the states in Eurozone
`GBP`	British Pound Sterling, the currency of the United Kingdom
`HUF`	Hungarian Forint, the currency of Hungary
`ISK`	Icelandic Krona, currency of Iceland
`NOK`	Norwegian Krone, currency of Norway
`PLN`	Polish Zloty, currency of Poland
`RON`	Romanian Leu, the currency of Romania
`SEK`	Swedish Krona, currency of Sweden
`USD`	United States Dollar, the currency of the United States

Example

"CHF"

Types

SwishCallbackInput

Description

Arguments from Swish for payment status updation

Fields

Input Field	Description
`amount` - `Float!`	The amount the customer pays
`callbackIdentifier` - `String`	The callback identifier for the Swish payment.
`callbackUrl` - `String!`	The callback URL that Swish uses to let us know of the status of the payment.
`currency` - `String!`	The currency of the payment
`dateCreated` - `String!`	The date the payment was created on Swish
`datePaid` - `String`	The date the user paid
`errorCode` - `String`	The error code by Swish
`errorMessage` - `String`	The error message for the Swish payment
`id` - `String!`	The instruction UUID that we create a Swish payment request with.
`message` - `String!`	The message for the payment
`payeeAlias` - `String!`	The Swish number the customer is paying to
`payeePaymentReference` - `String`	The reference for the payment.
`payerAlias` - `String`	The Swish number of the customer
`paymentReference` - `String!`	The reference for the payment for Swish.
`status` - `SwishPaymentStatus!`	The status of the payment
`token` - `String!`	The token used for the Swish callback to identify merchantId and paymentId

Example

{
  "amount": 123.45,
  "callbackIdentifier": "abc123",
  "callbackUrl": "xyz789",
  "currency": "xyz789",
  "dateCreated": "xyz789",
  "datePaid": "xyz789",
  "errorCode": "xyz789",
  "errorMessage": "xyz789",
  "id": "abc123",
  "message": "xyz789",
  "payeeAlias": "xyz789",
  "payeePaymentReference": "abc123",
  "payerAlias": "xyz789",
  "paymentReference": "abc123",
  "status": "CANCELLED",
  "token": "xyz789"
}

Types

SwishCallbackResult

Description

The result of Swish callback.

Fields

Field Name	Description
`status` - `String!`	Placeholder response to return to Swish when they post the payment status

Example

{"status": "abc123"}

Types

SwishPaymentCancelInput

Description

Arguments for cancelling a swish payment

Fields

Input Field	Description
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`paymentId` - `String!`	The payment id to cancel, this is obtained when a payment request is made. As opposed to a payment_reference which is the same across multiple payment attempts, this is unique only for each specific payment. Max length: 64.
`paymentReference` - `String!`	The payment reference to cancel, this is obtained before we decide to make a payment, i.e. when we create a payment session.

Example

{
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "paymentId": "xyz789",
  "paymentReference": "abc123"
}

Types

SwishPaymentCancelResult

Description

The result of cancelling a swish payment request.

Fields

Field Name	Description
`waitToken` - `String!`	The returned token can be used to query whether the payment has been cancelled or not.

Example

{"waitToken": "xyz789"}

Types

SwishPaymentInput

Description

Arguments for creating a new swish payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`customerSwishNumber` - `String`	The Swish number of the customer, required for the 'ecom' flow
`flow` - `String!`	Payment flow, either 'ecom' or 'mcom' Max length: 64.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. These have to be globally unique but they should be reused for retrying a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their swish payment screen. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying this payment.
`returnUrl` - `String!`	The url to return to after the payment is done.

Example

{
  "amount": 987,
  "customerSwishNumber": "abc123",
  "flow": "abc123",
  "idempotencyKey": "xyz789",
  "merchantId": bigint,
  "merchantReference": "abc123",
  "merchantReturnUrl": "abc123",
  "message": "xyz789",
  "paymentCategory": "Account",
  "paymentReference": "abc123",
  "returnUrl": "xyz789"
}

Types

SwishPaymentResult

Description

The result of initiating a swish payment.

Fields

Field Name	Description
`waitToken` - `String!`	Once a payment is initialized, we will start the swish payment workflow. You can use this token to query the current status of the payment.

Example

{"waitToken": "abc123"}

Types

SwishPaymentStatus

Description

Payment Status as returned by Swish

Values

Enum Value	Description
`CANCELLED`
`CREATED`
`DECLINED`
`ERROR`
`PAID`

Example

"CANCELLED"

Types

SwishRefundCallbackInput

Description

Arguments from Swish for payment status updation

Fields

Input Field	Description
`additionalInformation` - `String`	Additional information related to the Swish refund
`amount` - `Float!`	The amount that was refunded.
`callbackIdentifier` - `String`	The callback identifier for the Swish refund.
`callbackUrl` - `String!`	The callback URL that Swish uses to let us know of the status of the refund.
`currency` - `String!`	The currency of the payment
`dateCreated` - `String!`	The date the payment was created on Swish
`datePaid` - `String`	The date the user paid
`errorCode` - `String`	The error code by Swish
`errorMessage` - `String`	The error message for the Swish payment
`id` - `String!`	The instruction UUID that we create a Swish refund request with.
`message` - `String!`	The message for the payment
`originalPaymentReference` - `String!`	The payment reference that corresponds to the original Swish payment this refund relates to
`payeeAlias` - `String!`	The Swish number of the customer receiving the refund.
`payerAlias` - `String!`	The Swish number of the merchant performing the refund.
`payerPaymentReference` - `String`	The reference for the payment.
`paymentReference` - `String`	The reference for the refund for Swish.
`status` - `SwishRefundStatus!`	The status of the refund
`token` - `String!`	The token used for the Swish callback to identify merchantId and refundId

Example

{
  "additionalInformation": "abc123",
  "amount": 987.65,
  "callbackIdentifier": "xyz789",
  "callbackUrl": "xyz789",
  "currency": "xyz789",
  "dateCreated": "abc123",
  "datePaid": "abc123",
  "errorCode": "abc123",
  "errorMessage": "abc123",
  "id": "abc123",
  "message": "abc123",
  "originalPaymentReference": "xyz789",
  "payeeAlias": "abc123",
  "payerAlias": "xyz789",
  "payerPaymentReference": "abc123",
  "paymentReference": "xyz789",
  "status": "DEBITED",
  "token": "abc123"
}

Types

SwishRefundStatus

Description

Refund Status as returned by Swish

Values

Enum Value	Description
`DEBITED`
`ERROR`
`PAID`

Example

"DEBITED"

Types

ToggleAcquirerAvailabilityInput

Description

Enable / disable the supplied acquirer id

Fields

Input Field	Description
`acquirerId` - `bigint!`	Acquirer id to enable / disable. You can get the id from acquirerEnabled query
`currentUser` - `String`	Email of the user that is making the request.
`enable` - `Boolean!`	True to enable, False to disable. Note that only one acquirer can be enabled at a time for one payment_method, currency, country combination. So first disable the active acquirer and enable another one
`merchantId` - `bigint!`	Id of the merchant Max length: 20.

Example

{
  "acquirerId": bigint,
  "currentUser": "abc123",
  "enable": true,
  "merchantId": bigint
}

Types

ToggleAcquirerAvailabilityResult

Description

Result of enabling / disabling acquirer availability

Fields

Field Name	Description
`acquirerId` - `bigint!`	ID of the acquirer enabled / disabled

Example

{"acquirerId": bigint}

Types

TogglePaymentMethodAvailabilityInput

Description

Toggle if a payment method should be available to use

Fields

Input Field	Description
`gatewayId` - `bigint!`	The gateway ID for a given gateway, country, currency that should be enabled/disabled
`merchantId` - `bigint!`	Id of the merchant Max length: 64.
`shouldBeEnabled` - `Boolean!`	Whether or not the payment method should be enabled

Example

{
  "gatewayId": bigint,
  "merchantId": bigint,
  "shouldBeEnabled": true
}

Types

TogglePaymentMethodAvailabilityResult

Description

The result of a togglePaymentMethodAvailability mutation.

Fields

Field Name	Description
`enabled` - `Boolean!`	Whether or not the payment method is enabled after the mutation

Example

{"enabled": true}

Types

TriggerPayPalMerchantOnboardingCheckInput

Description

Arguments to trigger a check for PayPal merchant onboarding status

Fields

Input Field	Description
`consentStatus` - `Boolean!`	Whether or not consent was given
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`isEmailConfirmed` - `Boolean!`	Whether or not the merchant's email is confirmed on PayPal
`merchantId` - `bigint!`	The merchant id of the merchant who finished the onboarding process. Max length: 64.
`sellerPayPalMerchantId` - `String!`	The PayPal merchant id of the merchant who finished the onboarding process. Max length: 64.
`trackingId` - `String!`	The tracking id of the merchant who finished the onboarding process. Max length: 64.

Example

{
  "consentStatus": true,
  "idempotencyKey": "xyz789",
  "isEmailConfirmed": false,
  "merchantId": bigint,
  "sellerPayPalMerchantId": "xyz789",
  "trackingId": "abc123"
}

Types

TriggerPayPalMerchantOnboardingResult

Description

The result of a triggerPayPalOnboardingStatusCheck mutation.

Fields

Field Name	Description
`result` - `Boolean!`	Whether or not the trigger was successful

Example

{"result": false}

Types

UnblockCustomerInput

Description

Unblock customer

Fields

Input Field	Description
`customerEmail` - `String`	Email of the customer
`customerSsn` - `String`	SSN of the customer
`merchantId` - `bigint!`	Id of the merchant Max length: 64.

Example

{
  "customerEmail": "abc123",
  "customerSsn": "abc123",
  "merchantId": bigint
}

Types

UnblockCustomerResult

Description

Unblocked customers

Fields

Field Name	Description
`affectedCustomerIds` - `[Int!]!`	IDs of customers that are no longer blocked

Example

{"affectedCustomerIds": [987]}

Types

UpdateTransactionReportAccountInput

Description

A single AIS account entry used in UpdateTransactionReportAccountsInput.

Fields

Input Field Description

accountId - bigint! AIS Account ID

enabled - Boolean! Indicates whether a transaction report should be generated for this account

organizationId - bigint!

The organization who is initiating the transaction report updation.

Max length: 20.

Example

{
  "accountId": bigint,
  "enabled": false,
  "organizationId": bigint
}

Types

UpdateTransactionReportAccountsInput

Description

Updates the settings for which AIS accounts transaction reports should be generated

Fields

Input Field	Description
`accounts` - `[UpdateTransactionReportAccountInput!]!`	A list with new purchase items to add to this order.

Example

{"accounts": [UpdateTransactionReportAccountInput]}

Types

UpdateTransactionReportAccountsResult

Description

The result of updating transaction report settings for accounts

Fields

Field Name	Description
`success` - `Boolean!`	Whether operation succeeded to schedule an authorization

Example

{"success": true}

Types

VippsPaymentInput

Description

Arguments for creating a new Vipps payment

Fields

Input Field	Description
`amount` - `Int!`	The amount the customer pays in minor units. So 100,56 kr would be 10056. Amount should be between 1 and 9.999.999,99
`expiresAt` - `String!`	Session expiry timestamp in ISO8601 format.
`idempotencyKey` - `String!`	Idempotency key is required to prevent double processing a request. It is recommended to use a deterministic unique value, such as the combination of the order id and the customer id. Avoid using time-based values. Only alphanumeric character and the following are allowed: "-" "_" "." "," "[" "]" "+" Max length: 64.
`merchantId` - `bigint!`	The merchant who is initiating the payment. Max length: 64.
`merchantReference` - `String!`	Merchant's own internal reference that may help the merchant in identifying this payment. It is recommended that these are unique per merchant but this is not checked anywhere a payment. Max length: 64.
`merchantReturnUrl` - `String`	The original return url as provided by the merchant.
`message` - `String!`	A message to show to the customer on their Vipps payment screen. It could be an order id or a reference. Max length: 50.
`paymentCategory` - `PaymentCategory!`	Payment category that determines the payment flow
`paymentReference` - `String!`	Our system's own internal reference that can be used uniquely in identifying the session this payment belongs to. Multiple attempts can be made with the same paymentReference, changing the idempotency key, but there can be only one successful payment.
`returnUrl` - `String!`	The url to return to after the payment is done. If the payment screen is opened on a separate window, customer will be redirected here on payment success or error.

Example

{
  "amount": 123,
  "expiresAt": "abc123",
  "idempotencyKey": "abc123",
  "merchantId": bigint,
  "merchantReference": "xyz789",
  "merchantReturnUrl": "abc123",
  "message": "abc123",
  "paymentCategory": "Account",
  "paymentReference": "abc123",
  "returnUrl": "xyz789"
}

Types

VippsPaymentResult

Description

The result of initiating a Vipps payment.

Fields

Field Name	Description
`waitToken` - `String!`	Once a payment is initialized, we will start the Vipps payment workflow. You can use this token to query the current status of the payment, with paymentRequests query.

Example

{"waitToken": "abc123"}

Types

bigint

Example

bigint

Documentation by Anvil SpectaQL