Quickpay

https://learn.quickpay.net/
Admin
Quickpay is a payment service provider that allows merchants to accept secure payments through...
Tokens:68,111
Snippets:391
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get a resource via HTTP GET

Source: https://learn.quickpay.net/tech-talk/api

Example of a GET request to retrieve a resource, including required authentication and version headers.

```http
GET /resource/<Identifier> HTTP/1.1
Host: api.quickpay.net
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept-Version: v10
Accept: application/json

```

--------------------------------

### GET /shopify-settings

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves a paginated list of all Shopify settings.

```APIDOC
## GET /shopify-settings

### Description
Retrieves a list of all Shopify settings with support for pagination and sorting.

### Method
GET

### Endpoint
/shopify-settings

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **page** (integer) - Optional - Pagination page. Default is 1
- **page_size** (integer) - Optional - Items per page. Default is 20
- **sort_by** (string) - Optional - Property to sort by. Default is id
- **sort_dir** (string) - Optional - Sort direction (asc, desc). Default is desc

### Response
#### Success Response (200)
- **id** (integer) - ID
- **shop_domain** (string) - Shop domain for the shopify app
- **app_name** (integer) - App name for the shopify app
- **payment_methods_exp** (object) - Payment Methods authorization expiry days
```

--------------------------------

### GET /acquirers/pproprzelewy24

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the PPROPrzelewy24 acquirer settings.

```APIDOC
## GET /acquirers/pproprzelewy24

### Description
Get PPROPrzelewy24 acquirer settings.

### Method
GET

### Endpoint
/acquirers/pproprzelewy24

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
```

--------------------------------

### GET /changelog

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the API changelog.

```APIDOC
## GET /changelog

### Description
Get the API Changelog

### Method
GET

### Endpoint
/changelog

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Optional - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- OK
```

--------------------------------

### GET /ping

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Tests connectivity to the API using a GET request.

```APIDOC
## GET /ping

### Description
Use this to test connectivity to the API.

### Method
GET

### Endpoint
/ping

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Optional - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **msg** (string) - Friendly message
- **scope** (string) - API scope (anonymous, user, merchant, reseller)
- **version** (string) - The version ('v10')
- **params** (Hash) - Echo params send in the request
```

--------------------------------

### GET /acquirers/pproblik

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the PPROBlik acquirer settings.

```APIDOC
## GET /acquirers/pproblik

### Description
Get PPROBlik acquirer settings.

### Method
GET

### Endpoint
/acquirers/pproblik

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
```

--------------------------------

### GET /acquirers/trustly

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Trustly acquirer.

```APIDOC
## GET /acquirers/trustly

### Description
Retrieves the current configuration settings for the Trustly acquirer.

### Method
GET

### Endpoint
/acquirers/trustly

### Parameters
#### Request Headers
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **username** (string) - Trustly API username
- **password** (string) - Trustly API password
- **ideal** (boolean) - iDeal through Trustly
```

--------------------------------

### GET /acquirers/unzerpaylater

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the UnzerPayLater acquirer.

```APIDOC
## GET /acquirers/unzerpaylater

### Description
Get UnzerPayLater acquirer settings.

### Method
GET

### Endpoint
/acquirers/unzerpaylater

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- OK

#### Error Responses
- 403 (Not authorized)
```

--------------------------------

### GET /acquirers/vippspsp

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the VippsPSP acquirer.

```APIDOC
## GET /acquirers/vippspsp

### Description
Retrieves the current configuration settings for the VippsPSP acquirer.

### Method
GET

### Endpoint
/acquirers/vippspsp

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **msn** (string) - Vipps Merchant Serial Number
```

--------------------------------

### GET /acquirers/vmpepayment

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the VMPEpayment acquirer.

```APIDOC
## GET /acquirers/vmpepayment

### Description
Retrieves the current configuration settings for the VMPEpayment acquirer.

### Method
GET

### Endpoint
/acquirers/vmpepayment

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **msn** (string) - Vipps MobilePay Merchant Serial Number
- **currencies** (string[]) - Currencies
- **recurring** (boolean) - True if recurring is enabled
- **epayment** (boolean) - True if ePayment is enabled
- **migrated** (boolean) - True if the acquirer was migrated to VMPEpayment
```

