Developers
API
Modules
A services defines some resource and what exactly you can do with it. Click on the service methods to expand details.
ProTip! You can quickly tests services using curl – Here is an example:
$ curl -v -su '' -H 'Accept-Version: v10' https://api.quickpay.net/ping
Enter host password for user '': <enter your api key here>
A more GUI-oriented alternative is using the webservice Postman.
Account
GET /account Get merchant account PATCH /account Update merchant account DELETE /account Delete merchant account GET /account/private-key Gets the private key of the merchant PATCH /account/private-key Regenerates the private key of the merchant GET /account/logo Gets the merchant logo as a raw download or a 404 if none exists PUT /account/logo Creates or replaces the current merchant logo DELETE /account/logo Deletes the current merchant logo Acl-Resources GET /acl-resources Get acl resources Acquirers GET /acquirers Fetch acquirers GET /acquirers/anydaysplit Get AnydaySplit acquirer settings PATCH /acquirers/anydaysplit Update AnydaySplit acquirer settings GET /acquirers/bambora Get Bambora acquirer settings PATCH /acquirers/bambora Update Bambora acquirer settings GET /acquirers/clearhaus Get Clearhaus acquirer settings PATCH /acquirers/clearhaus Update Clearhaus acquirer settings GET /acquirers/coinify Get Coinify acquirer settings PATCH /acquirers/coinify Update Coinify acquirer settings GET /acquirers/elavon Get Elavon acquirer settings PATCH /acquirers/elavon Update Elavon acquirer settings GET /acquirers/handelsbanken Get Handelsbanken acquirer settings PATCH /acquirers/handelsbanken Update Handelsbanken acquirer settings GET /acquirers/klarnapayments Get KlarnaPayments acquirer settings PATCH /acquirers/klarnapayments Update KlarnaPayments acquirer settings GET /acquirers/mobilepayonline Get MobilePayOnline acquirer settings PATCH /acquirers/mobilepayonline Update MobilePayOnline acquirer settings GET /acquirers/mobilepaysubscriptions Get MobilePaySubscriptions acquirer settings PATCH /acquirers/mobilepaysubscriptions Update MobilePaySubscriptions acquirer settings GET /acquirers/nets Get Nets acquirer settings PATCH /acquirers/nets Update Nets acquirer settings GET /acquirers/paypal Get PayPal acquirer settings PATCH /acquirers/paypal Update PayPal acquirer settings GET /acquirers/paypalpayments Get PayPalPayments acquirer settings PATCH /acquirers/paypalpayments Update PayPalPayments acquirer settings GET /acquirers/paysafecard Get Paysafecard acquirer settings PATCH /acquirers/paysafecard Update Paysafecard acquirer settings GET /acquirers/ppro Get PPRO acquirer settings PATCH /acquirers/ppro Update PPRO acquirer settings GET /acquirers/pprobancontact Get PPROBancontact acquirer settings PATCH /acquirers/pprobancontact Update PPROBancontact acquirer settings GET /acquirers/pproblik Get PPROBlik acquirer settings PATCH /acquirers/pproblik Update PPROBlik acquirer settings GET /acquirers/pproprzelewy24 Get PPROPrzelewy24 acquirer settings PATCH /acquirers/pproprzelewy24 Update PPROPrzelewy24 acquirer settings GET /acquirers/pprosofort Get PPROSofort acquirer settings PATCH /acquirers/pprosofort Update PPROSofort acquirer settings GET /acquirers/pprowechatpay Get PPROWeChatPay acquirer settings PATCH /acquirers/pprowechatpay Update PPROWeChatPay acquirer settings GET /acquirers/resurs Get Resurs acquirer settings PATCH /acquirers/resurs Update Resurs acquirer settings GET /acquirers/sofort Get Sofort acquirer settings PATCH /acquirers/sofort Update Sofort acquirer settings GET /acquirers/swedbank Get Swedbank acquirer settings PATCH /acquirers/swedbank Update Swedbank acquirer settings GET /acquirers/swish Get Swish acquirer settings PATCH /acquirers/swish Update Swish acquirer settings GET /acquirers/teller Get Teller acquirer settings PATCH /acquirers/teller Update Teller acquirer settings GET /acquirers/trustly Get Trustly acquirer settings PATCH /acquirers/trustly Update Trustly acquirer settings GET /acquirers/unzerpaylater Get UnzerPayLater acquirer settings PATCH /acquirers/unzerpaylater Update UnzerPayLater acquirer settings GET /acquirers/valitor Get Valitor acquirer settings PATCH /acquirers/valitor Update Valitor acquirer settings GET /acquirers/viabill Get ViaBill acquirer settings PATCH /acquirers/viabill Update ViaBill acquirer settings GET /acquirers/vipps Get Vipps acquirer settings PATCH /acquirers/vipps Update Vipps acquirer settings GET /acquirers/vippspsp Get VippsPSP acquirer settings PATCH /acquirers/vippspsp Update VippsPSP acquirer settings GET /acquirers/vmpepayment Get VMPEpayment acquirer settings PATCH /acquirers/vmpepayment Update VMPEpayment acquirer settings POST /acquirers/{acquirer}/test Test payments via acquirer Activity GET /activity Get activity GET /activity/{id} Get a single activity entry Agreements GET /agreements Get agreements POST /agreements Create agreement GET /agreements/{id} Get agreement PATCH /agreements/{id} Update agreement PUT /agreements/{id} Replace agreement DELETE /agreements/{id} Delete agreement GET /agreements/{id}/activity Get agreement activity PATCH /agreements/{id}/api-key Regenerate the API key for this agreement Brandings GET /brandings Get brandings POST /brandings Create a branding GET /brandings/{id} Get a branding PATCH /brandings/{id} Update a branding DELETE /brandings/{id} Delete a branding POST /brandings/{id}/copy Copies branding and returns the new branding GET /brandings/{id}/*resource_name Gets a branding resource as a file PUT /brandings/{id}/*resource_name Uploads a file and creates or replaces a resource DELETE /brandings/{id}/*resource_name Deletes a branding resource Cards GET /cards Get saved cards POST /cards Create saved card GET /cards/{id} Get saved card PATCH /cards/{id} Update saved card POST /cards/{id}/authorize Authorize saved card POST /cards/{id}/cancel Cancel saved card POST /cards/{id}/tokens Create card token PUT /cards/{id}/link Create or update a card link DELETE /cards/{id}/link Delete card link POST /cards/{id}/fraud-report Create fraud confirmation report GET /cards/{id}/operations/{operation_id} Get Operation Changelog GET /changelog Get the API Changelog Cryptography GET /cryptography/keys Get keys POST /cryptography/keys Create key GET /cryptography/keys/{id} Get key PATCH /cryptography/keys/{id} update key DELETE /cryptography/keys/{id} Delete key POST /cryptography/keys/{id}/csr Create certificate request (CSR) GET /cryptography/keys/{id}/certificate Get certificate PUT /cryptography/keys/{id}/certificate Replace certificate DELETE /cryptography/keys/{id}/certificate Delete certificate Fees POST /fees Calculate fee for auth params. Requires one of card[number] or card[token] POST /fees/{acquirer}/{payment_method} Calculate fee GET /fees/formulas Get all fee formulas GET /fees/formulas/{acquirer} Get fee formulas GET /fees/formulas/{acquirer}/{payment_method} Get fee formula PATCH /fees/formulas/{acquirer}/{payment_method} Update a fee formula DELETE /fees/formulas/{acquirer}/{payment_method} Reset a formula to default Fraud-Rulesets GET /fraud-rulesets Get custom defined fraud rulesets POST /fraud-rulesets Create a custom fraud ruleset GET /fraud-rulesets/{id} Get ruleset by id PATCH /fraud-rulesets/{id} Update a ruleset DELETE /fraud-rulesets/{id} Delete ruleset Payment-Method-Priority GET /payment-method-priority Get merchant payment method priority POST /payment-method-priority Replaces the payment method priority of the merchant Payments GET /payments Get all payments POST /payments Create payment PUT /payments/{id}/link Create or update a payment link DELETE /payments/{id}/link Delete payment link GET /payments/{id} Get payment PATCH /payments/{id} Update payment POST /payments/{id}/session Create payment session POST /payments/{id}/authorize Authorize payment POST /payments/{id}/capture Capture payment POST /payments/{id}/refund Refund payment POST /payments/{id}/cancel Cancel payment POST /payments/{id}/renew Renew authorization POST /payments/{id}/fraud-report Create fraud confirmation report GET /payments/{id}/operations/{operation_id} Get Operation PATCH /payments/{id}/operations/{operation_id} Update operation Payouts GET /payouts Get payouts POST /payouts Create payout PUT /payouts/{id}/link Create or update a payout link DELETE /payouts/{id}/link Delete payout link GET /payouts/{id} Get payout PATCH /payouts/{id} Update payout POST /payouts/{id}/credit Authorize a payout GET /payouts/{id}/operations/{operation_id} Get Operation Ping GET /ping Use this to test connectivity to the API POST /ping Use this to test connectivity to the API Shopify-Settings GET /shopify-settings Get all shopify settings GET /shopify-settings/{id} Find shopify settings by id Subscription-Groups GET /subscription-groups Get all subscription groups POST /subscription-groups Create subscription group GET /subscription-groups/{id} Find subscription group by id PATCH /subscription-groups/{id} Update subscription group DELETE /subscription-groups/{id} Delete subscription group POST /subscription-groups/{id}/capture Create recurring payments on subscription group Subscriptions GET /subscriptions Get subscriptions POST /subscriptions Create subscription PUT /subscriptions/{id}/link Create or update a payment link DELETE /subscriptions/{id}/link Delete payment link GET /subscriptions/{id} Get subscription PATCH /subscriptions/{id} Update subscription POST /subscriptions/{id}/session Create subscription session POST /subscriptions/{id}/authorize Authorize a subscription POST /subscriptions/{id}/cancel Cancel subscription POST /subscriptions/{id}/recurring Create subscription recurring payment POST /subscriptions/{id}/fraud-report Create fraud confirmation report GET /subscriptions/{id}/operations/{operation_id} Get Operation PATCH /subscriptions/{id}/operations/{operation_id} Update operation GET /subscriptions/{id}/payments Get all subscription payments
