Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 4.12 KB

index.md

File metadata and controls

63 lines (50 loc) · 4.12 KB

Altapay - PHP Api - Index

Docs: https://testgateway.altapaysecure.com/merchant.php/help/Merchant_API

Methods

Method Description
Authentication How to authenticate
Card Create a creditcard

Tests

Method Description
Test connection This method requires no authentication and is used for test the connection to our system
Test authentication This method test your authentication to our system.

eCommerce

Method Description
Payment request This is the preferred way of redirecting a customer to the Altapay payment page

Payments

Method Description
x Capture reservation When the funds of a payment has been reserved and the goods are ready for delivery your system should capture the payment.
x Release reservation Every now and then you for some reason do not want to capture a payment. In these cases you must cancel it to release the reservation of the funds.
x Refund captured reservation Sometimes after delivering the goods/services and capturing the funds you want to repay/refund the customer. Either you want to make a full refund or you only want to make a partial refund.
x Reservation of fixed amount This will create a MO/TO payment. The payment can be made with a credit card, or a credit card token and the CVV
x Credit This will create a Credit payment. The payment can be made with a credit card, or a credit card token and the CVV
x Update Order This method is used to update the order amount and add, remove or update order lines
- Invoice reservation

Subscription

Method Description
x Setup subscription This method is used to setup a subscription
x Charge subscription This is used to capture a recurring payments once. You can call this multiple times with the same payment to do several captures.
x Reserve subscription charge This is used to create a preauth from a subscription, as opposed to capturing it right away. You can call this multiple times with the same 'recurring_confirmed' payment to do several preauths.

Others

Method Description
Payments This is used to find and check the status of a specific payment. This is NOT intended for finding multiple payments or creating reports. Please note that the maximum number of transactions returned is 10.
Funding list Used to get a list of fundings, which details when and how much money is transfered to your companys bank account.
Funding download Used to get a comma separated value file containing the details of a funding.
Custom report Used to get a comma separated value file containing the custom report
Terminals This method will allow you to extract a list of terminals that you have access to
Invoice text This is used for gathering information to print on the customer invoice for invoice/Arvato payments
Calculate surcharge This method is used to calculate the surcharge beforehand, based on a previously completed payment or a terminal, creditcard token, currency combo.
Query giftcard This method is used to get information about a gift card.
Update merchant reconciliation identifier This method to update merchant reconciliation identifier for a given payment transaction.
x = Docs not written
/ = Some PHP code is missing
- = PHP code missing