--------------------------------

### GET /acquirers/coinify

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current settings for the Coinify acquirer.

```APIDOC
## GET /acquirers/coinify

### Description
Get Coinify acquirer settings.

### Method
GET

### Endpoint
/acquirers/coinify

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- OK

#### Error Responses
- 403: Not authorized
```

--------------------------------

### GET /acquirers/pprowechatpay

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the PPROWeChatPay acquirer.

```APIDOC
## GET /acquirers/pprowechatpay

### Description
Retrieves the current configuration settings for the PPROWeChatPay acquirer.

### Method
GET

### Endpoint
/acquirers/pprowechatpay

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
```

--------------------------------

### GET /acquirers/swish

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Swish acquirer.

```APIDOC
## GET /acquirers/swish

### Description
Get Swish acquirer settings.

### Method
GET

### Endpoint
/acquirers/swish

### Parameters
#### Path Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **OK**
```

--------------------------------

### GET /acquirers/ppro

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the PPRO acquirer.

```APIDOC
## GET /acquirers/ppro

### Description
Get PPRO acquirer settings.

### Method
GET

### Endpoint
/acquirers/ppro

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **contract_id** (string) - Defines the merchant for whom PPRO is processing the transaction
```

--------------------------------

### GET /acquirers/anydaysplit

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the AnydaySplit acquirer.

```APIDOC
## GET /acquirers/anydaysplit

### Description
Retrieves the AnydaySplit acquirer settings.

### Method
GET

### Endpoint
/acquirers/anydaysplit

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **access_token** (string) - Anyday api key
- **private_key** (string) - Anyday private key
```

--------------------------------

### GET /acquirers/pprosofort

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the PPROSofort acquirer.

```APIDOC
## GET /acquirers/pprosofort

### Description
Retrieves the current configuration settings for the PPROSofort acquirer.

### Method
GET

### Endpoint
/acquirers/pprosofort

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
```

--------------------------------

### GET /acquirers/bambora

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Bambora acquirer.

```APIDOC
## GET /acquirers/bambora

### Description
Retrieves the Bambora acquirer settings.

### Method
GET

### Endpoint
/acquirers/bambora

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **identification_code** (string) - Bambora identification number
- **identification_code_int** (string) - Bambora international identification number
- **business_code** (string) - Bambora business code
- **recurring** (boolean) - True if recurring is enabled
- **americanexpress** (boolean) - True if american express is enabled
- **dinersclub** (boolean) - True if Diners Club is enabled
- **securepay** (boolean) - True if Teller SecurePay fraud detection is enabled
- **visa_mpi_merchant_id** (string) - VISA MPI Merchant id used for 3D Secure
- **mastercard_mpi_merchant_id** (string) - Mastercard MPI Merchant id used for 3D Secure
- **visa_bin** (string) - Bambora VISA acquirer bin used for 3D Secure
- **mastercard_bin** (string) - Bambora Mastercard acquirer bin used for 3D Secure
- **local_tz** (string) - Local timezone of the merchant, described as tz database name
```

--------------------------------

### GET /acquirers/sofort

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Sofort acquirer.

```APIDOC
## GET /acquirers/sofort

### Description
Retrieves the current configuration settings for the Sofort acquirer.

### Method
GET

### Endpoint
/acquirers/sofort

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **customer_number** (integer) - Sofort customer number
- **project_id** (integer) - Sofort gateway project id
- **api_key** (string) - Sofort api-key
- **gateway** (boolean) - Sofort gateway feature enabled
- **ideal** (boolean) - Sofort iDeal feature enabled
- **ideal_project_id** (integer) - Sofort iDeal project id
- **ideal_project_password** (string) - Sofort iDeal project password
- **ideal_notification_password** (string) - Sofort iDeal notification password
```

--------------------------------

### GET /acquirers/klarnapayments

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the KlarnaPayments acquirer.

```APIDOC
## GET /acquirers/klarnapayments

### Description
Get KlarnaPayments acquirer settings.

### Method
GET

### Endpoint
/acquirers/klarnapayments

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **uid** (string) - Klarna username
- **password** (string) - Klarna password
```

--------------------------------

### GET /acquirers/paypal

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the PayPal acquirer.

