Example Secure Payment APIs - Changelog / Introduction

Purpose

The purpose of the Example Payment APIs collection is to describe how to integrate with Example's standard RESTful API from external servers such as Portal, Membership, Game, and so on.

Example Secure Payment APIs Security: Encrypted Data

The Example Secure Payment APIs protect all HTTPS Request and Response data according to PCI and PII standards with the AES-GCM encryption external link icon (Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM) as a Transport Layer Security (TLS) authenticated encryption operation). Please see the Protocol Rules "AES-GCM encrypted request and response data" section for these and other Example Secure Payment API security-related details.

Click a topic to expand/collapse it.

Changelog / Version History

Version 5.51 - 2011/01/10

This release includes the following updates:

Updated
- Payout Transaction API
  - Added JSON property "region" to the response.
- Refund Transaction API
  - Added JSON property "region" to the response.
- Test Card Information
  - Updated the E-Com Processing Test Card Information.

Payment API endpoints overview

Payment API endpoint url schemes:

Example Development Server: https://pl.dev.Example.net
Example QA Server: https://pl.qa.Example.net
Example Prod Server: https://plpp.qa.Example.net

Account APIs

See the Account APIs page for further data.

DELETECancelPaymentInfoByOrderId: URL: /account/{uuid}/orders/{orderId}; Description: Cancels PaymentInfo via a mobile client OrderID.
POSTCreatePaymentInfo: URL: /account/{uuid}/paymentinfo; Description: Create a user’s payment information.
PUTUpdatePaymentInfo: URL: /account/{uuid}/paymentinfo/{paymentInfoId}; Description: Update user’s payment information.
DELETEDeletePaymentInfo: URL: /account/{uuid}/paymentinfo/{paymentInfoID}; Description: Delete user’s payment information.
GETGetPaymentInfo: URL: /account/{uuid}/paymentinfo; Description: Get user's payment information.
GETGetPaymentinfoByPaymentInfoID: URL: /account/{uuid}/paymentinfo/{paymentInfoId}; Description: Get Payment Information by paymentInfoID.
GETGetCardExpiries: URL: /account/{uuid}/paymentinfo/expiries; Description: Gets a list of a user’s expired credit cards.
POSTReVerifyPaymentInfo: URL: /account/{uuid}/paymentinfo/{paymentInfoID}/verification; Description: Reverify payment information by uuid and paymentInfoID.

Billing APIs

See the Billing APIs page for further data.

DELETECancelTransactionByOrderId: URL: /billing/{uuid}/orders/{orderId}; Description: Cancels a transaction by mobile client orderID.
POSTCheckTransaction: URL: /billing/{uuid}/transactions/check; Description: Checks a transaction before deposit. (3DSecure)
POSTCreateTransactionWithNewPaymentInfo: URL: /billing/{uuid}/transactions; Description: Do a payment process with new payment information.
POSTCreateTransactionWithPaymentInfoID: URL: /billing/{uuid}/paymentinfo/{paymentInfoId}/transactions; Description: Do a payment process with saved payment information.
GETGetTransactions: URL: /billing/{uuid}/transactions; Description: Gets a user’s transaction list.
GETGetTransactionCount: URL: /billing/transactions/{transactionDate}/count; Description: Gets a transaction count.
GETGetTransactionHistory: URL: /billing/transactions/{transactionDate}/history; Description: Gets a transaction history list.
POSTPayout Transaction: URL: /billing/{uuid}/payout; Description: Does the Payout Process.
DELETERefundTransaction: URL: /billing/{uuid}/transactions?referenceTransactionId={referenceTransactionId}&note={note}; Description: Does the Refund transaction with Reference Transaction.
PUTRejectTransaction: URL: /billing/{uuid}/transactions/{referenceTransactionId}/status; Description: Does Reject Transaction process.

Return to top