payments

HTTP method: GET

https://testgateway.altapaysecure.com/merchant/API/payments

You use the payments method to find and check the status of a specific payment. The parameters are set to filter the results.

This method returns no more than 10 transactions. To create a report of payments, use the getCustomReport method.

For the following providers, a reconciliation identifier is not returned: Santander, Swish, ELV, Swedbank - Lithuania, SEB - Lithuania, Handelsbanken - Finland, OP-Pohjola - Finland, Danske Bank - Finland, Nordea - Lithuania, Nordea - Finland, Nordea - Sweden, Przelewy24, Paysera, Sofort, PayByBill (Arvato).

Parameter

Description

Type

 Mandatory Notes
transaction_id

The id of a specific payment.

 [0-9a-f]{1,36} X  
payment_id

The id of a specific payment.

 [0-9a-f]{36} X  
shop_orderid

The shop order id passed in by the shop when the payment was created.

 [a-zA-Z0-9-]{1,100} X  
shop

Set the shop parameter to find transactions from a specific shop.

If you don't set the shop parameter, payments are shown from all shops you have access to.

string    
terminal

Set the terminal parameter to find transactions from a specific terminal.

If you don't set the terminal parameter, payments are shown from all shops you have access to.

string    

The table shows the most pertinent response values for the method. For a complete list of API response parameters, see API Response structure (XML).

Parameter Description Type
ResultFilter

The result filter shows how the results have been filtered with respect to:

  • Shop

  • Terminal

  • TransactionId

  • ShopOrderId

  • PaymentStatus

  • ReconciliationIdentifier

  • AcquirerReconciliationIdentifier

 
Transactions

Contains a set of Transaction elements, each describing the relevant transactions. For more information, see Transaction.

  
CardStatus

The CardStatus parameter indicates whether a card is expired, or is about to expire.

  • SoonExpired is returned for cards that expire within 3 months.
  • NoCreditCard is returned if there is not yet card information available on the payment.

  • Expired is returned if the card is expired.

  • Valid is returned if the card is valid.
  • InvalidLuhn is returned if the card has an invalid Luhn number. For more information, see https://en.wikipedia.org/wiki/Luhn_algorithm.
  • InvalidCardLength is returned if the card number is too long, or too short.
  • Expired
  • SoonExpired
  • Valid
  • NoCreditCard
  • InvalidLuhn
  • InvalidCardLength
  • DeletedPan
RecurringDefaultAmount The default amount captured from a recurring payment, if no specific amount is provided. float
PaymentInfos

The payment information submitted to the payment form, for example: 

<PaymentInfos>
	<PaymentInfo name="Form_Created_At">2010-09-28 12:34:56</PaymentInfo>
	<PaymentInfo name="Form_Provider">AltaPay Test Form</PaymentInfo>
	<PaymentInfo name="Merchant_Provided_Info">Some info by merchant</PaymentInfo>
</PaymentInfos>
 Node
FraudRiskScore

If fraud detection is enabled, the FraudRiskScore shows the percentage risk of a payment being a fraud attempt.

 float

GET call

https://<YourShopName>.altapaysecure.com/merchant/API/payments/?transaction_id=1

XML response