```APIDOC
## GET /acquirers/paypal

### Description
Get PayPal acquirer settings.

### Method
GET

### Endpoint
/acquirers/paypal

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **recurring** (boolean) - True if recurring is enabled
- **credit_card** (boolean) - True if credit-card payments is enabled
- **token** (string) - Authentication token
- **token_secret** (string) - Authentication token secret
- **scope** (string[]) - Scopes token grants access to
```

--------------------------------

### GET /acquirers/valitor

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Valitor acquirer.

```APIDOC
## GET /acquirers/valitor

### Description
Get Valitor acquirer settings.

### Method
GET

### Endpoint
/acquirers/valitor

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- OK
```

--------------------------------

### GET /shopify-settings/{id}

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the details of a specific Shopify setting by its ID.

```APIDOC
## GET /shopify-settings/{id}

### Description
Finds and returns the Shopify settings configuration for a specific ID.

### Method
GET

### Endpoint
/shopify-settings/{id}

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Path Parameters
- **id** (integer) - Required - Shopify settings id

### Response
#### Success Response (200)
- **id** (integer) - ID
- **shop_domain** (string) - Shop domain for the shopify app
- **app_name** (integer) - App name for the shopify app
- **payment_methods_exp** (object) - Payment Methods authorization expiry days
```

--------------------------------

### GET /acquirers/swedbank

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Swedbank acquirer.

```APIDOC
## GET /acquirers/swedbank

### Description
Retrieves the current configuration settings for the Swedbank acquirer.

### Method
GET

### Endpoint
/acquirers/swedbank

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **identification_code** (string) - Swedbank identification number
- **identification_code_int** (string) - Swedbank international identification number
- **business_code** (string) - Swedbank business code
- **recurring** (boolean) - True if recurring is enabled
- **americanexpress** (boolean) - True if american express is enabled
- **dinersclub** (boolean) - True if Diners Club is enabled
- **securepay** (boolean) - True if Teller SecurePay fraud detection is enabled
- **visa_mpi_merchant_id** (string) - VISA MPI Merchant id used for 3D Secure
- **mastercard_mpi_merchant_id** (string) - Mastercard MPI Merchant id used for 3D Secure
- **visa_bin** (string) - Swedbank VISA acquirer bin used for 3D Secure
- **mastercard_bin** (string) - Swedbank Mastercard acquirer bin used for 3D Secure
- **local_tz** (string) - Local timezone of the merchant, described as tz database name
```

--------------------------------

### GET /acquirers/paysafecard

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current configuration settings for the Paysafecard acquirer.

```APIDOC
## GET /acquirers/paysafecard

### Description
Get Paysafecard acquirer settings.

### Method
GET

### Endpoint
/acquirers/paysafecard

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **username** (string) - Paysafecard username
- **password** (string) - Paysafecard password
- **currencies** (string[]) - Paysafecard currencies
```

--------------------------------

### GET /brandings

Source: https://learn.quickpay.net/tech-talk/api/services

Retrieves a list of brandings with support for pagination and filtering.

```APIDOC
## GET /brandings

### Description
Retrieves a list of brandings. Supports pagination, sorting, and attribute filtering.

### Method
GET

### Endpoint
/brandings

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **except** (string) - Optional - Specifies which attributes to skip. Default is 'resources.data'
- **only** (string) - Optional - Specifies which attributes to include.
- **page** (integer) - Optional - Pagination page. Default is 1
- **page_size** (integer) - Optional - Items per page. Default is 20
- **sort_by** (string) - Optional - Property to sort by (name, id). Default is name
- **sort_dir** (string) - Optional - Sort direction (asc, desc). Default is asc

### Response
#### Success Response (200)
- **id** (integer) - ID
- **name** (string) - Name
- **account_id** (integer) - Id of the account that owns the branding
- **resources** (BrandingResource[]) - Resources
- **created_at** (ISO-8601) - Timestamp of creation
```

--------------------------------

### Initialize and use QuickPay Python Client

Source: https://learn.quickpay.net/tech-talk/guides/cards

Requires the quickpay_api_client module and an API key stored in environment variables. Use this to handle card tokenization and payment authorization workflows.

