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

Subscription List

Subscription List

Field Name Len Type Req Ver Comments
method N/A Alp-Num Yes 1.0 subscriptionList
fromEmail N/A Alp-Num Yes 1.0 The email associated with the account from which the amount is deducted
pageSize N/A Num -- 1.1 Number of results per page
pageNumber N/A Num -- 1.1 Which page to be returned
key N/A Alp-Num Yes 1.0 MD5(sharedSecret + pageSize + pageNumber)

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.0 The response code; 00 = Success;
ResponseDescription N/A Alp-Num Yes 1.0 Human readable response
Fee N/A Real Yes 1.0 Fee for the current transaction
Results N/A Num Yes 1.1 Total of results
PageSize N/A Num Yes 1.1 Results per page
PageNumber N/A Num Yes 1.1 Page Number
SubscriptionId N/A Num Yes 1.0 Unique identifier of the subscription
Subscription/ FromAccountId N/A Int Yes 1.0 The account ID from where the amount is deducted
Subscription/ FromAccount N/A Alp-Num Yes 1.1 The account name from where the amount is deducted
Subscription/ FromAccountEmail N/A Alp-Num Yes 1.1 The account email from where the amount is deducted
Subscription/ ToAccountId N/A Int Yes 1.1 The account ID where the amount has been transfered
Subscription/ ToAccount N/A Alp-Num Yes 1.1 The account name where the amount has been transfered
Subscription/ ToAccountEmail N/A Alp-Num Yes 1.1 The account email where the amount has been transfered
Subscription/ Amount N/A Real Yes 1.0 The amount to be deducted
Subscription/ Currency N/A Apl-Num Yes 1.0 The Currency Code (USD)
Subscription/ StartDate N/A Date Yes 1.0 The date when the subscription started
Subscription/ EndDate* N/A Date Yes 1.0 The date when the subscription should end
Subscription/ UserCancel* N/A Num Yes 1.0 1 if the subscription will be valid until the user cancel it
Subscription/ Transactions* N/A Num Yes 1.0 The number of times the amount to be deducted before the subscription expires (is cancelled)
Subscription/ PaymentInterval N/A Yes 1.0 1 = every week
2 = every 2 weeks
3 = every month
4 = every 3 months
5 = every 6 months
6 = annually
Subscription/ StatusId 1 Num Yes 1.0 2 = active
4 = canceled
32 = completed

* Only one of these fields will have a value, depending the type of the subscription

Request Sample:

www.paxum.com/payment/api/paymentAPI.php
POST
method=subscriptionList&fromEmail=payee@domain.com&pageSize=10&pageNumber=1&key=1060b7b46a3bd36b3a0d66e0127d0517
                

Response Sample

<?xml version="1.0"?>
<Response>
    <Environment>PRODUCTION</Environment>
    <Method>subscriptionList</Method>
    <ResponseCode>00</ResponseCode>
    <ResponseDescription>Approved or Completed Successfully</ResponseDescription >
    <Fee>0.00</Fee>
    <Results>50</Results>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Subscriptions>
    <Subscription>
    <Id>12345</Id>
    <FromAccountId>34763473</FromAccountId>
    <FromAccount>2511.USD.CHQ.10000027</FromAccount>
    <FromAccountEmail>payer@domain.com</FromAccountEmail>
    <ToAccountId>3476578734</ToAccountId>
    <ToAccount>2511.USD.CHQ.10000032</ToAccount>
    <ToAccountEmail>payee@domain.com</ToAccountEmail>
    <Amount>100.00</Amount>
    <Currency>USD</Currency>
    <StartDate>2011-01-03</StartDate>
    <EndDate>2011-12-03</EndDate>
    <UserCancel/>
    <Transactions/>
    <PaymentInterval>3</PaymentInterval>
    <StatusId>2</StatusId>
    </Subscription>
    ...
    </Subscriptions>
</Response>
                

Working Sample(s):

subscriptionList.php