PayMaya Payments Processing Platform (P3) API : Release Notes

Go to API specifications

v1.6.0 ¶

• New APIs

  • Final Capture (POST /p3/capture/final)
    • Includes an API to perform a Final capture on an authorization which sends out a reversal for an authorization’s remaining uncaptured amount, with the caveat that final captured transactions can no longer be captured again afterwards.

• API Enhancements

  • New field for 3DS Message Version
    • options.threeDSecure.messageVersion

• New response codes

  • 2549 | A final capture has already been done for this transaction

v1.5.5 ¶

• API Enhancements

  • New response codes
    • 2006 | Issuer generic error
    • 2059 | Issuer suspected fraud
    • 2063 | Security violation
    • 2074 | PIN encryption error
    • 2099 | Scheme/Issuer declined with a non-generic unmappable error
    • 201A | Authentication is required
    • 20R0 | Cardholder requested a stop payment order for the subscription/vaulted payment
    • 20R1 | Cardholder requested a stop payment order for all subscription/vaulted payments for this merchant
    • 20R3 | Cardholder requested a stop payment order for all subscription/vaulted payments

• Updated Information

  • Updated descriptions of error codes 2092, 2096, 2098 to denote payment scheme/issuer instead of payment gateway

v1.5.4 ¶

• Additional information
  • Added schema definition for merchant.acquiringTerminal.type for card-present requests

v1.5.3 ¶

• Additional information
  • Added valid ECI values to enumeration section of docs

v1.5.2 ¶

• API Enhancements

  • New response codes
    • ACQ096 | General Error

• Additional information

  • Added checkDigit to sample responses and fixed algorithm

v1.5.1 ¶

• Additional information
  • PayMaya P3 retains transactions only up to a period of 90 days in its Sandbox environment and 390 days in its Production environment.

v1.5 ¶

• API Enhancements
  • New customer data fields
    • payer.metadata.ipAddress
    • payer.referenceId
    • payer.fundingInstrument.card.tokenId
  • New field for DS transaction ID
    • options.threeDSecure.dsTransactionId

v1.4 ¶

• API Enhancements
  • Idempotency support for retransmissions
    • POST /p3/pay
    • POST /p3/void
    • POST /p3/refund
    • POST /p3/authorize
    • POST /p3/capture
  • Geotag support by using the following request headers
    • Latitude
    • Longitude
  • New response codes
    • ACQ089 | General Network Communication Error
    • ACQ090 | Acquirer Network Communication Error (type 1)
    • ACQ091 | Scheme Network Communication Error (type 1)
    • ACQ092 | Scheme Network Communication Error (type 2)
    • ACQ791 | Acquirer Network Communication Error (type 2)

v1.3 ¶

• New Features

  • Support for Online PIN acceptance / verification for Philippine-issued debit cards processed from POS terminals

• New APIs

  • New API suite: Accounts (/p3/accounts)
    • Includes APIs to perform account-based verifications
    • Currently supports Balance Inquiry only for Philippine-issued debit cards processed from POS terminals
  • New API suite: Key Management (/p3/keys)
    • Includes APIs to manage keys to be used in P3 transactions containing online PIN data
  • New API suite: BINs Configuration (/p3/config/cards/bins)
    • Includes APIs to get BIN-related information processable by P3
    • Currently supports only BINs for Philippine-issued debit cards processable from POS terminals

• API Enhancements

  • Authorization (POST /p3/authorize)
  • Sale/Purchase (POST /p3/pay)
    • Support authorizations with Online PIN verification
    • Support optionally specifying cardholder verification method (CVM) as part of authorization requests
    • Support indicating payer.fundingInstrument.card.type and payer.fundingInstrument.card.account
  • Void (POST /p3/void)
    • New Void Reason Code: 04 - Card was pulled out from POS terminal before transaction completion

• Overall

  • New response codes
    • ACQ065 | Key ID Does Not Exist
    • ACQ066 | Key ID is not valid for this transaction
    • ACQ067 | PIN translation failed
    • ACQ068 | PIN block is invalid
    • ACQ069 | Key operation failed
    • ACQ070 | Key is already expired
    • ACQ073 | BIN Does Not Exist
    • ACQ700 | Acquirer host synchronization error