```python
from quickpay_api_client import QPClient
secret = ":{0}".format(os.environ['QUICKPAY_API_KEY'])
client = QPClient(secret)

tokens    = client.post("/cards/%s/tokens" % card['id'])
payment   = client.post("/payment", body={'currency':"DKK", 'order_id': "0001"})
authorize = client.post("/payments/%s/authorize?synchronized" % payment['id'],
                        body={'amount=100'},
                        card={"token": tokens['token']})
```

--------------------------------

### GET /cards

Source: https://learn.quickpay.net/tech-talk/api/services

Retrieves a list of saved cards based on the provided query parameters.

```APIDOC
## GET /cards

### Description
Get saved cards from the QuickPay system.

### Method
GET

### Endpoint
/cards

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **timestamp** (string) - Optional - Timestamp field (created_at, updated_at). Default: created_at
- **min_time** (Time) - Optional - Filter payments after the given time. Format: “%Y-%m-%d %H:%M:%S %z”
- **max_time** (Time) - Optional - Filter payments after the given time. Format: “%Y-%m-%d %H:%M:%S %z”
- **fraud_suspected** (boolean) - Optional - Filter by suspected fraud
- **page** (integer) - Optional - Pagination page. Default: 1
- **page_size** (integer) - Optional - Items per page. Default: 20
- **sort_by** (string) - Optional - Property to sort by. Default: id
- **sort_dir** (string) - Optional - Sort direction (asc, desc). Default: desc
- **page_key** (integer) - Optional

### Response
#### Success Response (200)
- **id** (integer) - Card id
- **merchant_id** (integer) - Merchant id
- **accepted** (boolean) - Accepted by acquirer
- **operations** (CardOperation[]) - Operations
- **metadata** (Metadata) - Card metadata
- **link** (CardLink) - Sharable link to payment window
- **variables** (hash) - Custom variables
- **currency** (string) - Cards currency
- **test_mode** (boolean) - Test mode
- **acquirer** (string) - Acquirer that processed the card
- **type** (string) - Type of transaction
- **created_at** (ISO-8601) - Timestamp of creation
```

--------------------------------

### Create Payment Link in Ruby

Source: https://learn.quickpay.net/tech-talk/payments/link

Uses the quickpay-ruby-client gem to initialize a client, create a payment, and generate a link URL.

```ruby
# Use the official quickpay-ruby-client gem
require "quickpay/api/client"
client = QuickPay::API::Client.new(password: ENV['YOUR_API_USER_KEY'])

# /framed requests require: `allow-same-origin`, `allow-scripts` and `allow-forms` headers.
payment = client.post(
    "/payments",
    headers: { "Content-Type" => "application/json" },
    body: { order_id: "0001", currency: "DKK" }.to_json
  )

link = client.put(
    "/payments/#{payment['id']}/link",
    headers: { "Content-Type" => "application/json" },
    body: { amount: 100 }.to_json
  )

puts link['url']
```

--------------------------------

### GET /fees/formulas

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Get all fee formulas.

```APIDOC
## GET /fees/formulas

### Description
Get all fee formulas.

### Method
GET

### Endpoint
/fees/formulas

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **page** (integer) - Optional - Pagination page. Default is 1
- **page_size** (integer) - Optional - Items per page. Default is 20

### Response
#### Success Response (200)
- **formula** (string) - The formula
- **acquirer** (string) - Acquirer
- **payment_method** (string) - Payment method
- **standard** (boolean) - True if this is the standard fee formula
```

--------------------------------

### Create a new card in Quickpay

Source: https://learn.quickpay.net/tech-talk/guides/cards

Initial step to create a card entity using the Quickpay API.

```bash
curl -u ':APIKEY' \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X POST \
     https://api.quickpay.net/cards
```

--------------------------------

### Create Payment Link in Python

Source: https://learn.quickpay.net/tech-talk/payments/link

Uses the quickpay_api_client library to authenticate via environment variables and generate a payment link.

```python
#!/usr/bin/python
# -*- coding: utf-8 -*-
import os
from quickpay_api_client import QPClient

secret = ':{0}'.format(os.environ['QUICKPAY_API_KEY'])
client = QPClient(secret)

payment = client.post('/payments', body={'currency': 'DKK',
                      'order_id': '0001'})

link = client.put('/payments/%s/link' % payment['id'],
                  body={'amount': 100})

  # Add framed=true if you want to open in an iframe

print link['url']
```

