Merchant API Methods

With the AltaPay Merchant API, you can do a variety of back-end calls directly from your own system. This means that you can set up automatic processes for capturing goods when shipped from the warehouse, for refunds when goods are returned, running a custom report, charging their subscription payments and so on.

You can integrate the following methods for post processing tasks:

To integrate the post-processing tasks, you need to integrate the Merchant API and use the createPaymentRequest method.

Task

Method

Calculate the surcharge for a payment

calculateSurcharge

Capture a reservation

captureReservation

Charge an existing subscription

chargeSubscription

Create a reservation for an invoice payment where you are manually collecting the social security or organisation number.

To create invoice payments without manually collecting the social security number, use the createPaymentRequest method.

createInvoiceReservation

Create a credit payment to a customer

credit

Access the funding file

fundingList

fundingDownload

View a custom transaction report

getCustomReport

Get the required text for PayByBill invoices.

getInvoiceText

Get a list of terminals available to a specific API user

getTerminals

Query the available amount on a gift card

queryGiftCard

Refund a captured reservation

refundCapturedReservation

Release a reservation

releaseReservation

Create a payment using the full credit card details.

reservation

Reserve a charge for an existing subscription

reserveSubscriptionCharge

Set up a subscription using the full card details.

setupSubscription

Update an order line (Only used in Klarna payments; and can only be used to update the description of an order line)

 

Find and check the status of a specific payment.

payments

For detailed information about the different payment methods, see Payment methods and providers.
To find out more about payment flow, see Payment flow process (Merchant API).
For more information about specific scenarios, like subscriptions, or gift card payments, see Integration scenarios (Merchant API).

To integrate the post-processing tasks, you need to integrate the Merchant API in addition to the createPaymentRequest method.