POST api/v1/profiles/charge

Charge a registered customer's credit card. Funds will be secured if transaction approved.

Request Information

URI Parameters

None.

Body Parameters

TransactionCustomerBindingModel
NameDescriptionTypeAdditional information
Authentication

AuthenticationModel

Required

Request

TransactionCustomerRequestModel

Required

Request Formats

application/json, text/json

Sample:
{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "TransactionType": "(0 - authorize, 1 - charge, 2 - refund)",
    "CustomerProfileId": "123456789",
    "PaymentProfileId": "123456789",
    "TransactionDateTime": "2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "Amount": "20.50 (include decimal places)",
    "CurrencyCode": "USD (see ISO 4217 for correct currency codes)",
    "TransactionReference": "2343-0988 (unique for each transaction)",
    "Description": "The Great Works of Enid",
    "Discount": {
      "DiscountCode": "1234",
      "Product": "Storage"
    },
    "Marketing": null,
    "RevenuePartner": null,
    "DealType": null,
    "RenderCreditPrice": null
  }
}

application/xml, text/xml

Sample:
<TransactionCustomerBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <Amount>20.50 (include decimal places)</Amount>
    <CurrencyCode>USD (see ISO 4217 for correct currency codes)</CurrencyCode>
    <CustomerProfileId>123456789</CustomerProfileId>
    <DealType i:nil="true" />
    <Description>The Great Works of Enid</Description>
    <Discount>
      <DiscountCode>1234</DiscountCode>
      <Product>Storage</Product>
    </Discount>
    <Marketing i:nil="true" />
    <PaymentProfileId>123456789</PaymentProfileId>
    <RenderCreditPrice i:nil="true" />
    <RevenuePartner i:nil="true" />
    <TransactionDateTime>2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)</TransactionDateTime>
    <TransactionReference>2343-0988 (unique for each transaction)</TransactionReference>
    <TransactionType>(0 - authorize, 1 - charge, 2 - refund)</TransactionType>
  </Request>
</TransactionCustomerBindingModel>

Response Information

Resource Description

TransactionCustomerOutgoingModel
NameDescriptionTypeAdditional information
Message

MessageModel

None.

Response

TransactionCustomerResponseModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  },
  "Response": {
    "ResponseCode": "(0 - approved, 1 - declined, 2 - held for review, 3 - error)",
    "ResponseCodeText": "(Approved/Declined/Referred/Error/Error message)",
    "AuthCode": "B800ZS1 (no value for refunds or voids)",
    "AvsResultCode": "(A - address (street) matches, zip does not, B - address information not provided for avs check, E - avs error, G - non-u.s. card issuing bank, N - no match on address (street) or zip, P - avs not applicable for this transaction, R - retry—system unavailable or timed out, S - service not supported by issuer, U - address information is unavailable, W - nine digit zip matches, address (street) does not, X - address (street) and nine digit zip match, Y - address (street) and five digit zip match, Z - five digit zip matches, address (street) does not)",
    "CvvResultCode": "(M - match, N - no match, P - not processed, S - should have been present, U - issuer unable to process request)",
    "TransactionReference": "2343-0988 (will match your transaction reference)",
    "TransactionID": "3212345 (must be used in follow up requests regarding this transaction)",
    "DiscountedAmount": "0.00"
  }
}

application/xml, text/xml

Sample:
<TransactionCustomerOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>(2 digit code reflecting result of request - 00 is good)</Code>
    <Description>(Message response in text depending upon request/result of request)</Description>
  </Message>
  <Response>
    <AuthCode>B800ZS1 (no value for refunds or voids)</AuthCode>
    <AvsResultCode>(A - address (street) matches, zip does not, B - address information not provided for avs check, E - avs error, G - non-u.s. card issuing bank, N - no match on address (street) or zip, P - avs not applicable for this transaction, R - retry—system unavailable or timed out, S - service not supported by issuer, U - address information is unavailable, W - nine digit zip matches, address (street) does not, X - address (street) and nine digit zip match, Y - address (street) and five digit zip match, Z - five digit zip matches, address (street) does not)</AvsResultCode>
    <CvvResultCode>(M - match, N - no match, P - not processed, S - should have been present, U - issuer unable to process request)</CvvResultCode>
    <DiscountedAmount>0.00</DiscountedAmount>
    <ResponseCode>(0 - approved, 1 - declined, 2 - held for review, 3 - error)</ResponseCode>
    <ResponseCodeText>(Approved/Declined/Referred/Error/Error message)</ResponseCodeText>
    <TransactionID>3212345 (must be used in follow up requests regarding this transaction)</TransactionID>
    <TransactionReference>2343-0988 (will match your transaction reference)</TransactionReference>
  </Response>
</TransactionCustomerOutgoingModel>