--------------------------------

### GET /account/logo

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the merchant logo.

```APIDOC
## GET /account/logo

### Description
Gets the merchant logo as a raw download or a 404 if none exists.

### Method
GET

### Endpoint
/account/logo

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **logo_type** (string) - Optional - Type of logo (payment_window, mobilepay, vippspsp). Default: payment_window
```

--------------------------------

### GET /subscription-groups

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves a list of all subscription groups.

```APIDOC
## GET /subscription-groups

### Description
Get all subscription groups.

### Method
GET

### Endpoint
/subscription-groups

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **page** (integer) - Optional - Pagination page. Default is 1
- **page_size** (integer) - Optional - Items per page. Default is 20
- **sort_by** (string) - Optional - Property to sort by. Default is id
- **sort_dir** (string) - Optional - Sort direction (asc, desc). Default is desc

### Response
#### Success Response (200)
- **id** (integer) - ID
- **merchant_id** (integer) - Id of the merchant that owns the group
- **name** (string) - Name of the group
- **description** (string) - Description of the group
- **amount** (integer) - Amount that is captured on each capture
- **currency** (string) - Currency of the amount
```

--------------------------------

### Create a new payment request

Source: https://learn.quickpay.net/tech-talk/guides/payments

Initializes a payment entity in the Quickpay system using the POST /payments endpoint.

```bash
curl -u ':APIKEY \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X POST \
     -d '{"order_id":"pm1001","currency":"dkk"}' \
     https://api.quickpay.net/payments
```

--------------------------------

### Subscription creation response

Source: https://learn.quickpay.net/tech-talk/guides/subscriptions

Example JSON response returned after successfully creating a subscription.

```json
{
  "id":97629173,
  "merchant_id":1234,
  "order_id":"sub10004",
  "accepted":false,
  "type":"Subscription",
  "currency":"EUR",
  "state":"initial"
  ...
}
```

--------------------------------

### Create a new payout

Source: https://learn.quickpay.net/tech-talk/guides/payouts

Initializes a payout entity in the Quickpay system.

```bash
curl -u ':APIKEY \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X POST \
     -d '{"order_id":"po1001","currency":"dkk"}' \
     https://api.quickpay.net/payouts
```

--------------------------------

### GET /acquirers/pprobancontact

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the PPROBancontact acquirer settings.

```APIDOC
## GET /acquirers/pprobancontact

### Description
Get PPROBancontact acquirer settings.

### Method
GET

### Endpoint
/acquirers/pprobancontact

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
```

--------------------------------

### Create Payment Link in PHP

Source: https://learn.quickpay.net/tech-talk/payments/link

Uses the QuickPay PHP client to create a payment and link, including error handling and status verification.

```php
<?php
use QuickPay\QuickPay;

try {
    //Initialize client
    $client = new QuickPay(":api-key-here");

    //Create payment
    $payment = $client->request->post('/payments', [
        'order_id' => '0007',
        'currency' => 'DKK',
    ]);

    $status = $payment->httpStatus();

    //Determine if payment was created successfully
    if ($status === 201) {

        $paymentObject = $payment->asObject();

        //Construct url to create payment link
        $endpoint = sprintf("/payments/%s/link", $paymentObject->id);

        //Issue a put request to create payment link
        $link = $client->request->put($endpoint, [
            'amount' => 100 //amount in cents
        ]);

        //Determine if payment link was created succesfully
        if ($link->httpStatus() === 200) {
            //Get payment link url
            echo $link->asObject()->url;
        }
    }
} catch (\Exception $e) {
    echo $e->getMessage();
}
?>
```

--------------------------------

### Example response for card creation

Source: https://learn.quickpay.net/tech-talk/guides/cards

Snippet of the JSON response received after successfully creating a card.

```json
{
  "id":2886958,
  "merchant_id":1234
  ...
}
```

--------------------------------

### GET /account/private-key

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the private key of the merchant.

```APIDOC
## GET /account/private-key

### Description
Gets the private key of the merchant.

### Method
GET

### Endpoint
/account/private-key

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **private_key** (string) - The private key
```

--------------------------------

### POST /subscriptions

Source: https://learn.quickpay.net/tech-talk/guides/subscriptions

Creates a new subscription entity in Quickpay.

