micropayment - CreditCard Service

API Description

micropayment provides an API for the booking of credit card transactions
(Unfortunately the test environment activated with the testMode parameter is not currently available!) CreditCard - API.Event must be activated manually to be used.
Following activation, you must go to the "My Configuration" menu item in the ControlCenter.
- Here you'll find the access key required to use the service
- You can configure and activate the service at the sub-menu item "Access Authorizations"
- At the "Access Authorizations" sub-menu item you should enter your server IP in order to gain access to the API from this server

URL of the API

To use the service, please use the following URL:

http://webservices.micropayment.de/public/creditcard/v1/nvp/

Using the API

We provide you with the Micropayment Service Client so that you can make use of the service.
With this client and the Service Interface you have easy access to service's functions.

Service Interface (PHP) view / download | Micropayment Service Client

API Functionality

Methods

customerCreate
Creates a new customer
customerSet
Changes the data for an existing customer
customerGet
Returns the data for an existing customer
creditcardDataSet
Changes the credit card data of an existing customer
creditcardDataGet
Returns the credit card data of an existing customer
sessionList
Returns a list of previous transactions based on the following parameters: Customer and/or time...
sessionCreate
Creates a new payment session.
sessionGet
Returns information about a session
transactionGet
Returns information about a transaction
transactionPurchase
Carries out a transaction for the immediate booking of the payment amount
transactionAuthorization
Carries out a transaction for the pre-authorization of a payment amount by ...
transactionCapture
Carries out a transaction for the booking of a pre-authorization ...
transactionReversal
Transaction for the cost-free cancellation of a payment before daily accounting...
transactionRefund
Transaction for the booking of a refund - The buyer receives the purchase ...

Name	Type	Required	Standard	Description
accessKey	string	Yes	No	Access key from the ControlCenter
testMode	integer	No	0	Activate test environment
customerId	string	No	NULL	Own unique ID of the customer; is generated otherwise [min/max no. of characters 10/40, alphanumeric]
freeParams	map	No	NULL	List of free parameters that are assigned to the customer
firstname	string	Yes	No	First name of the customer
surname	string	Yes	No	Last name of the customer
email	string	No	NULL	E-mail address of the customer if an e-mail should be sent to the customer after the transaction
culture	string	No	'de-DE'	Language & country of the customer \| Valid example values are "de", "de-DE", "en-US"

Name	Type	Required	Standard	Description
freeParams	map	No	NULL	List of all free parameters
firstname	string	Yes	No	First name of the customer
surname	string	Yes	No	Last name of the customer
email	string	Yes	No	E-mail address of the customer
culture	string	Yes	No	Language & country of the customer

Name	Type	Required	Standard	Description
type	string	Yes	No	Card type
number	string	Yes	No	Partial credit card number (last 4 numbers)
expiryYear	integer	Yes	No	Year of credit card expiration
expiryMonth	integer	Yes	No	Month of credit card expiration
cvc2Required	boolean	Yes	No	The CVC2 code is required for the next booking

Name	Type	Required	Standard	Description
sessionId	string	Yes	No	Own or generated unique customer ID
status	SessionStatus	Yes	No	"INIT" session status
expire	datetime	Yes	No	Session expiration time

Name	Type	Required	Standard	Description
customerId	string	Yes	No	Customer ID
project	string	Yes	No	The project code for the session
projectCampaign	string	Yes	No	The project operator's campaign code
account	string	Yes	No	Account of the participating webmaster or own account
webmasterCampaign	string	Yes	No	A project operator's campaign code
amount	integer	Yes	No	The amount to be booked. If no amount is provided, the amount from the configuration is used
currency	Currency	Yes	No	Currency unit
title	string	Yes	No	Description of the item to be purchased
ip	string	Yes	No	IPv4 of the user
freeParams	map	No	NULL	List of free parameters that are assigned to the session
status	SessionStatus	Yes	No
expire	datetime	No	NULL	Expiration date of the session, only when status is INIT or EXPIRED
mail	MailStatus	Yes	No	Status of mail delivery
transactionIds	string[]	No	NULL	List of transaction IDs that are linked to this session

Name	Type	Required	Standard	Description
transactionId	string	Yes	No	Transaction number
sessionId	string	Yes	No	Unique session ID
customerId	string	Yes	No	Customer ID
auth	string	Yes	No	AuthCode
amount	integer	Yes	No	The amount to be booked. If no amount is provided, the amount from the configuration is used
currency	Currency	Yes	No	Currency unit
type	TransactionType	Yes	No	Transaction type
status	TransactionStatus	Yes	No	Transaction status
created	datetime	Yes	No	Time point of the transaction
ip	string	Yes	No	IPv4 of the user
cardType	string	Yes	No	Card type
cardNumber	string	Yes	No	Partial credit card number (last 4 numbers)
cardExpiryYear	integer	Yes	No	Year of credit card expiration
cardExpiryMonth	integer	Yes	No	Month of credit card expiration

Name	Type	Required	Standard	Description
sessionStatus	SessionStatus	Yes	No	Status of the entire session
transactionStatus	TransactionStatus	Yes	No	Status of the initiated transaction
transactionId	string	Yes	No	Transaction number
transactionCreated	datetime	Yes	No	Time point of the transaction
transactionAuth	string	Yes	No	AuthCode

Name	Type	Required	Standard	Description
accessKey	string	Yes	No	Access key from the Control Center
testMode	integer	No	0	Activate test environment
sessionId	string	Yes	No	Session ID
cvc2	string	No	NULL	CVC2 code of the credit card; must be inputted at least once for each credit card/expiration date

Name	Type	Required	Standard	Description
status	NotificationStatus	No	"SUCCESS"	Status of notification processing
statusMessage	string	No	NULL	Free status text that is shown later in the Control Center; can potentially help with future error diagnostics
freeParam	map	No	NULL	List of free parameters: NULL - parameter list stays unchanges \| Empty HashMap - deletes parameter list \| Filled HashMap expands/overwrites existing parameter list

API Description

URL of the API

Using the API

API Functionality

Methods

Notifications

Types

Details About the Methods

customerCreate

customerSet

customerGet

creditcardDataSet

creditcardDataGet

sessionList

sessionCreate

sessionGet

transactionGet

transactionPurchase

transactionAuthorization

transactionCapture

transactionReversal

transactionRefund

Details on Notifications

transactionChargeback

Details on the Types

string

integer

map

boolean

struct

string[]

datetime

SessionStatus

Currency

MailStatus

TransactionType

TransactionStatus

NotificationStatus

array