Skip to content

PaymentCallback & Status ​

PaymentCallback ​

Returned by every gateway's handleCallback() and by ayaPay()->verifyRedirect(), after the signature has been verified.

Property / MethodTypeDescription
orderIdstringYour order id
statusPaymentStatusThe status mapped onto this package's statuses
gatewayStatusstringThe gateway's own status value, unmapped
gatewayReference?stringThe gateway's id for the payment
amount?stringThe amount as the gateway sent it
rawarrayThe verified payload; JSON numbers are their exact text as strings
isSuccessful()boolstatus === PaymentStatus::Successful
acknowledgementAcknowledgementThe response the gateway expects (status, body, headers)

In Laravel, return MyanmarPayments::acknowledge($callback) to send the acknowledgement.

Returned by MyanmarPayments::handleCallback($gateway, $request) too, for a gateway chosen by name.

PaymentStatusResult ​

Returned by kbzPay()->status(), ayaPay()->status() and yomaMmqr()->status().

Property / MethodTypeDescription
orderId?stringYour order id. null for Yoma MMQR, which only returns the reference
statusPaymentStatusThe mapped status
gatewayStatusstringThe gateway's own status value
gatewayReference?stringThe gateway's id for the payment
amount?stringThe amount as the gateway reported it
rawarrayThe gateway's response
isSuccessful()boolstatus === PaymentStatus::Successful

PaymentStatus ​

CaseValueisFinal()
PaymentStatus::Successfulsuccessfultrue
PaymentStatus::Pendingpendingfalse
PaymentStatus::Failedfailedtrue
PaymentStatus::Canceledcanceledtrue
PaymentStatus::Expiredexpiredtrue
PaymentStatus::Unknownunknownfalse

PaymentStatus::cases() lists every status.

Released under the MIT License, except where a package says otherwise.