```APIDOC
## POST /subscriptions

### Description
Creates a new subscription entity in Quickpay.

### Method
POST

### Endpoint
https://api.quickpay.net/subscriptions

### Parameters
#### Request Body
- **order_id** (string) - Required - Unique order number
- **currency** (string) - Required - Currency
- **description** (string) - Required - Subscription description

### Request Example
{
  "order_id": "sub10003",
  "currency": "eur",
  "description": "shoe-sub"
}

### Response
#### Success Response (200)
- **id** (integer) - Subscription ID
- **order_id** (string) - Unique order number
- **state** (string) - Current state of the subscription

#### Response Example
{
  "id": 97629173,
  "order_id": "sub10004",
  "state": "initial"
}
```

--------------------------------

### GET /subscriptions/{id}

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves details for a specific subscription.

```APIDOC
## GET /subscriptions/{id}

### Description
Get subscription.

### Method
GET

### Endpoint
/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (array) - Required - Subscription id

#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **operations_size** (integer) - Optional - Maximum number of operations to retrieve

### Response
#### Success Response (200)
- OK
```

--------------------------------

### Create a feature branch for contributions

Source: https://learn.quickpay.net/tech-talk/opensource

Use this command to initialize a new feature branch in your local repository.

```bash
git checkout -b my-new-feature
```

--------------------------------

### POST /brandings

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Creates a new branding configuration.

```APIDOC
## POST /brandings

### Description
Creates a new branding configuration for the merchant.

### Method
POST

### Endpoint
/brandings

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Request Body
- **name** (string) - Required - Descriptive name of the branding

### Response
#### Success Response (201)
- **id** (integer) - ID
- **name** (string) - Name
- **account_id** (integer) - Id of the account that owns the branding
- **resources** (BrandingResource[]) - Resources
- **created_at** (ISO-8601) - Timestamp of creation
```

--------------------------------

### GET /payouts/{id}

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the details of a specific payout.

```APIDOC
## GET /payouts/{id}

### Description
Retrieves the full details of a payout, including transaction state, metadata, and associated operations.

### Method
GET

### Endpoint
/payouts/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - Payout id

#### Query Parameters
- **operations_size** (integer) - Optional - Maximum number of operations to retrieve

#### Request Headers
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **id** (integer) - Id
- **ulid** (string) - Ulid
- **merchant_id** (integer) - Merchant id
- **order_id** (string) - Order number
- **accepted** (boolean) - Accepted by acquirer
- **type** (string) - transaction type
- **text_on_statement** (string) - Text on statement
- **branding_id** (integer) - Branding id
- **variables** (hash) - Custom variables
- **currency** (string) - Currency
- **state** (string) - State of transaction
- **metadata** (Metadata) - Metadata
- **link** (PaymentLink) - PaymentLink
- **operations** (Operation[]) - Operations
- **test_mode** (boolean) - Test mode
- **acquirer** (string) - Acquirer that processed the transaction
- **facilitator** (string) - Facilitator that facilitated the transaction
- **created_at** (ISO-8601) - Timestamp of creation
- **updated_at** (ISO-8601) - Timestamp of last updated
- **retented_at** (ISO-8601) - Timestamp of retention
- **balance** (integer) - Balance
```

--------------------------------

### GET /payments/{id}

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves details for a specific payment.

```APIDOC
## GET /payments/{id}

### Description
Get payment details.

### Method
GET

### Endpoint
/payments/{id}

### Parameters
#### Path Parameters
- **id** (array) - Required - Payment id

#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **operations_size** (integer) - Optional - Maximum number of operations to retrieve

### Response
#### Success Response (200)
- OK
```

--------------------------------

### GET /cryptography/keys

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Lists cryptographic keys associated with the merchant.

```APIDOC
## GET /cryptography/keys

### Description
Get keys

### Method
GET

### Endpoint
/cryptography/keys

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

#### Query Parameters
- **type** (string) - Optional - ec, rsa
- **query** (string) - Optional
- **sort_by** (string) - Optional - Property to sort by (id)
- **sort_dir** (string) - Optional - Sort direction (asc, desc)
- **page_size** (integer) - Optional - Items per page. Default is 20
- **page_key** (integer) - Optional

### Response
#### Success Response (200)
- MerchantCryptographyKey Model

#### Error Response (403)
- Not authorized
```

