triPOS REST API

<back to all web services

UpdatePaymentAccountCreditRequest

The following routes are available for this service:
PUT/api/v1/paymentAccount/{paymentAccountId}Updates a payment account based on the given data.
PUT/api/v1/paymentAccount/{paymentAccountId}/credit[Deprecated] Use /api/v1/paymentAccount/{paymentAccountId} instead.
UpdatePaymentAccountCreditRequest Parameters:
NameParameterData TypeRequiredDescription
AddressbodyAddressNoThe cardholder address information for the transaction.
ExpirationMonthbodystringNoThe expiration month.
ExpirationYearbodystringNoThe expiration year.
LaneIdbodyintNoThe Lane ID.
PaymentAccountIdpathstringYesThe payment account ID to update.
PaymentAccountReferenceNumberbodystringNoThe payment account reference number
UpdateCardDatabodybool?NoThe value that is passed in for UpdateCardData. Should be true or false.
Address Parameters:
NameParameterData TypeRequiredDescription
BillingAddress1bodystringNoThe street address used for billing purposes.
BillingAddress2bodystringNoThe street address used for billing purposes.
BillingCitybodystringNoThe name of the city used for billing purposes.
BillingEmailbodystringNoThe e-mail address used for billing purposes.
BillingNamebodystringNoThe name used for billing purposes.
BillingPhonebodystringNoThe phone number used for billing purposes. The recommended format is (800)555-1212.
BillingPostalCodebodystringNoThe postal code used for billing purposes.
BillingStatebodystringNoThe name of the state used for billing purposes. This value may be any 2 character state code or the full state name.
ShippingAddress1bodystringNoThe street address used for shipping purposes.
ShippingAddress2bodystringNoThe street address used for shipping purposes.
ShippingCitybodystringNoThe name of the city used for shipping purposes.
ShippingEmailbodystringNoThe e-mail address used for shipping purposes.
ShippingNamebodystringNoThe name used for shipping purposes.
ShippingPhonebodystringNoThe phone number used for shipping purposes. The recommended format is (800)555-1212
ShippingPostalCodebodystringNoThe postal code used for shipping purposes.
ShippingStatebodystringNoThe name of the state used for shipping purposes. This value may be any 2 character state code or the full state name.
UpdatePaymentAccountCreditResponse Parameters:
NameParameterData TypeRequiredDescription
BinValuebodystringNoThe BIN entry that matched the account number.
CardLogobodystringNoThe card logo. Possible values are: Visa, Mastercard, Discover, Amex, Diners Club, JCB, Carte Blanche, Other.
ExpirationYearbodystringNoThe card's expiration year
ExpirationMonthbodystringNoThe card's expiration month
PaymentAccountIdbodystringNothe payment account ID.
PaymentAccountReferenceNumberbodystringNothe payment account reference number.
TerminalIdbodystringNoThe ID of the terminal used during the transaction.
AccountNumberbodystringNoThe credit card number with the value masked except for the last 4.
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ApprovalNumberbodystringNoApproval number from the processor. Depending on card type and processor an approval number might not be returned.
IsApprovedbodyboolNoSet to true if the host approved the transaction.
ProcessorbodyProcessorNoResponse information from the processor.
StatusCodebodyTransactionFlowStatusNoThe status code for the transaction.

Allowable Values

  • None
  • Success
  • Declined
  • Approved
  • Restart
  • Failed
  • HostError
  • Timeout
  • FailedVerification
  • CardError
  • UnknownCard
  • UnsupportedCard
  • DeviceError
  • Cancelled
  • ChipError
  • PinPadError
  • PinPadTimeout
  • InvalidLane
  • SwipedCardIsChipCapable
  • ApprovedByMerchant
  • ChipReaderError
  • UseChipReader
  • UseMagneticStripe
  • CardRemoved
  • CardBlocked
  • CardNotSupported
  • BadCard
  • CandidateListEmpty
  • IssuerAuthenticationFailed
  • CardDataEncryptionNotEnabled
  • ApprovedExceptCashback
  • ApplicationBlocked
