Search

Index

Revindex Storefront

SalesPayment

The SalesPayment object tracks payments belonging to a sales order.

AuthorizeSalesPayment

This service is used to authorize a payment transaction.

Request Parameters

Node Required Data Type Description
accountNumber Yes/No String The account number is usually used by ACH/eCheck payment method. This value is required for ACH/eCheck payment method.
accountType Yes/No Integer The account type is usually used by ACH/eCheck payment method. This value is required for ACH/eCheck payment method. See Gateway.AccountType
amount Yes Decimal  
city Yes String  
company No String  
countryCode Yes String  
creditCardCvv Yes/No String The credit card verification value. This value may be required when performing the Authorize or Purchase transaction for a credit card payment method especially if this is the first time you transact with this card. Subsequent transactions from the same card normally do not require the CVV value. You are not allowed to store this value in permanent storage under any circumstances. This value is not used if you are providing a ProfileNumber and/or PaymentNumber token.
creditCardExpiryMonth Yes/No String This should be a numeric representation of the month ranging from 1 to 12. You may also represent it with a leading zero as 01 to 12. This value is required when performing the Authorize or Purchase transaction for a credit card payment method. This value is not used if you are providing a ProfileNumber and/or PaymentNumber token.
creditCardExpiryYear Yes/No String The expiry year. e.g. "2025". This value is required when performing the Authorize or Purchase transaction for a credit card payment method. This value is not used if you are providing a ProfileNumber and/or PaymentNumber token.
creditCardHint Yes/No String The credit card number hint that will be displayed to the user. This is normally the last 4 digits of the credit card. This value is required when performing the Authorize or Purchase transaction for a credit card payment method. This value is not used if you are providing a ProfileNumber and/or PaymentNumber token.
creditCardNumber Yes/No String Credit card number. This value is required when performing the Authorize or Purchase transaction for a credit card payment method. This value is not used if you are providing a ProfileNumber and/or PaymentNumber token.
email Yes String  
failureReturnUrl No String The URL that the gateway should return if the transaction failed, normally used for 3D Secure.
firstName Yes String  
institutionName Yes/No String The institution name is usually used by ACH/eCheck payment method. This value is required for ACH/eCheck payment method.
institutionNumber Yes/No String The institution number is usually used by ACH/eCheck payment method.
lastName Yes String  
notificationUrl No String The resource URL that can handle an async callback normally used to obtain transaction results after a redirection.
origin Yes Integer The payment origin. See PaymentOriginType.
parentSalesPaymentID Yes/No Integer The related parent payment object identifier or null. This value is required when performing a Capture, Refund or Void transaction.
paymentDate Yes DateTime Date and time following GMT time zone.
paymentGatewayAuthorizationCode Yes/No String The authorization code usually used to capture and pre-authorized transaction. This value is normally required when performing a Capture transaction.
paymentGatewayReferenceID Yes/No String Reference value from payment gateway. This value may be required if performing a Capture, Void or Refund transaction.
paymentGatewayToken Yes/No String Transaction token identifier returned from payment gateway. This value may be required if performing a Capture, Void or Refund transaction.
paymentGatewayTransactionID Yes/No String Transaction identifier returned from payment gateway. This value may be required if performing a Capture, Void or Refund transaction.
paymentHint No  String Payment hint to help customers identify their payment information.
paymentMethod Yes Integer The payment method type. See PaymentMethodType.
paymentNumber Yes/No String Identifier associated with the payment gateway's payment profile record. This payment token if available may be used in place of the credit card number.
phone Yes String  
postalCode Yes String  
profileNumber Yes/No String Identifier associated with the payment gateway's payment profile record. This profile token if available may be used in place of the credit card number.
salesOrderID Yes Integer The associated SalesOrder object identifier.
street Yes String  
subdivisionCode Yes String  
successReturnUrl No String The URL that the gateway should return if successful, normally used for 3D Secure.
transactionType Yes Integer Payment transaction type. See SalesPaymentTransactionType.
userHostAddress Yes String  
voucherCode Yes/No String Voucher code. This value is required for voucher payment method.
voucherHint No String Voucher hint to help customers identify their voucher information. Normally the last 4 digits of the voucher code. This value is used for voucher payment method.

 

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction. You should also verify the PaymentGatewayPaymentRedirectUrl and PaymentGatewayPaymentFormPost for additional next actions that you may need to perform if required by the gateway.


CaptureSalesPayment

This service is used to capture a previously authorized payment transaction.

Request Parameters

See AuthorizeSalesPayment request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


DeleteSalesPayment

This service is used to delete a payment transaction. Please note that deleting a payment does not reverse any charges.

Request Parameters

Node Required Data Type Description
salesPaymentID Yes Integer The object identifier.

 

Return Data

None.


GetSalesPayment

This service is used to query the SalesPayment object.

Request Parameters

Node Required Data Type Description
salesPaymentID Yes Integer The object identifier.

 

Return Data

