Authorize

post

https://pg-sandbox.paymaya.com/p3/authorize

Perform an authorization hold. A successful authorization is held by P3 until a Capture call is performed, or the authorization hold expires.Provide an authorization object that includes information about the authorizationType, merchant, payer, and transaction. card type is supported for fundingInstrument.

Body Params

merchant

object

required

Information about the merchant performing the request for the cardholder.

payer

object

required

Information about the cardholder where the source of funds for the transaction will come from.

transaction

object

required

Information about the transaction being performed.

trace

object

Values supplied by the transaction originator / terminal that can be used for reconciliation of transactions

authorizationType

string

enum

required

Authorization type that describes the capture limits and hold periods (among others) that is supported by this authorization.

Allowed:

options

object

Additional options for the payment transaction

Headers

Request-Reference-No

string

required

length between 12 and 36

A reference number sent by the API caller to tag the transaction in P3.

X-Idempotency-Key

string

An id that marks the transmission/re-transmission for idempotency checks and identifies this transmission separately from other reference numbers

Longitude

number

A geographic coordinate that specifies the east–west position of a point on the Earth's surface

Latitude

number

A geographic coordinate that specifies the north-south position of a point on the Earth's surface

Responses

`202`

`message` and `code` in response body for more information

200Success

202In the case that a retransmission is sent while a first transmission is still ongoing, a pending response is returned with the HTTP status 202

defaultError encountered while processing. Please refer to HTTP status code, message and code in response body for more information

`202`

`message` and `code` in response body for more information