POST api/v1/profiles/settle

Void a registered customer's transaction. Will stop a previously authorised transaction if not already processed by the bank.

Request Information

URI Parameters

None.

Body Parameters

TransactionCustomerFollowUpBindingModel

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		TransactionCustomerFollowUpRequestModel	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-11-15 12:22:42 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "Amount": "4.09 (include decimal places)",
    "CurrencyCode": "USD (see ISO 4217 for correct currency codes)",
    "TransactionId": "3212345 (must match original authorization/charge response)",
    "OriginalTransactionReference": "2343-0988 (unique for each transaction)",
    "OriginalTransactionDateTime": "(YYYY-MM-DD HH:MM:SS - must be the same as original date time)",
    "AuthCode": "WXN098 (must match original authorization/charge response)",
    "Reason": "Wrong book ordered. (Only used for voids.)"
  }
}

application/xml, text/xml

Sample:

<TransactionCustomerFollowUpBindingModel 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>4.09 (include decimal places)</Amount>
    <AuthCode>WXN098 (must match original authorization/charge response)</AuthCode>
    <CurrencyCode>USD (see ISO 4217 for correct currency codes)</CurrencyCode>
    <CustomerProfileId>123456789</CustomerProfileId>
    <OriginalTransactionDateTime>(YYYY-MM-DD HH:MM:SS - must be the same as original date time)</OriginalTransactionDateTime>
    <OriginalTransactionReference>2343-0988 (unique for each transaction)</OriginalTransactionReference>
    <PaymentProfileId>123456789</PaymentProfileId>
    <Reason>Wrong book ordered. (Only used for voids.)</Reason>
    <TransactionDateTime>2025-11-15 12:22:42 (YYYY-MM-DD HH:MM:SS - UTC format)</TransactionDateTime>
    <TransactionId>3212345 (must match original authorization/charge response)</TransactionId>
    <TransactionType>(0 - authorize, 1 - charge, 2 - refund)</TransactionType>
  </Request>
</TransactionCustomerFollowUpBindingModel>

Response Information

Resource Description

TransactionCustomerOutgoingModel

Name	Description	Type	Additional 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>