Card Payments

Introduction to Card payments

Zūm Rails offers card payment methods designed for ease and efficiency. For example, credit card's can be used for accounts receivable transactions to request funds.

Method: POST

Endpoint: {{env}}/api/transaction

Example

Request Payload

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction is just a test from a user to wallet",
  "UserId": "1d431e8b-...85452adb4eee",
  "Authorize": {
    "Capture": false,
    "AutoExpireDays": 5
  }
}

Transaction Events

CreditCard	CreditCardInvalidRequest	When transaction has failed due to invalid request
CreditCard	CreditCardRejectedByIssuingBank	When transaction is rejected by issuing bank
CreditCard	CreditCardExpiredCard	When transaction has failed due to expired card
CreditCard	CreditCardSuspectedFraud	When transaction has failed due to suspected fraud
CreditCard	CreditCardTransactionNotPermitted	When transaction is not permitted
CreditCard	CreditCardContactSupport	When transaction has failed. Contact support
CreditCard	CreditCardInvalidMerchantSetUp	When transaction has failed due to invalid merchant setup
CreditCard	CreditCardSecurityViolation	When transaction has failed due to security violation
CreditCard	CreditCardInvalidCardOrDetails	When transaction has failed due to invalid card or card details
CreditCard	CreditCardLostOrStolenCard	When transaction has failed due to lost ot stolen card
CreditCard	CreditCardAccountClosedOrBlocked	When transaction has failed due to account closed or blocked
CreditCard	CreditCardDeemedHighRisk	When transaction has failed due to deemed high risk
CreditCard	CreditCardUnknownResponseFromIssuingBank	When transaction has failed due to unknown response from issuing bank
CreditCard	CreditCardCouldNotLocateOriginalTransaction	When reversal transaction has failed due to could not locate original transaction
CreditCard	CreditCardTransactionAlreadyReversed	When reversal transaction has failed due to already reversed
CreditCard	CreditCardGenericError	When transaction has failed due to generic error
CreditCard	CreditCardServiceUnavailable	When transaction has failed due to service unavailable
CreditCard	CreditCardRetryLater	When transaction has failed. Retry later
CreditCard	CreditCardReversalRejected	When reversal transaction is rejected
CreditCard	CreditCardDuplicateReversal	When reversal transaction has failed due to duplicated
CreditCard	CreditCardTransactionAlreadySettled	When reversal transaction has failed due to already settled
CreditCard	CreditCardTimeoutReversal	When reversal transaction has failed due to timeout
CreditCard	CreditCardDuplicateTransaction	When transaction has failed due to duplicated

Testing

To simulate an Credit Card transaction failure, include an event name from the list above in the COMMENT field when creating a transaction. If you don't mention an event in the COMMENT, the transaction will change its status to "Completed" in the sandbox environment.

Examples:

Simulating success

{
  "ZumRailsType": "AccountsReceivable",
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "This transaction will succeed because there's no keyword",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}

Simulating Failure

{  
  "TransactionMethod": "CreditCard",
  "Amount": 123.45,
  "Memo": "Memo",
  "Comment": "CreditCardExpiredCard",
  "UserId": "1d431e8b-...85452adb4eee",
  "WalletId": "8ebd932b-...b92633e14297",
  "PaymentInstrumentId": "92142401-...389ba0d87e75"
}