v1.2.5 ¶

• API Enhancements
  • New response codes
    • ACQ084 | Transaction was blocked by the Acquirer

v1.2.4 ¶

• API Enhancements
  • Authorization (POST /p3/authorize)
    • Support FINAL authorization (NOTE: FINAL authorizations are not eligible for partial captures)
  • New response codes
    • 2062 | Restricted card
    • ACQ062 | Transaction cannot be routed / processed

v1.2.3 ¶

• API Enhancements
  • Authorization (POST /p3/authorize)
  • Sale/Purchase (POST /p3/pay)
    • Support indicator for merchant and/or payment gateway vaulted card transactions via payer.fundingInstrument.card.vaulted parameter
    • Support indicator for transaction initiator via transaction.initiator parameter
    • Support indicator for transaction intent via transaction.intent parameter

v1.2.2 ¶

• New APIs

  • Update Transaction Parameters (Sandbox Only) (POST /transactions/{referenceNo})
    • A Sandbox-Only API that updates parameters of a transaction given its reference number to facilitate testing in PayMaya P3’s sandbox environment.

• API Enhancements

  • Check Transaction (GET /p3/transactions/{refNo})
  • List Transactions (GET /p3/transactions/)
    • Return the following additional response fields, if available:
      • receipt.receiptNo
      • merchant.metadata.refNo
      • merchant.paymentFacilitator.subMerchants[0].metadata.refNo
  • List Transactions (GET /p3/transactions/)
    • Allow filtering of transactions by refNo

v1.2.1 ¶

• New Features

  • Support for JCB E-Commerce Transactions
    • PayMaya P3 can now authorize E-Commerce JCB transactions. Refer to Test Card Information for JCB sandbox test cards.

• API Enhancements

  • Support merchant and sub-merchant reference numbers for requests in merchant.metadata.refNo and subMerchant.metadata.refNo
    • Request-Reference-No is retained, and is now primarily used as the request number of the API caller.
  • Support global postal code format in requests that may contain an Address object
    • Previously, postal codes support numeric-only format. Postal codes can now support alphanumeric, _, -, and .
  • authorizationRequest.transaction.description, paymentRequest.transaction.description, voidRequest.reason, and refundRequest.reason can now contain up to 512 characters (previously, max: 255 characters)

v1.2 ¶

• New Transaction Model: Authorization and Capture

  • For this version, only Card Present transactions are supported for Authorization and Capture model.

• New APIs

  • Authorization and Capture (POST /p3/authorize | POST /p3/capture)
    • Includes APIs to do an authorization hold and a hold capture for delayed payments capture.
  • Ping API (GET /p3/util/ping)
    • Includes an API to get the current status of P3 API (ping / health check). API can also be used to test validity of API keys, as the APIs require authentication.

• API Enhancements

  • Void API can additionally void Authorizations and Captures
  • Refund API can additional refund Captures
  • Acquirer and Issuer-trackable receipt number (RRN) is now returned in response (both success and declined response)
    • This value can be printed in receipts, and can be used by merchant / customer when inquiring to PayMaya (Acquirer) or to card issuer
  • Support for Recurring Payment Transactions (transaction.frequencyIndicator = RECURRING)
  • P3 API Client can now specify the following optional information in requests for additional reconciliation data:
    • Batch number (trace.batchNo)
    • Client/Terminal/Gateway Trace number (trace.traceNo)

v1.1 ¶

• New APIs
  • Transaction Check Status (GET /p3/transactions)
    • Includes APIs to check a single transaction based on a TRN or a Request-Reference-No, or a set of transactions based on certain search parameters

v1.0 ¶

Initial platform release. Supports APIs to do sale/purchase, void, and refund transactions.

• New APIs
  • Sale/Purchase (POST /p3/pay)
  • Void Purchase (POST /p3/void)
  • Refund Purchase (POST /p3/refund)