Checkout 3.0
In-Store
Finalize In-Store payment

Get status of an in-store payment

To find out and monitor the status of an in-store payment, you have two ways:

  • Subscribe to our Server-side Callback by specifying the URL we should call in “completedNotificationUrl” in Initialize Payment
  • Poll for status

Server-side Callback

We strongly recommend you to use the Server-side Callback in order to get notified when a payment is completed in the checkout. When you receive the callback, immediately call for status of the payment from Payment Status endpoint. See “Poll for status” below.

Poll for status

You can poll our in-store API to get information about the session. When purchase is completed in checkout you’ll get all information you need from the Payment Status response.

# Get payment status
GET {api_url}/api/instore/partner/{purchaseId}
Content-type: application/json
Authorization: Bearer {partner_access_token}

Return value

{
  "inStore": {
    "state": "Sent",
    "hiddenPaymentMethods": ["Invoice"],
    "customerVerified": true,
    "paymentLink": "string"
  },
  "purchaseId": "string",
  "state": "PreInitialized",
  "processedBackEnd": true,
  "totalPrice": 0,
  "createdUtc": "2024-09-19T06:49:02.111Z",
  "expiredUtc": "2024-09-19T06:49:02.111Z",
  "checkoutSite": {
    "siteCode": "string",
    "countryCode": "string",
    "currencyCode": "string"
  },
  "mode": "B2C",
  "b2C": {
    "step": {
      "customerToken": "string",
      "current": "Initialized",
      "rememberMe": "Hidden",
      "smsNewsletterSubscription": "Hidden",
      "emailNewsletterSubscription": "Hidden"
    },
    "userInputs": {
      "email": "string",
      "zip": "string",
      "ssn": "string",
      "phone": "string",
      "gender": "Undefined",
      "dateOfBirth": "string"
    },
    "invoicingAddress": {
      "address1": "string",
      "address2": "string",
      "street": "string",
      "houseNumber": "string",
      "zip": "string",
      "city": "string",
      "doorCode": "string",
      "firstName": "string",
      "lastName": "string",
      "country": "AF",
      "careOfAddress": true
    },
    "deliveryAddress": {
      "address1": "string",
      "address2": "string",
      "street": "string",
      "houseNumber": "string",
      "zip": "string",
      "city": "string",
      "doorCode": "string",
      "country": "AF",
      "type": "Default",
      "viewType": "Unchecked",
      "firstName": "string",
      "lastName": "string",
      "phoneCountryTwoLetterIso": "string",
      "phone": "string",
      "email": "string"
    }
  },
  "b2B": {
    "step": {
      "current": "Initialized",
      "rememberMe": "Hidden",
      "smsNewsletterSubscription": "Hidden",
      "emailNewsletterSubscription": "Hidden"
    },
    "userInputs": {
      "email": "string",
      "zip": "string",
      "organizationNumber": "string",
      "customerSsn": "string",
      "phone": "string",
      "reference": "string",
      "gender": "Undefined",
      "dateOfBirth": "string"
    },
    "customerInfo": {
      "firstName": "string",
      "lastName": "string"
    },
    "invoicingAddress": {
      "address1": "string",
      "address2": "string",
      "street": "string",
      "houseNumber": "string",
      "zip": "string",
      "city": "string",
      "doorCode": "string",
      "name": "string",
      "country": "AF",
      "careOfAddress": true
    },
    "deliveryAddress": {
      "address1": "string",
      "address2": "string",
      "street": "string",
      "houseNumber": "string",
      "zip": "string",
      "city": "string",
      "doorCode": "string",
      "country": "AF",
      "type": "Default",
      "viewType": "Unchecked",
      "firstName": "string",
      "lastName": "string",
      "phoneCountryTwoLetterIso": "string",
      "phone": "string",
      "email": "string"
    }
  },
  "items": [
    {
      "description": "string",
      "notes": "string",
      "amount": 0,
      "taxCode": "string",
      "taxAmount": 0,
      "quantity": 0
    }
  ],
  "authenticationType": "None",
  "paymentMethods": {
    "selectedPayment": {
      "type": "Invoice",
      "recurringPayment": "Hidden",
      "recurringPaymentToken": "string",
      "paymentFee": 0,
      "accountClassId": "string",
      "accountClassCode": 0,
      "paymentTerms": 0
    }
  },
  "cardPaymentState": {
    "maskedCardNumber": "string",
    "cardBrand": "string",
    "cardExpirationDate": "string"
  },
  "customerBalance": 0
}