TransactionDateTimebodystringNoTransaction date/time in ISO8601 format
TransactionIdbodystringNoThe transaction ID from the processor
MerchantIdbodystringNoThe Merchant used to process the transaction.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/UpdatePaymentAccountCreditRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<updatePaymentAccountCreditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <address>
    <billingAddress1>String</billingAddress1>
    <billingAddress2>String</billingAddress2>
    <billingCity>String</billingCity>
    <billingEmail>String</billingEmail>
    <billingName>String</billingName>
    <billingPhone>String</billingPhone>
    <billingPostalCode>String</billingPostalCode>
    <billingState>String</billingState>
    <shippingAddress1>String</shippingAddress1>
    <shippingAddress2>String</shippingAddress2>
    <shippingCity>String</shippingCity>
    <shippingEmail>String</shippingEmail>
    <shippingName>String</shippingName>
    <shippingPhone>String</shippingPhone>
    <shippingPostalCode>String</shippingPostalCode>
    <shippingState>String</shippingState>
  </address>
  <expirationMonth>String</expirationMonth>
  <expirationYear>String</expirationYear>
  <laneId>0</laneId>
  <paymentAccountId>String</paymentAccountId>
  <paymentAccountReferenceNumber>String</paymentAccountReferenceNumber>
  <updateCardData>false</updateCardData>
</updatePaymentAccountCreditRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<updatePaymentAccountCreditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <_errors>
    <error>
      <developerMessage>String</developerMessage>
      <errorType>String</errorType>
      <exceptionMessage>String</exceptionMessage>
      <exceptionTypeFullName>String</exceptionTypeFullName>
      <exceptionTypeShortName>String</exceptionTypeShortName>
      <userMessage>String</userMessage>
    </error>
  </_errors>
  <_hasErrors>true</_hasErrors>
  <_links>
    <link>
      <href>/api/v1/paymentAccount/String</href>
      <method>PUT</method>
      <rel>paymentAccountCredit</rel>
    </link>
    <link>
      <href>/api/v1/paymentAccount/String</href>
      <method>DELETE</method>
      <rel>paymentAccountCredit</rel>
    </link>
    <link>
      <href>/api/v1/sale/String</href>
      <method>POST</method>
      <rel>paymentAccountSale</rel>
    </link>
    <link>
      <href>/api/v1/authorization/String</href>
      <method>POST</method>
      <rel>paymentAccountAuthorization</rel>
    </link>
    <link>
      <href>/api/v1/refund/String</href>
      <method>POST</method>
      <rel>paymentAccountRefund</rel>
    </link>
  </_links>
  <_logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_logs>
  <_type>String</_type>
  <_warnings>
    <warning>
      <developerMessage>String</developerMessage>
      <userMessage>String</userMessage>
    </warning>
  </_warnings>
  <_processor>
    <expressResponseCode>String</expressResponseCode>
    <expressResponseMessage>String</expressResponseMessage>
    <hostResponseCode>String</hostResponseCode>
    <hostResponseMessage>String</hostResponseMessage>
    <logs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </logs>
    <processorLogs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </processorLogs>
    <processorRawResponse>String</processorRawResponse>
    <processorReferenceNumber>String</processorReferenceNumber>
    <processorRequestFailed>false</processorRequestFailed>
    <processorRequestWasApproved>false</processorRequestWasApproved>
    <processorResponseCode>Unknown</processorResponseCode>
    <processorResponseMessage>String</processorResponseMessage>
    <rawResponse>String</rawResponse>
  </_processor>
  <approvalNumber>String</approvalNumber>
  <isApproved>false</isApproved>
  <merchantId>String</merchantId>
  <statusCode>None</statusCode>
  <transactionDateTime>String</transactionDateTime>
  <transactionId>String</transactionId>
  <accountNumber>String</accountNumber>
  <binValue>String</binValue>
  <cardLogo>String</cardLogo>
  <expirationMonth>String</expirationMonth>
  <expirationYear>String</expirationYear>
  <paymentAccountId>String</paymentAccountId>
  <paymentAccountReferenceNumber>String</paymentAccountReferenceNumber>
  <terminalId>String</terminalId>
</updatePaymentAccountCreditResponse>