--------------------------------

### Create a new subscription

Source: https://learn.quickpay.net/tech-talk/guides/subscriptions

Initializes a subscription entity with a unique order ID, currency, and description.

```curl
curl -u ':APIKEY \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X POST \
     -d '{"order_id":"sub10003","currency":"eur","description":"shoe-sub"}' \
     https://api.quickpay.net/subscriptions
```

--------------------------------

### GET /acquirers/mobilepaysubscriptions

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current settings for the MobilePaySubscriptions acquirer.

```APIDOC
## GET /acquirers/mobilepaysubscriptions

### Description
Retrieves the current settings for the MobilePaySubscriptions acquirer.

### Method
GET

### Endpoint
/acquirers/mobilepaysubscriptions

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **auth_state** (string) - Identifier MobilePay Subscriptions uses to link requests to callbacks
- **code_verifier** (string) - Verifies received code challenge
- **last_token_refresh** (integer) - Unix-timestamp of last time token was refreshed
- **nonce** (string) - Associate client sessions with ID Tokens to mitigate replay attacks
- **pending_status** (integer) - 0: agreement inactive, 1: flow initialised, 2: tokens received, 3: flow completed
- **provider** (object) - The MobilePay Subscriptions provider / sales-place chosen by the merchant
- **refresh_token** (string) - Token to refresh access token for up to 1 year
- **msn** (string) - Merchant Serieal Number
- **migrated** (boolean) - True if the acquirer was migrated to VMPEpayment
```

--------------------------------

### GET /acquirers/mobilepayonline

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current settings for the MobilePayOnline acquirer.

```APIDOC
## GET /acquirers/mobilepayonline

### Description
Retrieves the current settings for the MobilePayOnline acquirer.

### Method
GET

### Endpoint
/acquirers/mobilepayonline

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- **active** (boolean) - True if the acquirer is active
- **merchant_id** (string) - ID of the merchant
- **delivery_limited_to** (string) - MobilePayOnline delivery address selection countries limited to
```

--------------------------------

### Quickpay API Request Structure

Source: https://learn.quickpay.net/tech-talk/api

Overview of the HTTP request format, including supported methods, required headers, and body usage for interacting with Quickpay resources.

```APIDOC
## Quickpay API Request Structure

### Description
The Quickpay API uses standard HTTP methods to interact with resources. Requests require specific headers for authentication and versioning.

### Supported Methods
- **GET**: Retrieve a resource or list of resources.
- **POST**: Create a new resource.
- **PUT**: Replace an existing resource.
- **PATCH**: Update an existing resource.
- **DELETE**: Remove a resource.

### Required Headers
- **Host**: api.quickpay.net
- **Authorization**: HTTP Basic authentication
- **Accept-Version**: The desired API version (e.g., v10)
- **Accept**: application/json
- **Content-Type**: Required for POST and PUT requests

### Request Examples

#### GET Request
GET /resource/<Identifier> HTTP/1.1
Host: api.quickpay.net
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept-Version: v10
Accept: application/json

#### PUT Request
PUT /resource/<Identifier> HTTP/1.1
Host: api.quickpay.net
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept-Version: v10
Accept: application/json
key1=value1&key2=value2
```

--------------------------------

### GET /acquirers/elavon

Source: https://learn.quickpay.net/tech-talk/api/services?scope=merchant

Retrieves the current settings for the Elavon acquirer.

```APIDOC
## GET /acquirers/elavon

### Description
Get Elavon acquirer settings.

### Method
GET

### Endpoint
/acquirers/elavon

### Parameters
#### Header Parameters
- **Accept-Version** (string) - Required - Specify the version of the API
- **Authorization** (string) - Required - Use Basic Auth to authorize to the API

### Response
#### Success Response (200)
- OK

#### Error Responses
- 403: Not authorized
```

--------------------------------

### Retrieve List of Resources Response

Source: https://learn.quickpay.net/tech-talk/api

Example of a successful HTTP 200 response containing a JSON array of objects.

```http
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: nnn

[
  {
    "key1": "value1",
    "key2": "value2"
  },
  {
    "key1": "value1",
    "key2": "value2"
  }
]
```
Tokens:
Raw