Pull Account

Use pullAccount to retrieve a registered customer’s saved payment tokens and available payment options.

This request returns all stored cards or other payment methods linked to a specific Super Wallet customer.

Common use: retrieve stored payment tokens (e.g., cards) to display as selectable options during checkout.


Endpoint

POST https://secure.3gdirectpay.com/API/v6/

Headers

Content-Type: application/xml; charset=utf-8
Accept: application/xml

Request

Required Fields

FieldTypeReqDescription
RequeststringYesMust be pullAccount
CompanyTokenstringYesToken provided by DPO to authorize API operations
customerTokenstringYesToken identifying the customer (retrieved from createAccount)

Example Request (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <Request>pullAccount</Request>
  <customerToken>E6C04D7E-C267-4243-BD1C-49170F8A008B</customerToken>
</API3G>

Tip:
Use this endpoint to show customers their saved cards, digital wallets, or payment methods for quicker checkouts.


Response

Example Success Response (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <Result>000</Result>
  <ResultExplanation>Success</ResultExplanation>
  <customerToken>E6C04D7E-C267-4243-BD1C-49170F8A008B</customerToken>
  <paymentOptions>
    <customerToken>9C6BB1D2-B2DE-46B3-8AD7-409168936DDA</customerToken>
    <option>
      <subscriptionToken>977E056D-3AD2-4DC5-AE8A-3B8CFF00741A</subscriptionToken>
      <paymentType>Mastercard</paymentType>
      <paymentLast4>0015</paymentLast4>
    </option>
  </paymentOptions>
</API3G>

Field Reference

FieldTypeDescription
ResultintegerResult code returned by the server
ResultExplanationstringHuman-readable explanation of the response
customerTokenstringCustomer’s Super Wallet token
paymentOptionsarrayContains one or more payment options
subscriptionTokenstringTokenized reference for the stored payment method
paymentTypestringPayment type or card brand (e.g., Visa, Mastercard, Mobile)
paymentLast4stringLast 4 digits of the stored card or phone number

Result Codes

CodeResultExplanationMeaning / Action
000SuccessTokens retrieved successfully
803Invalid or missing Request nameEnsure pullAccount
888System errorRetry or contact support
902Data mismatchVerify customerToken
950Missing mandatory fieldsAdd missing tags
991Encrypted string emptyRequest formatting issue
999Customer not foundEnsure account was created and verified

Typical Usage Flow

sequenceDiagram
  participant M as Merchant
  participant D as DPO API

  M->>D: pullAccount<br/>(CompanyToken, customerToken)
  D-->>M: Result 000 + paymentOptions<br/>(subscriptionToken, paymentType, paymentLast4)
  M->>M: Display available stored cards or wallets<br/>for customer selection
  Note over M,D: Use subscriptionToken for future charges<br/>via customerChargeToken

Notes & Best Practices

  • Use case: Display a customer’s saved cards or payment methods for faster checkout experiences.
  • Token handling: Store only the subscriptionToken and paymentType — never full PAN or CVV.
  • Customer verification: Ensure the customerToken is valid and active before calling this API.
  • Multiple payment options: Customers may have several saved methods; always iterate over all <option> entries.
  • Security: Handle token data securely; these tokens act as authorization credentials for subsequent payments.
  • Error handling: Always check both Result and ResultExplanation before displaying payment options.