This website uses cookies to ensure you have the best experience. By continuing to use this site, you consent to our Cookie policy. You can disable cookies at any time, by changing your browser settings.
Accept and close

Authorize

Here you can make an authorize request

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.2 authorize
fromEmail N/A Alp-Num Yes 1.2 The email associated with the account from which the authorize is made
merchantAccountId N/A Num Yes 1.2 Acquiring Merchant ID
amount N/A Num Yes 1.2 The amount of the authorize transaction
currency N/A Alp Yes 1.2 The amount currency(e.g. USD)
referenceId N/A Alp-Num Yes 1.2 Your internal identification
cardNumber 16 Num Yes 1.2 The number of the card
cardExpiryMonth 2 Num Yes 1.2 Card expiry month
cardExpiryYear 4 Num Yes 1.2 Card expiry year
cardVerificationNumber 3 Num Yes 1.2 Card Verification Number (CVV)
cardType 1 Num Yes 1.2 Card Type
1 = MasterCard
2 = VISA
billingFirstName N/A Alp Yes 1.2 Customer's First Name
billingLastName N/A Alp Yes 1.2 Customer's Last Name
billingMiddleName N/A Alp -- 1.2 Customer's Middle Name
billingIdn N/A Alp-Num -- 1.2 Identity Verification Number
billingCountry 2 Alp-Num Yes 1.2 Billing Country - two letters country code (ISO Char 2 Code)
billingState 2/3 Alp-Num Yes 1.2 Billing State - two/tree letters state / province / county code (ISO 3166-2)
billingCity N/A Alp-Num Yes 1.2 Billing City
billingStreetName N/A Alp-Num Yes 1.2 Billing Street Name
billingStreetNumber N/A Alp-Num Yes 1.2 Billing Street Number
billingBuilding N/A Alp-Num -- 1.2 Billing Building
billingEntrance N/A Alp-Num -- 1.2 Billing Entrance
billingFloor N/A Alp-Num -- 1.2 Billing Floor
billingApartment N/A Alp-Num -- 1.2 Billing Apartment
billingDistrict N/A Alp-Num -- 1.2 Billing District
billingZip N/A Alp-Num Yes 1.2 Billing Zip (Postal Code)
billingPhone N/A Num Yes 1.2 Billing Phone
billingEmail N/A Alp-Num -- 1.2 Billing Email
billingCompanyName N/A Alp-Num -- 1.2 Company that acquires the goods or services
billingCompanyRegistrationNumber N/A Alp-Num -- 1.2 The company’s unique registration code
billingCompanyTaxNumber N/A Alp-Num -- 1.2 Company registration number with Trade Register
billingCompanyBankName N/A Alp-Num -- 1.2 Customer’s bank
billingCompanyBankAccount N/A Alp-Num -- 1.2 Customer’s bank account
shippingFirstName N/A Alp-Num -- 1.2 Shipping First Name
shippingLastName N/A Alp-Num -- 1.2 Shipping Last Name
shippingMiddleName N/A Alp-Num -- 1.2 Shipping Middle Name
shippingCompanyName N/A Alp-Num -- 1.2 Shipping Company Name
shippingCountry 2 Alp-Num -- 1.2 Shipping Country - two letters country code (ISO Char 2 Code)
shippingState 2/3 Alp-Num -- 1.2 Shipping State - two/tree letters state / province / county code (ISO 3166-2)
shippingCity N/A Alp-Num -- 1.2 Shipping City
shippingStreetName N/A Alp-Num Yes 1.2 Shipping Street Name
shippingStreetNumber N/A Alp-Num Yes 1.2 Shipping Street Number
shippingBuilding N/A Alp-Num -- 1.2 Shipping Building
shippingEntrance N/A Alp-Num -- 1.2 Shipping District
shippingFloor N/A Alp-Num -- 1.2 Shipping Floor
shippingApartment N/A Alp-Num -- 1.2 Shipping Apartment
shippingDistrict N/A Alp-Num -- 1.2 Shipping Address
shippingZip N/A Alp-Num -- 1.2 Shipping Zip (Postal Code)
shippingPhone N/A Alp-Num -- 1.2 Shipping Phone
key N/A Alp-Num Yes 1.2 MD5(sharedSecret + merchantAccountId + amount + currency + referenceId + cardNumber + cardExpiryMonth + cardExpiryYear + cardVerificationNumber + cardType + billingFirstName + billingLastName + billingMiddleName + billingIdn + billingCountry + billingState + billingCity + billingStreetName + billingStreetNumber + billingBuilding + billingEntrance + billingFloor + billingApartment + billingDistrict + billingZip + billingPhone + billingEmail + billingCompanyName + billingCompanyRegistrationNumber + billingCompanyTaxNumber + billingCompanyBankName + billingCompanyBankAccount + shippingFirstName + shippingLastName + shippingMiddleName + shippingCompanyName + shippingCountry + shippingState + shippingCity + shippingAddress + shippingZip + shippingPhone )

