Charge Token Auth (v6)

Charge an authorized transaction created by createToken using chargeTokenAuth in DPO Pay API v6.

Charge Token Auth (v6)

Charge a transaction that was created by createToken and has already been authorized.

Use chargeTokenAuth to capture an authorized transaction. If the transaction has not been authorized yet, this request will not charge it.


Endpoint

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

Headers

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

Request parameters

ParameterData typeDescriptionRequired
RequestTextMust be chargeTokenAuth.Mandatory
CompanyTokenTokenToken you received from 3G to operate this API.Mandatory
TransactionTokenTokenTransaction token received from createToken.Mandatory

Request example

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>57466282-EBD7-4ED5-B699-8659330A6996</CompanyToken>
  <Request>chargeTokenAuth</Request>
  <TransactionToken>72983CAC-5DB1-4C7F-BD88-352066B71592</TransactionToken>
</API3G>

Response fields

The server responds to the chargeTokenAuth request with the result of your request.

ParameterData typeDescription
Result3-digit codeCode sent with the result of the request.
ResultExplanationTextFree text result explanation.

Response codes

CodeExplanation
000Transaction queued for charge. The transaction is now queued for charge by DPO automated procedures.
800Transaction not authorized. The transaction has not been authorized yet. It must be authorized by the customer manually using the payment page or by the chargeTokenCreditCard request.
801Request missing company token.
802Company token does not exist.
803No request or error in request type name.
804Error in XML.
902Data mismatch in one of the fields: field name.
950Request missing mandatory fields: field name.
903Transaction not found.
905Transaction already charged.

Success response example

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <Result>000</Result>
  <ResultExplanation>Transaction queued for charge</ResultExplanation>
</API3G>

Usage notes

  • Use chargeTokenAuth only for transactions that were already authorized.
  • If you receive 800, authorize the transaction first using the payment page or chargeTokenCreditCard.
  • If you receive 905, the transaction has already been charged.
  • After a successful 000 response, the transaction is queued for DPO automated charge processing.