Skip to main content

PayLoadz TransactionCreation API

Frank W. - PayLoadz.com Support
Updated

The supported PayLoadz API integration is the limited TransactionCreation SOAP method. The former full API catalog and its old sample archive are retired. This page is the integration contract: an agent or developer should be able to implement from these examples without the retired sample ZIP.

Endpoint and SOAP action

  • POST https://api.payloadz.com/TransactionCreation.asmx
  • Compatibility path: POST https://api.payloadz.com/PayloadzWS.asmx
  • SOAP action: http://api.payloadz.com/TransactionCreation
  • HTTPS is required. GET requests and ASMX test/documentation pages are disabled and return HTTP 405.

Headers

POST /TransactionCreation.asmx HTTP/1.1
Host: api.payloadz.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://api.payloadz.com/TransactionCreation"

The SOAPAction header must include the quotes. SOAP 1.1 is shown here; the same method also accepts SOAP 1.2.

Credentials

There is no Profile-page API token. After PayLoadz Support approves the account, open Account > API Access to see the username and signature and to generate an API password. PayLoadz creates the password. Sellers cannot choose their own. The password is shown only once after generation. Generating a new password immediately replaces the current one and existing integrations will fail until they use the new value.

Request fields

The method keeps the legacy SOAP request shape so generated clients still work. Send exactly one product.

  • Required: APIusername, APIpassword, APIsignature, one item_number value, and payer_email.
  • item_number is an array with one string: the numeric PayLoadz product ID or the seller SKU.
  • Optional: flag_txn_id plus txn_id, first_name, and last_name.
  • If flag_txn_id is true, txn_id is required and is reused for idempotency. If it is false, PayLoadz creates a transaction id.
  • Ignored: item_name, item_price, quantity, mc_gross, mc_currency, and the other payment/address fields. Include them as empty or zero values so the SOAP shape stays valid.

Example SOAP request

Replace the credential placeholders and the product/email values. Do not commit real credentials.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TransactionCreation xmlns="http://api.payloadz.com/">
      <APIusername>YOUR_API_USERNAME</APIusername>
      <APIpassword>YOUR_API_PASSWORD</APIpassword>
      <APIsignature>YOUR_API_SIGNATURE</APIsignature>
      <item_number>
        <string>1234567</string>
      </item_number>
      <item_name>
        <string></string>
      </item_name>
      <item_price>
        <double>0</double>
      </item_price>
      <quantity>
        <int>1</int>
      </quantity>
      <mc_gross>0</mc_gross>
      <mc_currency>USD</mc_currency>
      <payer_email>buyer@example.com</payer_email>
      <flag_txn_id>true</flag_txn_id>
      <txn_id>membership-order-1001</txn_id>
      <business></business>
      <mc_fee>0</mc_fee>
      <invoice></invoice>
      <receipt_id></receipt_id>
      <custom></custom>
      <settle_amount>0</settle_amount>
      <settle_currency></settle_currency>
      <exchange_rate>0</exchange_rate>
      <first_name>Ada</first_name>
      <last_name>Lovelace</last_name>
      <address_street></address_street>
      <address_status></address_status>
      <address_city></address_city>
      <address_state></address_state>
      <address_zip></address_zip>
      <address_country></address_country>
      <address_country_code></address_country_code>
    </TransactionCreation>
  </soap:Body>
</soap:Envelope>

Example curl

curl -sS -X POST 'https://api.payloadz.com/TransactionCreation.asmx' \
  -H 'Content-Type: text/xml; charset=utf-8' \
  -H 'SOAPAction: "http://api.payloadz.com/TransactionCreation"' \
  --data-binary @request.xml

Save the SOAP envelope above as request.xml, or pipe the same XML on stdin. HTTP 200 with a TransactionCreationResult is success. SOAP faults are usually returned as HTTP 500.

Example success response

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <TransactionCreationResponse xmlns="http://api.payloadz.com/">
      <TransactionCreationResult>Download Link: https://payloadz.com/d1/?txn_id=membership-order-1001</TransactionCreationResult>
    </TransactionCreationResponse>
  </soap:Body>
</soap:Envelope>

Read the text inside TransactionCreationResult. The secure download URL is the value after Download Link: .

  • New grant: Download Link: https://payloadz.com/d1/?txn_id={transaction-id}
  • Same seller, product, and transaction id again: the same link plus (existing transaction). No second email is sent.
  • Grant created but email failed: the link is still returned, followed by Email delivery failed; please deliver this link to the customer.

Example SOAP fault

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <soap:Fault>
      <faultcode>soap:Client</faultcode>
      <faultstring>Username/Password/Signature is invalid.</faultstring>
      <detail />
    </soap:Fault>
  </soap:Body>
</soap:Envelope>

Common faultstring values:

  • Username/Password/Signature is invalid.
  • API access is not available for this account.
  • API access has not been approved for this account.
  • The product does not belong to this seller.
  • The selected product has no downloadable file.
  • The daily download grant limit has been reached.
  • The transaction id is already used for another product.
  • API request rate limit exceeded.
  • Exactly one product is required.
  • A valid payer email is required.

Example Python

import urllib.request

url = "https://api.payloadz.com/TransactionCreation.asmx"
body = open("request.xml", "rb").read()
request = urllib.request.Request(
    url,
    data=body,
    headers={
        "Content-Type": "text/xml; charset=utf-8",
        "SOAPAction": '"http://api.payloadz.com/TransactionCreation"',
    },
    method="POST",
)
with urllib.request.urlopen(request, timeout=20) as response:
    print(response.read().decode("utf-8"))

Eligibility

The seller must be an active premium account and must own the selected product. The product must have a downloadable file, and the seller's daily send limit and API rate limits apply. Access requires explicit PayLoadz Support approval and an active allowlist entry.

Credentials must not be posted in tickets or stored in client-side code. Contact PayLoadz Support for approval and integration assistance.

The restored endpoint does not expose product mutation, file upload/delete, discount, affiliate, reporting, or purchase-history methods.

Related articles