Payment Composition
Every field of a payment method in an action event’s paymentComposition: the operation, amount, result, provider, acquirer data and any dispute.
Base composition fields shared between payment and payout operations.
Operation Type that was executed in the Provider.
Authorize, Preauthorize, Capture, Cancel, Refund, Credit, SendNotification, CaptureNotification, RefundNotification, CancelNotification, AuthorizeNotification, ChargebackNotification, ChargebackReverseNotification, Get, Search, GetToken, Tokenize, DisableToken, Register, Generate3DS, Validate3DS, PayerAuthInit, PayerAuthCheckEnroll, PayerAuthValidate, RefundFailedNotification, RefundReversedNotification, CaptureFailedNotification, ValidateRedirect, RefundNotificationUpdated Code of the integration type for using the payment method in the provider.
api, hpp, inperson The amount used to execute the operation.
Operation outcome. If true, then the operation was finished successfully, and false otherwise.
Code of the payment method selected to perform the payment.
alexBankMa7fazty, amazonPay, applePay, audi2pay, alfa, alipay, bankTransfer, card, 2c2p, capitecPay, cibSmartWallet, easypaisa, etisalatCash, fawryMobileWallet, fawryPay, googlePay, jazzCash, mercadoPago, monoDirectDebit, nbePhoneCash, orangeCash, oPayWallet, pagaWallet, payflex, payjustnow, payPal, pix, konnect, qnbEWallet, wafaCashWallet, weCash, genericRedirect, eftPro, upi, upiDirect, cashFreeWallet, paytmMWallet, netBanking, meezaWallet, vodafoneCash, alipayQRCode, sepaDirectDebit, sepaDirectDebitDirect, dcb, bankAccount, modo, ach, payzoneCash, revolutPay, lean, tabby, boleto, oxxo, spei, promptPay, qris, momoVN, vietQR, konbini, touchNGo, gCash, maya, pse, pagoEfectivo, napas, duitNowQR, grabPay, shopeePay, nequi, picPay, ovo, trueMoney, iDeal, iDealDirect, bancontact, mbWay, mbWayDirect, khipu, razerGold, webPay, smartPix, venmo, klarnaPayLater, klarnaPayNow, klarnaPayOverTime, knet, scalapay, bizum, payNow, atome, fpx, swish, bcp Unique identifier of the Payment Instrument that the customer selected for the Payment.
Holder intention to store the payment instrument on payout.
Result of the Operation according to Payrails mapping from the provider response.
Success, Accepted, Pending, HTTPRedirectRequired, FormRedirectRequired, Unknown, UnexpectedProviderResponse, ProviderUnknownError, ProviderConnectionError, Timeout, ProviderTimeout, GenericRejection, FraudRisk, DuplicateOperation, OperationNotAllowed, InstrumentNotAllowed, InvalidInstrument, InsufficientBalance, BlockedInstrument, ExpiredInstrument, ValidationError, ParamsError, ProviderConfigError, InvalidSignature, InternalServerError, PayerCanceled, AuthenticationError, AuthenticationRequired, LimitExceeded, PaymentMethodNotSupported, AuthorizationRevoked Unique identifier of the provider used to execute the operation.
Provider used to execute the operation.
Unique identifier of the provider configuration used to execute the operation.
Reference of the operation in the provider's system.
The reason why the operation was not successful, set if success = false.
Indicates whether the payment was an Account Funding Transaction. For example, loading a prepaid card, topping up a wallet, or funding a person-to-person (P2P) money transfer.
The acquirer authorization code if the payment was authorized.
Merchant Identifier (MID) on the acquirer that processed the payment.
Account Code on the acquirer that processed the payment.
Country Code on the acquirer that processed the payment.
Address Verification Service (AVS) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.
Y: address and postal code both match.A: address matches, postal code does not.Z: postal code matches, address does not.N: neither address nor postal code match.U: the issuer could not perform the check.
Card security code (CVV/CVC) check result, normalized to the card-network single-letter convention. Set only when the provider reports the check, and carried on subsequent operations (capture, cancel, refund) of the same payment. More values may be added as more providers report this check.
M: security code matched.N: security code did not match.U: the issuer could not perform the check.P: the check was expected but not processed.
Acquirer Reference Number (ARN) assigned to the payment by the issuer.
Unique identifier of the Payment in an external system, e.g. PSP.
Retrieval Reference Number (RRN) assigned to the payment by the issuer.
Payment Instrument and tokens used to execute the authorize operation.
Any provider-specific response data requested by merchant on authorize.
Provider configuration details associated with this operation.
Dispute related to the Workflow execution.
Information about an action retry. Present if the action failed, and a retry is scheduled.
Capture mode used for the payment operation.
Instant, Manual, Delayed Unique identifier of the Payment affected during execution of the operation.