This request is responded by a message with the following content:

Field Name Len Type Mdt Ver Comments
ResponseCode N/A Alp-Num Yes 1.2 The response code; 00 = Success;
ResponseDescription N/A Alp-Num Yes 1.2 Human readable response
Fee N/A Real Yes 1.2 Fee for the current transaction
TransactionId N/A Num Yes 1.2 The transaction ID if successfully, otherwise not specified
ReferenceId N/A Num Yes 1.2 Your internal identification
Status N/A Num Yes 1.2 The authorization status
2 = Active
4 = Canceled
23 = Pending
25 = Failed
40 = Authorized

Request Sample:

www.paxum.com/payment/api/paymentAPI.php
POST
method=authorize&fromEmail=payer%40domain.com&merchantAccountId=123456&amount=0.08&currency=USD&referenceId=225845&cardNumber=1234567890123456&cardExpiryMonth=07&cardExpiryYear=13&cardVerificationNumber=0&billingFirstName=firstName&billingLastName=LastName&billingMiddleName=middleName&billingIdn=123456798&billingCountry=US&billingState=NY&billingCity=New+York&billingStreetName=Fifth+Ave&billingStreetNumber=350&billingBuilding=&billingEntrance=&billingFloor=&billingApartment=&billingDistrict=&billingZip=123456&billingPhone=0123456789&billingEmail=payeer%40domain.com&billingCompanyName=companyName&billingCompanyRegistrationNumber=13456798&billingCompanyTaxNumber=132456789&billingCompanyBankName=bankName&billingCompanyBankAccount=13246589764131141&shippingFirstName=sFirstName&shippingLastName=sLastName&shippingMiddleName=sMiddleName&shippingCompanyName=sCompanyName&shippingCountry=sCountry&shippingState=sState&shippingCity=sCity&shippingStreetName=sStreetName&shippingStreetNumber=sStreetNumber&shippingBuilding=sStreetBuilding&shippingEntrance=sStreetEntrance&shippingFloor=sStreetFloor&shippingApartment=sStreetApartment&shippingDistrict=sStreetDistrict&shippingZip=sZip&shippingPhone=0123456798&key=bbd2204f2f85a026667df4e25e545e78
                

Response Sample

<?xml version="1.0"?>
<Response>
    <Method>authorize</Method>
    <ResponseCode>00</ResponseCode>
    <ResponseDescription>Approved or Completed Successfully</ResponseDescription >
    <Fee>0.00</Fee>
    <TransactionId>23646236</TransactionId>
    <ReferenceId>225845</ReferenceId>
    <Status>37</Status>
</Response>
                

Response Sample

http://www.domain.com/notificationURL
POST
responseCode=00&transactionId=23646236&statusId=37&referenceId=225845
                

Working Sample(s):

authorize.php