Payment Confirm Funds

Overview

A Payment Confirm Funds call is a call to check whether the funds for a transaction are still available and able to be settled on.

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/vM.m/stores/{StoreID}/payments/funds/confirm/ {TenderType}.xml	/v1.0/stores/TMSUS/ payments/funds/confirm/VC.xml	XML	200 + XML Response containing the confirmation results

Request Format

The request is an ConfirmFundsRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<ConfirmFundsRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    requestId="{requestId}">
  <PaymentContext>
    <OrderId>{OrderId}</OrderId>
    <PaymentAccountUniqueId isToken="{true/false}">{PAN}</PaymentAccountUniqueId>
  </PaymentContext>
  <Amount currencyCode="{currencyCode}">{Amount}</Amount>
  <PerformReauthorization>{true/false}</PerformReauthorization>
</ConfirmFundsRequest>

Request Elements and Parameters

Element	Required	Description	Type	Restriction
requestId	Required	A unique identifier for the request. The client is responsible for ensuring uniqueness across all requests the client initiates with this service.	String	40 Characters
PaymentContextBase	Required only if PaymentContext is not present	Used for Paypal, since Paypal does not have a PaymentAccountUniqueId.		See sub elements
OrderId	Required	The OrderId of the transaction to check the authorization and funds of.	String	20 Characters
PaymentContext	Required only if Payment ContextBase is not present	Payment context with a PaymentAccountUniqueId.		See sub elements
OrderId	Required	The OrderId of the transaction to check the authorization and funds of.	String	20 Characters
PaymentAccountUniqueId	Required only if EncryptedPayment AccountUniqueId is not present	The PAN of the tender used in the transaction.	String	22 Characters
isToken	Required if PaymentAccount UniqueId is present	Is the PaymentAccountUniqueId a token?	Boolean	true/false
EncryptedPaymentAccountUniqueId	Required only if PaymentAccount UniqueId is not present	A client-encrypted PAN.	String	1000 Characters
Amount	Required	The amount to authorize for the transaction.	Decimal	2 precision points. (123.45)
currencyCode	Required	Code identifies the currency for the TransactionAmount.	String	ISO-4217 three-letter code
PerformReauthorization	Optional	"true" if the system should attempt to reauthorize funds that are currently unavailable. "false" if no reauthorization should occur when confirming funds. Omission implies a value of "false"	Boolean	true/false

Request Example

<?xml version="1.0" encoding="UTF-8"?>
<ConfirmFundsRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
    requestId="1234567">
  <PaymentContext>
    <OrderId>12345</OrderId>
    <PaymentAccountUniqueId isToken="false">4111111111111111</PaymentAccountUniqueId>
  </PaymentContext>
  <Amount currencyCode="840">23.54</Amount>
  <PerformReauthorization>true</PerformReauthorization>
</ConfirmFundsRequest>

Response Format

The response is an ConfirmFundsReply message.

<?xml version="1.0" encoding="UTF-8"?>
<ConfirmFundsReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <PaymentContext>
   <OrderId>{OrderId}<OrderId/>
   <PaymentAccountUniqueId isToken="{true/false">{PAN}</PaymentAccountUniqueId>
  </PaymentContext>
  <FundsAvailable>{response}</FundsAvailable>
  <ReauthorizationAttempted>{true/false}</ReauthorizationAttempted>
</ConfirmFundsReply>

Response Elements and Parameters

Element	Required	Description	Type	Restriction
sessionId	No	Globally identifies a request message to protect against duplicate requests.	String	40 Characters
PaymentContextBase	Required only if PaymentContext is not present	Used for Paypal, since Paypal does not have a PaymentAccountUniqueId.		See sub elements
OrderId	Required	The OrderId of the authorization transaction to validate.	String	20 Characters
PaymentContext	Required only if Payment ContextBase is not present	Payment context with a PaymentAccountUniqueId.		See sub elements
OrderId	Required	The OrderId of the authorization transaction to validate.	String	20 Characters
PaymentAccountUniqueId	Required only if EncryptedPayment AccountUniqueId is not present	The PAN of the tender used in the transaction.	String	22 Characters
isToken	Required if PaymentAccountUniqueId is present	Is the PaymentAccountUniqueId a token?	Boolean	true/false
EncryptedPaymentAccountUniqueId	Required only if PaymentAccountUniqueId is not present	A client-encrypted PAN.	String	1000 Characters
FundsAvailable	Yes	Are the funds still available for the payment?	String	Success/Fail/Timeout
ReauthorizationAttempted	Required	If, during the process of confirming funds, the system attempted to perform a reauthorization for funds that were not available.	Boolean	true/false

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<ConfirmFundsReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <PaymentContext>
    <OrderId>12345</OrderId>
    <PaymentAccountUniqueId isToken="false">4111111111111111</PaymentAccountUniqueId>
  </PaymentContext>
  <FundsAvailable>{response}</FundsAvailable>
  <ReauthorizationAttempted>false</ReauthorizationAttempted>
</ConfirmFundsReply>