How Authorize and Capture works in Maya

Authorize and Capture use case is also supported in Payments Processing Platform.

Clearing or posting the authorized payments to the cardholder’s account balance may vary, depending on the Card Schemes rules and Issuing Bank process. This includes:

• Releasing of the excess on hold amount, when authorized amount is greater than the captured amount.
• Crediting of refunds to the customer’s account for the refunded capture payments.

Authorization Types and Holding Period

Authorization holding periods and amount that can be captured may vary per authorization type. See the table below for a high level overview:

How to Integrate

1 Obtain your API Keys

The Payments Processing Platform APIs uses API keys to authenticate requests. API keys carry many privileges, your grant or permission to access and integrate with Maya’s endpoints.

Authenticating with our API

Authentication is done via HTTP Basic Authentication. Depending on the API endpoint, the public (pk-....) or secret (sk-....) key must be provided as the username and the password left as blank.

Steps are as follows:

1. Combine Username and Password (left blank) separated by ‘:’ (colon). If your API key is “pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah”, the resulting string is:

pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah:

2. Apply Base64 encoding to the resulting string from Step 1. Using the resulting string from Step 1, the Base64 encoded string will be:

cGstWjBPU3pMdkljT0kyVUl2RGhkVEdWVmZSU1NlaUdTdG5jZXF3VUU3bjBBaDo=

3. Indicate the authorization method i.e. “Basic” followed by a space then the Base64 encoded string in Step 2. An example is shown below.

Authorization: Basic cGstWjBPU3pMdkljT0kyVUl2RGhkVEdWVmZSU1NlaUdTdG5jZXF3VUU3bjBBaDo=

2 Create Authorization

POST /p3/authorize

Use this endpoint to request or instruct issuers to hold or reserve the funds from the customer’s account until authorization gets cleared.

Request is similar to Purchase/Sale, with the addition of authorizationType indicating the Authorization Type.

A successful authorization will remain authorized until a Capture call is performed, or the authorization hold expires.

Funding instrument must be set to indicate the type of source of funds or where payment will be charged. Payments Processing Platform currently supports fundingInstrument: CARD

When card is used, you need to indicate the account type and card type where the transaction should be charged.

For E-commerce

"threeDSecure": 
{
      "verificationToken": "jqEmJkhI2+SDCAAAAAAJBwAAAAA=",
      "eci": "05",
      "enrolled": "Y",
      "authenticationStatus": "Y"
}

For Card-present

Initiator and Intent

You can indicate the initiator and the intent of the transaction in the Straight Payment requests. The value in these fields may be used by Issuers when determining the approval status of an authorization transaction.

INITIATOR (transaction.initiator)

INTENT (transaction.intent)

Reference Numbers

The following reference numbers can be set to provide additional tagging for each transaction during reconciliation processes:

3 Capture Authorization

POST /p3/capture

Call this endpoint to complete the authorization transaction and making it ready to be cleared. You must provide the paymentTransactionReferenceNo of the authorization.

Captured transactions are included at the end of the day’s batch processing for clearing. The cardholder will be billed upon successful clearing of a captured transaction.

Final Capture

POST /p3/capture/final

Use this endpoint to execute a final capture on a successful Authorization transaction. With this, you can perform either full or partial captures where any remaining uncaptured amount on an authorization will be voided by the schemes and issuer.

Conditional Void

POST /p3/void

Use this endpoint to void a successful transaction providing the paymentTransactionReferenceNo.

Where paymentTransactionReferenceNo pertains to either:

• paymentTransactionReferenceNo generated in Authorization requests, or
• captureTransactionReferenceNo generated for Capture

Authorization

When an authorization is cancelled, a void request can be sent to release the on-hold amount from your customer’s account / card.

You can only void an authorization or as long as:

• Authorization is not past the hold period
• No capture payment is done yet
• Authorization is not in yet voided state. If an authorization has already been voided, succeeding cancellation attempts will fail.

Captured

You can only void a successful capture payments on the day it was processed, or before the 11:59:59 PM (PH Standard Time) cut-off time. Upon voiding, capture payment will transition to VOIDED state.

Conditional Refund

POST /p3/refund

Successful capture payments can be refunded after the 11:59:59 PM (PH Standard Time) cut-off time.

Clients can perform either full or partial refunds

Full Refunds

• You just need to provide the transactionReferenceNo of the transaction to refund the full amount.

Partial Refunds

• You need to provide transactionReferenceNo and the amount to be refunded. You may continue to send partial refund requests until the entire amount for the transaction has been refunded.

4 Test your Work