ProcessRealTimeCardPayment

Usage

Attempts to process credit/debit card payment for the identified customer using the provided card details.

This method attempts to process credit/debit card payments for the identified customer using the provided card details. You can choose whether you want to create a one-off schedule for that payment or not. If a one-off schedule creation is not opted for, then a successful payment collection will get assigned to the outstanding balance of the customer’s account otherwise a new one-off schedule is created.

You also have the option to use a card stored on the customer’s account or make a payment using a different card. By stored card, we refer to the active payment method on the account and not just any card number stored on the account.

Note

This message should be used in conjunction with the message GetCardPaymentStatusForCustomerAccount if the status returned from ProcessRealTimeCardPayment is Processing.

Parameters

Name	Data Type	Length		Description
User
Username	String		Required	Provided by Debitsuccess
Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Optional – allows requesting user to be logged
AccountReferenceNo	String	15	Optional*	Debitsuccess Reference number
ExternalAccountReferenceNo	String	50	Optional*	Your account identifier
ExternalTransactionIdentifier	String	50	Required	A unique reference for the transaction (for the requesting user)
UseStoredCardDetails	Boolean		Required	false - if the customer's card details including CVC is available with you true - if the active, preferred card details on the customer's account need to be used
CreateOneOffCharge	Boolean		Required	true - DS will process payment and create a one-off schedule for the same false - PayNow will take the payment and allocate it to account balance
AccountHolder	String	50	Optional**	Cardholder name
Amount	Decimal(10,2)		Required	Amount to pay
CVC	String	4	Optional**	Card verification/security code
CardNumber	String	35	Optional**	Credit/Debit card number
CreditCardType	Enum		Optional**	Credit/debit card type AmericanExpress, Mastercard, Visa
ExpiryDate	DateTime		Optional**	Card expiry date
Notes	String	30	Optional***	Any notes to be recorded against the payment
PayerAuthorisationResponse	string		Optional	Required only if TransactionStatus is of type Requires3Ds

_{* At least one of the following parameters must be supplied:}AccountReferenceNo, ExternalAccountReferenceNo

_{** Required if}UseStoredCardDetails_{is set to false}

_{*** Required if}CreateOneOffCharge_{is set to true}

Response

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown
ProcessRealTimeCardPayment()
TransactionStatus	Enum	NotSubmitted, Processing, ServiceBusy*
PayerAuthenticationRequest	string	Value will be generated if transaction type is Require3ds
PayerAuthenticationUrl	string	Value will be generated if transaction type is Require3ds
PaymentGatewayResponse	string	Response text from CreditCardPaymentLog table

_{*A TransactionStatus of ServiceBusy can mean that the payment was successfully processed but Debitsuccess has not received confirmation. We recommend using a request such as}_{GetCardPaymentStatusForCustomerAccount}_{before re-attempting this payment to avoid charging the customer twice.}

Error Messages

Type	Error Code	Error Message
Error	13062	Payment Notes cannot exceed 30 characters
Error	13063	Transaction identifier is not valid
Error	13061	Card payment amount must be greater than or equal to $1 and less than your configured maximum value
Warning	14021	Decimal field '{0}' contains more than 2 decimal points that were ignored by message.
Error	14115	The selected payment method is not supported by this business.
Error	13069	Token cards are not yet supported.
Error	13068	Diner cards are not supported.
Error	12014	Missing AccountHolder parameter
Error	13019	AccountHolder cannot exceed 50 characters.
Error	13018	Invalid CVC number.
Error	13005	Invalid or missing credit card number
Warning	14020	DateTime field '{0}' contains time part, but the time is ignored by message.
Error	02	Invalid user credentials
Error	12016	Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.
Error	08	There is no record found with this criteria
Error	10	Account is not active
Error	07	Multiple accounts found with this criteria
Error	14102	No Legal Address found on file. Please contact Debitsuccess to add one.
Error	13064	3d secure authorisation response is required
Error	13060	Transaction identifier is not unique
Error	13066	A transaction is being processed for this identifier
Error	13070	Amount cannot be more than the outstanding balance.
Error	14053	Card details should not be supplied when UseStoredCreditCard is true.
Error	14051	No active payment method found for the account.
Error	14052	Real time payment cannot be processed for this account because the stored payment method is not a credit card.
Error	13065	CVC number is required
Info	00	Success
Error	13074	CreateOneOffCharge must be True for Gateway Accounts
Error	13075	ExternalTransactionIdentifier field cannot be more than 50 characters long
Error	13076	Cannot find commission details configured. Please contact Debitsuccess.
Error	13077	Cannot find valid merchant details configured. Please contact Debitsuccess
Error	13078	The stored credit card has expired
Error	14115	The selected payment method is not supported by this business

Filter by label

There are no items with the selected labels at this time.

On this page:

REST API

Real Time Payment Widget