<?xml version="1.0" encoding="utf-8" ?>
<APIResponse version="20170228">
	<Header>
		<Date>2020-09-29T12:34:56+02:00</Date>
		<Path>API/payments</Path>
		<ErrorCode>0</ErrorCode>
		<ErrorMessage />
	</Header>
	<Body>
		<ResultFilter />
		<Transactions>
			<Transaction>
				<TransactionId>1</TransactionId>
				<PaymentId>ccc1479c-37f9-4962-8d2c-662d75117e9d</PaymentId>
				<AuthType>payment</AuthType>
				<CardStatus>Valid</CardStatus>
				<CreditCardExpiry>
					<Year>2028</Year>
					<Month>08</Month>
				</CreditCardExpiry>
				<CreditCardToken>93f534a2f5d66d6ab3f16c8a7bb7e852656d4bb2</CreditCardToken>
				<CreditCardMaskedPan>411111******1111</CreditCardMaskedPan>
				<CardInformation>
					<IsTokenized>false</IsTokenized>
					<Token>hYKu5yO33OsWYfT7g4weghvPjBnb3YEZYDysb7NzAf/sHk7j5j5ejzfF2ZyhLyggcCgaNKEmjg==+1</Token>
					<MaskedPan>411111******1111</MaskedPan>
					<Expiry>
						<Year>2028</Year>
						<Month>08</Month>
					</Expiry>
					<IssuingCountry>DK</IssuingCountry>
					<LastFourDigits>1111</LastFourDigits>
					<Scheme>VISA</Scheme>
				</CardInformation>
				<ThreeDSecureResult>Not_Applicable</ThreeDSecureResult>
				<LiableForChargeback>Merchant</LiableForChargeback>
				<BlacklistToken>4f244dec4907eba0f6432e53b17a60ebcf51365e</BlacklistToken>
				<ShopOrderId>myorderid</ShopOrderId>
				<Shop>AltaPay Shop</Shop>
				<Terminal>AltaPay Test Terminal</Terminal>
				<TransactionStatus>captured</TransactionStatus>
				<ReasonCode>NONE</ReasonCode>
				<MerchantCurrency>978</MerchantCurrency>
				<MerchantCurrencyAlpha>EUR</MerchantCurrencyAlpha>
				<CardHolderCurrency>978</CardHolderCurrency>
				<CardHolderCurrencyAlpha>EUR</CardHolderCurrencyAlpha>
				<ReservedAmount>1.00</ReservedAmount>
				<CapturedAmount>1.00</CapturedAmount>
				<RefundedAmount>0</RefundedAmount>
				<RecurringDefaultAmount>0</RecurringDefaultAmount>
				<CreatedDate>2010-09-28 12:34:56</CreatedDate>
				<UpdatedDate>2010-09-28 12:34:56</UpdatedDate>
				<PaymentNature>CreditCard</PaymentNature>
				<PaymentNatureService name="TestAcquirer">
					<SupportsRefunds>true</SupportsRefunds>
					<SupportsRelease>true</SupportsRelease>
					<SupportsMultipleCaptures>true</SupportsMultipleCaptures>
					<SupportsMultipleRefunds>false</SupportsMultipleRefunds>
				</PaymentNatureService>
				<FraudRiskScore>13.37</FraudRiskScore>
				<FraudExplanation>Fraud detection explanation</FraudExplanation>
				<PaymentInfos>
					<PaymentInfo name="Form_Created_At">2010-09-28 12:34:56</PaymentInfo>
					<PaymentInfo name="Form_Provider">AltaPay Test Form</PaymentInfo>
					<PaymentInfo name="Merchant_Provided_Info">Some info by merchant</PaymentInfo>
				</PaymentInfos>
				<CustomerInfo>
					<UserAgent>Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.7
					(KHTML, like Gecko) Chrome/16.0.912.41 Safari/535.7</UserAgent>
					<IpAddress>127.127.127.127</IpAddress>
					<Email>support@altapay.com</Email>
					<Username>support</Username>
					<CustomerPhone>+45 7020 0056</CustomerPhone>
					<OrganisationNumber>12345678</OrganisationNumber>
					<CountryOfOrigin>
						<Country>DK</Country>
						<Source>BillingAddress</Source>
					</CountryOfOrigin>
					<BillingAddress>
						<Firstname>Palle</Firstname>
						<Lastname>Simonsen</Lastname>
						<Address>Rosenkæret 13</Address>
						<City>Søborg</City>
						<PostalCode>2860</PostalCode>
						<Country>DK</Country>
					</BillingAddress>
					<ShippingAddress/>
					<RegisteredAddress/>
				</CustomerInfo>
				<ReconciliationIdentifiers>
					<ReconciliationIdentifier>
						<Id>f4e2533e-c578-4383-b075-bc8a6866784a</Id>
						<Amount currency="978">1.00</Amount>
						<Type>captured</Type>
						<Date>2020-09-28T12:00:00+02:00</Date>
					</ReconciliationIdentifier>
				</ReconciliationIdentifiers>
			</Transaction>
		</Transactions>
	</Body>
</APIResponse>