Node Data Type Description
salesPayment XML Container node.
  accountNumber String The account number is usually used by ACH/eCheck payment method.
  accountType Integer The account type is usually used by ACH/eCheck payment method. See Gateway.AccountType
  amount Decimal  
  city String  
  company String  
  countryCode String  
  countryName String  
  createDate DateTime  
  creditCardCvv String  
  creditCardExpiryMonth String This should be a numeric representation of the month ranging from 1 to 12. You may also represent it with a leading zero as 01 to 12.
  creditCardExpiryYear String The expiry year. e.g. "2025"
  creditCardHint String The credit card number hint that will be displayed to the user. This is normally the last 4 digits of the credit card.
  creditCardNumber String Credit card number.
  email String  
  firstName String  
  institutionName String The institution name usually used by ACH/eCheck payment method.
  institutionNumber String The institution number usually used by ACH/eCheck payment method.
  lastName String  
  origin Integer The payment origin. See PaymentOriginType.
  parentSalesPaymentID Integer The related parent payment object identifier or null.
  paymentDate DateTime  
  paymentGateway String The gateway used or empty if manual transaction.
  paymentGatewayAuthorizationCode String The authorization code usually used to capture and pre-authorized transaction.
  paymentGatewayAvsResponseCode Integer The AVS address verification response code. See Gateway.AvsResponseCodeType
  paymentGatewayCvvResponseCode Integer The CVV response code. See Gateway.CvvResponseCodeType
  paymentGatewayDetailedResponse String Detailed response from payment gateway.
  paymentGatewayPayerInfo String Additional payer information from payment gateway.
  paymentGatewayPaymentFormPost String HTML instructions for payment redirect using form post from payment gateway.
  paymentGatewayPaymentHint String Payment hint returned by payment gateway.
  paymentGatewayPaymentNumber String Payment token number from payment gateway. This token is normally used in conjunction with the profile number token.
  paymentGatewayPaymentRedirectUrl String URL for payment redirect using HTTP redirect from payment gateway.
  paymentGatewayPaymentTarget String HTML instructions for payment redirect display targeting from payment gateway.
  paymentGatewayProfileNumber String Profile token number from payment gateway. This token is usually used in conjunction with the payment number token.
  paymentGatewayReferenceID String Reference value from payment gateway.
  paymentGatewayResponseCode Integer The gateway response code. See Gateway.ResponseCodeType.
 
  paymentGatewayResponseMessage String Message returned from payment gateway.
  paymentGatewayToken String Transaction token identifier returned from payment gateway.
  paymentGatewayTransactionID String Transaction identifier returned from payment gateway.
  paymentHint String Payment hint to help customers identify their payment information.
  paymentMethod Integer The payment method type. See PaymentMethodType.
  paymentNumber String Identifier associated with the payment gateway's payment profile record.
  phone String  
  postalCode String  
  profileNumber String Identifier associated with the payment gateway's payment profile record.
  salesOrderID Integer The associated SalesOrder object identifier.
  salesPaymentGUID GUID Indicate if product requires shipping.
  salesPaymentID Integer The object identifier.
  street String  
  subdivisionCode String  
  subdivisionName String  
  transactionType Integer Payment transaction type. See SalesPaymentTransactionType.
  updateDate DateTime  
  userHostAddress String  
  voucherCode String Voucher code.
  voucherHint String Voucher hint to help customers identify their voucher information. Normally the last 4 digits of the voucher code.

 


GetSalesPayments

This service is used to get all the SalesPayment objects belonging to the SalesOrder.

Request Parameters

Node Required Data Type Description
salesOrderID Yes Integer The SalesOrder object identifier.

 

Return Data

Node Data Type Description
salesPayments XML Container node
  salesPayment XML Zero or more salesPayment nodes with same data structure as GetSalesPayment service return data.

 


ManualAuthorizeSalesPayment

This service is used to record an authorization payment transaction that occurred outside of your system such as from a virtual terminal.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


ManualCaptureSalesPayment

This service is used to record a capture payment transaction that occurred outside of your system such as from a virtual terminal.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


ManualPurchaseSalesPayment

This service is used to record a purchase payment transaction that occurred outside of your system such as from a virtual terminal.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


ManualRefundSalesPayment

This service is used to record a refund payment transaction that occurred outside of your system such as from a virtual terminal.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


ManualVoidSalesPayment

This service is used to record a void payment transaction that occurred outside of your system such as from a virtual terminal.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


RefundSalesPayment

This service is used to refund a previously purchased or capture transaction.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


PostAuthorizeSalesPayment

This service is used to complete the payment transaction after returning from an authorization transaction.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


PostPurchaseSalesPayment

This service is used to complete the payment transaction after returning from a purchase transaction.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


PurchaseSalesPayment

This service is used to charge a payment transaction. This is equivalent to performing an authorization and capture at once.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction. You should also verify the PaymentGatewayPaymentRedirectUrl and PaymentGatewayPaymentFormPost for additional next actions that you may need to perform if required by the gateway.


VoidSalesPayment

This service is used to void a previously authorized payment transaction.

Request Parameters

See AuthorizeSalesPayment service request.

Return Data

Same as GetSalesPayment service return data. You should verify the PaymentGatewayResponseCode for success or failure after each transaction.


Comments


Powered by Revindex Wiki