POST api/v1/payments/creditcard/transaction/settle
Request settlement of a previously authorized credit card transaction. Will result in securing monies from the authorization request.
Request Information
URI Parameters
None.
Body Parameters
CardTransactionFollowUpBindingModelName | Description | Type | Additional information |
---|---|---|---|
Authentication | AuthenticationModel |
Required |
|
Request | TransactionCardFollowUpRequestModel |
Required |
Request Formats
application/json, text/json
Sample:
{ "Authentication": { "Id": "170200123", "Key": "467512342123" }, "Request": { "TransactionType": "(4 - settle, 5 - void)", "TransactionDateTime": "2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)", "Amount": "20.50 (include decimal places - must match original)", "CurrencyCode": "USD (see ISO 4217 for correct currency codes - must match original)", "OriginalTransactionReference": "2343-0988 (must be the same as original authorization/charge)", "OriginalTransactionDateTime": "(YYYY-MM-DD HH:MM:SS - must be the same as original date time)", "Email": "angie@collards.edu (cardholder's email address)", "AuthCode": "WXN098 (must match original authorization/charge response)", "TransactionId": "3212345 (must match original authorization/charge response)", "Reason": "Customer canceled (free form text, useful for audit trail)" } }
application/xml, text/xml
Sample:
<CardTransactionFollowUpBindingModel 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 - must match original)</Amount> <AuthCode>WXN098 (must match original authorization/charge response)</AuthCode> <CurrencyCode>USD (see ISO 4217 for correct currency codes - must match original)</CurrencyCode> <Email>angie@collards.edu (cardholder's email address)</Email> <OriginalTransactionDateTime>(YYYY-MM-DD HH:MM:SS - must be the same as original date time)</OriginalTransactionDateTime> <OriginalTransactionReference>2343-0988 (must be the same as original authorization/charge)</OriginalTransactionReference> <Reason>Customer canceled (free form text, useful for audit trail)</Reason> <TransactionDateTime>2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)</TransactionDateTime> <TransactionId>3212345 (must match original authorization/charge response)</TransactionId> <TransactionType>(4 - settle, 5 - void)</TransactionType> </Request> </CardTransactionFollowUpBindingModel>
Response Information
Resource Description
CardTransactionOutgoingModelName | Description | Type | Additional information |
---|---|---|---|
Message | MessageModel |
None. |
|
Response | CardTransactionResponseModel |
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": "(1 - approved, 2 - declined, 3 - error, 4 - held for review, )", "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)", "CardType": "Visa (text stating the card type of the card used)", "DiscountedAmount": "0.00", "CustomerId": null, "ProfileId": null } }
application/xml, text/xml
Sample:
<CardTransactionOutgoingModel 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> <CardType>Visa (text stating the card type of the card used)</CardType> <CustomerId i:nil="true" /> <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> <ProfileId i:nil="true" /> <ResponseCode>(1 - approved, 2 - declined, 3 - error, 4 - held for review, )</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> </CardTransactionOutgoingModel>