Retrieve Payment via ID

get https://pg-sandbox.paymaya.com/payments/v1/payments/{paymentId}

Retrieve the transaction information by supplying its payment ID.

For Basic Authentication, use SECRET API KEY. Learn more

Recipes

📖

How to test my webhook endpoint

Open Recipe

📖

Webhook Code Example

Open Recipe

Related Guides:

Response

Response body

object

string

required

The unique identification of the payment transaction.

isPaid

boolean

required

Indicates if the payment is processed successfully or not.

status

string

required

Indicates the current state of the payment transaction.

PENDING_TOKEN PENDING_PAYMENT FOR_AUTHENTICATION AUTHENTICATING AUTH_NOT_ENROLLED AUTH_SUCCESS AUTH_FAILED PAYMENT_SUCCESS PAYMENT_FAILED PAYMENT_PROCESSING AUTHORIZED PAYMENT_EXPIRED PAYMENT_CANCELLED PAYMENT_INVALID VOIDED REFUNDED ACCOUNT_ABUSE CAPTURED DONE CAPTURE_HOLD_EXPIRED

amount

float

required

0.01 to 9999999

Amount of the transaction.

currency

string

required

length between 3 and 3

ISO 4217 Alpha-3 currency code

canVoid

boolean

required

Indicates if the payment can be voided (e.g. same-day reversal for card transactions).

canRefund

boolean

required

Indicates if the payment can be refunded (e.g. next-day reversal for card transactions).

canCapture

boolean

required

Indicates if the payment can be captured for settlement to merchant. This is only relevant for authorization payments.

createdAt

date-time

required

The timestamp in UTC when the record is created.

updatedAt

date-time

required

The timestamp in UTC when the record is last updated.

requestReferenceNumber

string

length between 1 and 36

The merchant's reference number for the transaction. It is strongly advised that the merchant provide unique value for this property for each transaction.

description

string

Contains identifying information regarding the payer of the transaction. It may contain the payer's email address, name, or address line.

paymentTokenId

string

The string token representing the card information (only relevant for card-based payments).

verificationUrl

url

The URL that the payer needs to open in the browser to complete payment via 3DS authentication.

fundSource

object

batchNumber

string

length between 1 and 36

The batch number of a terminal-based payment.

traceNumber

string

length between 1 and 36

The batch number of a terminal-based payment.

emvIccData

string

length between 1 and 340

EMV ICC binary data returned by the Issuer. To be used for post-processing (e.g., Issuer Authentication by EMV EXTERNAL AUTHENTICATE or 2nd GENERATE AC).

receipt

object

Additional transaction reference numbers generated by either the issuing bank or the acquiring host. This is only relevant for card and PayMaya Account payments.

transactionId

string

Unique identifier returned by the issuer for this transaction.

approvalCode

string

Approval Code / Authorization Identification Code generated by the issuer to indicate the approval of a transaction

batchNo

string

length between 1 and 8

Value supplied by P3 or the value of transaction.trace.batchNo during the request (if supplied) which indicates the batch of transactions that the specific transaction has been grouped with. Merchants may keep track of this value for reconnaissance.

traceNo

string

length between 1 and 8

Value of transaction.trace.traceNo during the request (if supplied)

receiptNo

string

length between 1 and 12

A receipt / reference number generated by the acquirer. Can be used by all parties (cardholder merchant payment gateway acquirer issuer) when looking up a specific transaction record for reconnaisance.

approvalCode

string

Approval Code / Authorization Identification Code generated by the issuer to indicate the approval of a transaction

receiptNumber

string

length between 1 and 12

authorizationType

string

For card transactions, it indicates the type of authorization applied. For more information, click this link.

NORMAL FINAL PREAUTHORIZATION

capturedAmount

float

Indicates the total amount already captured for this authorization payment. Only applicable if the transaction has an authorizationType.

authorizationPayment

string

The unique identification of the authorization payment associated to this payment. Only applicable if this is a capture payment.

capturedPaymentId

string

The unique identification of the capture payment associated to this payment. Only applicable if this is an authorization payments.

subscription

string

The unique identification of the subscription associated to this payment.

metadata

object

Used to provide additional data to the transaction such a payment faciliator information.

subMerchantRequestReferenceNumber

string

length between 1 and 36

Reference number of the sub-merchant for the related transaction

object

For a payment facilitator, this provides details regarding the sub-merchant.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://pg-sandbox.paymaya.com/payments/v1/payments/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Retrieve Payment via ID

Related Guides:

Payment APIs

Developer resources

More

Related Guides:

200Successfully retrieved payment information.

Payment APIs

Developer resources

More