Clients

Endpoints used to register third party clients.

APIDescription
POST api/v1/client/register

Register a new client - uses a two-factor authentication.

POST api/v1/client/cancellation

Cancel an existing client registration.

POST api/v1/client/activation

Activate a new client registration.

POST api/v1/client/update

Modify the email address used for registration/continuation.

Customers

APIDescription
POST api/v1/customer/register

Register a new customer and payment profile

POST api/v1/customer/payments/register

Register a new payment profile for existing customer

POST api/v1/customer/payments/update

Update an existing payment profile. It is not necessary to include fields that are NOT changing, just the ones that are. The card number, the cardholder name and the billing country cannot be changed; all other fields can be changed.

POST api/v1/customer/payments/remove

Remove an existing payment profile

POST api/v1/customer/profiles

For clients that cannot send a body with a GET

GET api/v1/customer/profiles

List all payment profiles for the customer

POST api/v1/customer/profiles/full

For clients that cannot send a body with a GET

GET api/v1/customer/profiles/full

List all payment profiles for the customer

GET api/v1/customer/profile

Get a customer's profile.

GET api/v1/customer

Get details ragarding a customer.

GET api/v1/customer/profiles/default

Get the default customer's payment profile.

DiscountCodes

APIDescription
POST api/v1/discountcode/add

Add a new discount code.

POST api/v1/discountcode/validate

Validate a discount code.

ISV

APIDescription
GET api/v1/isvs/pricing

No documentation available.

Memberships

APIDescription
POST api/v1/memberships/{email}

For clients that cannot send a GET with a body.

GET api/v1/memberships/{email}

Get a listing of associations contact is a member of

POST api/v1/memberships/join

Join an association as a new member

POST api/v1/memberships/cancel

Cancel an existing membership. The membership will be terminated on the monthly anniversary of the renewal date.

Payments

APIDescription
POST api/v1/payments/creditcard/authorize

Authorize a credit card. Funds will not be secured with this endpoint only.

POST api/v1/payments/creditcard/charge

Charge a credit card. Funds will be secured if the transaction is approved.

POST api/v1/payments/creditcard/refund

Refund a credit card. Funds will be returned to the credit card if approved.

POST api/v1/payments/creditcard/transaction/settle

Request settlement of a previously authorized credit card transaction. Will result in securing monies from the authorization request.

POST api/v1/payments/creditcard/transaction/void

Void a credit card transaction. Will stop a previously authorised transaction if not already processed by the bank.

POST api/v1/payments/b2b/transaction/debit

Debit a customer's bank account.

POST api/v1/payments/b2b/transaction/credit

Credit a customer's bank account.

POST api/v1/payments/thirdparty

For sending details of a third party transaction - payment won't be made with this endpoint.

PricingPackages

APIDescription
GET api/v1/packages?fromPost={fromPost}

Get listing of available packages.

GET api/v1/packages/{softwareId}

Get details regarding a specific software.

GET api/v1/packages/curatedcollection/{sku}

Get details regarding a specific curated collection.

GET api/v1/packages/softwarebundle/{bundleID}

Get details regarding a specific software bundle.

POST api/v1/packages

Get pricing details on avaliable packages (soon to be deprecated)

POST api/v1/purchase

Purchase multiple or single skus - preferred way to purchase anything.

GET api/v1/packages/purchased

Get details on specific purchases by specific people

POST api/v1/packages/bundle/upgrade

Upgrade an existing bundle customer has previously purchased.

POST api/v1/packages/bundle/downgrade

Downgrade an existing bundle customer has previously purchased.

POST api/v1/packages/truingup

For clients that cannot send a body with a GET.

GET api/v1/packages/truingup

Get the Truing Up price.

Profiles

APIDescription
POST api/v1/profiles/authorize

Authorize on a registered customer's credit card. Funds will not be secured with this endpoint only.

POST api/v1/profiles/charge

Charge a registered customer's credit card. Funds will be secured if transaction approved.

POST api/v1/profiles/refund

Refund a registered customer's credit card. Funds will be returned to credit card if approved.

POST api/v1/profiles/settle

Void a registered customer's transaction. Will stop a previously authorised transaction if not already processed by the bank.

POST api/v1/profiles/void

Void a registered customer's transaction. Will stop a previously authorised transaction if not already processed by the bank.

RecurringPayments

Endpoints used to handle recurring payments.

APIDescription
POST api/v1/recurringpayments/register

Set up a recurring payment. There must already be a customer/payment profile already on the system. Important to understand, you cannot process a new recurring payment today. If the start date has today's date, the first processing date will today's date plus the frequency interval, e.g. a daily frequency will have the first processing date set to tomorrow, a weekly frequency will have the first processing date set to 7 days from now.

POST api/v1/recurringpayments/suspend

Suspends a currently active recurring payment.

POST api/v1/recurringpayments/resume

Resumes a currently suspended recurring payment.

POST api/v1/recurringpayments/remove

Remove a recurring payment.

GET api/v1/recurringpayments/list

Get listing of all recurring payments for customer.

Transactions

APIDescription
POST api/v1/transactions

For clients that cannot send a body with a GET.

GET api/v1/transactions

Get transactions for a given contact