NAV Navbar
Logo API Reference
XML JSON

Welcome

Welcome to the Acoustic Payments API!

You can use our API to access Acoustic Payments API endpoints, which can be used to execute online payments from your web site.

Version

This edition applies to Acoustic Payments Release 20.05.

Please refer to Revision history for changes.

Introduction

All communication with Acoustic Payments takes place via the HTTP protocol, using TLS to secure the data during transit from one endpoint to the other. Basically, the client application sends a request to a server, and receives back a response. For example, a Web shop might request authorization of a credit card payment, and the response might be the approval (or decline) of such a payment.

Security

Because of the sensitive nature of payment information, all communication between clients and Acoustic Payments must be secured against eavesdropping and tampering. This is done using the Transport Layer Security (TLS) protocol on top of HTTP. The combination of HTTP and TLS or its predecessor SSL is commonly referred to as HTTPS.

TLS is used in bilateral mode, meaning that client and server mutually authenticate each other through digital certificates. The Acoustic Payments server certificate is issued by GeoTrust, so merchants should set up their security framework to trust the corresponding CA root certificate. This root certificate should be part of most standard security frameworks by default, but if missing, it can be retrieved from the GeoTrust Web site at

https://www.geotrust.com/resources/root-certificates/index.html

The client’s certificate must be issued by Acoustic Payments. Please contact your Acoustic Payments account representative to arrange this.

As a further precaution against denial-of-service attacks, Acoustic imposes limits on the size of requests sent to the server. The maximum request size is currently 250 KB except for batch requests which are allowed up to 25 MB. This corresponds to approximately 50 000 Capture transactions in a single batch. Please contact your Acoustic Payments account representative, if you believe these limits will cause a problem.

REST

Acoustic Payments web services are intended to conform to the REST architectural style.

REST can be said to represent an “object oriented” view of web services, in the sense that the main emphasis is on resources, each resource being represented by a unique URL. For example, when a web shop requests authorization of a credit card payment, it is viewed as creating a resource, in this case the authorization. That resource can be read, and it can be updated, for example when the authorization is settled. After sufficient time, it will eventually be deleted. Creating, reading, updating, and deleting resources are the typical operations in the REST universe, and are done using the standard request methods of the HTTP protocol. Roughly speaking, resources are created through POST or PUT requests, read through GET requests, and deleted through DELETE requests.

While a resource as such is an abstract concept, it usually has one or more “physical” representations. These representations can for example be human readable, or machine processable. Almost all Acoustic Payments resources are represented either as XML or JSON documents, encoded using UTF-8.

Resource types and operations

The following resource types are documented here:

Hosted payment sessions can be used to isolate a merchant’s Web application from having to handle sensitive payment data. The Web service operations on hosted payment sessions are described in Hosted sessions, but this only touches a small part of a much larger topic. For more details, merchants should refer to the Hosted Payments Implementation Guide.

Payment transactions are probably the most fundamental resources, and are used in a variety of contexts, all leading up to some type of payment from a customer to the merchant.

Batches are collections of payment transactions that can be submitted for offline processing. They are described in Batches.

Wallets are containers for payment instruments, and can be used by customers when paying online via an Acoustic hosted payment session, or by merchants when collecting recurring payments. Wallets are described in Wallets.

3D-Secure is a cardholder authentication scheme offered by some of the large credit card schemes. It is described in 3-D Secure, but merchants using Acoustic hosted payment sessions do not need to be aware of the details, as it is all handled automatically by the hosted session.

Card / routing information can be obtained for a particular card, ranging from determining the brand and verifying modulus correctness to least cost routing. The service is described in Card / routing information.

Data files can be stored securely in Acoustic’s data centres. This service is described in Data files.

Reports for a merchant can be retrieved and merchant can set up subscriptions for reports. The service is described in Reports.

Pending payments are to be used in scenarios where the merchant representative initiates a payment transaction on behalf of the customer. The service is described in Pending payments.

Ping can be used to test the connection between the merchant and Acoustic Payments. See Ping for the details.

Tokenisation can be used to generate a token can be used in a payment transaction instead of the card number (PAN), if the project code is set up to use a token group. See Tokenisation for the details.

Detokenisation can be used to obtain information about the card number behind a token. See Detokenisation for the details.

Merchant payment routing can be used in special cases where the merchant can send in merchant payment routing data to Acoustic Payments.The service is described in Merchant payment routing set up.

Payment device data can be used in special cases where the merchant can send in the information necessary for Acoustic Payments to handle inbound card present requests from a payment terminal.The service is described in Payment Device Data Set Up.

Project acquirer terminal id can be used in special cases where the merchant can send the acquirer terminal IDs needed for Acoustic Payments to associate the correct terminal ID for a given payment terminal during a card present transaction.The service is described in Merchant terminal ID setup.

The following table gives an overview of the various operations that can be performed on each type of resource. In all cases the operation is performed by using the listed HTTP method (POST, GET, PUT or DELETE) on the specified URL. In the case of a POST type operation, XML or JSON data must also be supplied in the request body, and some GET operations may require additional parameters appended to the URL as a query string.

Resource type URL POST GET DELETE PUT
Batches /bat Submit a batch N/A N/A N/A
Batch
(a specific batch)
/bat/{SRC}/{SEQ} N/A Retrieve batch data N/A N/A
Card and routing information /cri Get card information See note 1 N/A N/A
Data file
(a specific file)
/dat/{DIR}/{FID} Store a file Retrieve a file Delete a file N/A
Report /rep N/A Retrieve report N/A N/A
Report subscription /rsb Create or update a subscription Retrieve list of report subscription Delete a report subscription N/A
Ping /ping/sys N/A Test connection N/A N/A
Wallets /pro N/A N/A N/A N/A
Wallet created with Profile Group(a specific wallet) /pro/{PRG}/{PID} Add instrument to wallet Retrieve wallet contents N/A N/A
Wallet instrument (a specific payment instrument in a specific wallet) for Wallet created with a Profile Group /pro/{PRG}/{PID}/{IID} Update instrument in wallet N/A Remove instrument from wallet N/A
3-D Secure enrollment verification /s3d/enrollment Verify enrollment See note 1 N/A N/A
3-D Secure payer authentication /s3d/authentication Authenticate payer See note 2 N/A N/A
Hosted payment sessions /ses N/A N/A N/A N/A
Hosted payment session(a specific session) /ses/{ID} N/A Retrieve session data N/A N/A
Payment transactions /trx Submit a payment transaction Search for transactions N/A N/A
Payment transaction (a specific transaction) /trx/{ID} N/A Retrieve transaction data N/A N/A
Pending Payment /trx Create a pending payment N/A N/A N/A
Pending Payment(a specific transaction) /pep/{ID} N/A Retrieve pending payment data N/A Cancel a pending payment
Pending Payment (a specific transaction) /pep/{ID}?payload N/A Retrieve pending payment payload N/A N/A
Tokenisation /tkn Create token N/A N/A N/A
De tokenisation /dtk De tokenise a token N/A N/A N/A
Insert Routing /rou Insert routing N/A N/A N/A
Routing /rou/{PRJ}/{CTY}/{STO} N/A Get routing Delete routing Update routing
Charge /cha/{ID} N/A Retrieve charge data N/A N/A
Authorization /aut/{ID} N/A Retrieve authorization data N/A N/A
Insert payment device data /pdd Insert payment device data N/A N/A N/A
Payment device data /pdd/{PDI} N/A Get payment device data Delete payment device data Update payment device data
Insert project acquirer terminal ids /pti Insert project acquirer terminal ids N/A N/A N/A
Project acquirer terminal id /pti/{PRJ}/{STO} N/A Get project acquirer terminal ids Delete project acquirer terminal ids Update project acquirer terminal ids

Note 1: Implemented as a POST operation for security reasons. The URL can contain a PAN parameter, and although the connection is encrypted, there is a risk that the URL will get logged by server middle ware.

Note 2: Implemented as a POST operation for interoperability reasons. The URL contains the rather large PRS parameter, and although the HTTP protocol does not specify any upper limit for a URL, client and/or server middle ware may impose limitations.

Responses

As part of the standard HTTP protocol, Acoustic Payments will return an HTTP status code as part of the response. The “good” response is

HTTP/1.1 200 OK

200 OK
A 200 response means that the requested operation succeeded, i.e. a resource has been created, updated,retrieved, or deleted. However, this does not necessarily mean that the processing outcome was the desired one. For example, for an authorization transaction it does not by itself imply that the payment was approved. To determine this, clients need to examine the response body, which typically contains some representation of the resource being created or received. For the exact contents, see the section for the specific operation.

All other status codes indicate some kind of error:

HTTP/1.1 400 Bad Request

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

400 Bad request
There was a problem with the request data. Typically, this is caused by syntax errors, or missing or invalid values for data elements.

403 Forbidden
The client is not authorized to operate on the resource specified in the request.

404 Not found
The requested resource was not found.

500 Internal server error

503 Service unavailable

Both of these indicate a technical problem on the server side.

In all these cases, the response body will contain RCD and MSG elements (either in TRX.RES or ERR), that may provide more information about the error condition.


<ERR>
    <XID>AB12CD34EF56G</XID>
    <RCD>20001</RCD>
    <MSG>Syntax error in XML</MSG>
    <STM>2016-10-03T11:47:48.477007Z</STM>
    <ETM>2016-10-03T11:47:48.482554Z</ETM>
</ERR>
{"ERR": {
    "XID": "AB12CD34EF56G",
    "RCD": "20001",
    "MSG": "Syntax error in XML",
    "STM": "2016-10-03T11:47:48.477007Z",
    "ETM": "2016-10-03T11:47:48.482554Z"
}}

The structure of ERR element is described below.

Tag Description Datatype Value Size
ERR Error
XID Error id String Alphanumeric 13
XIE External id String Alphanumeric+ 1-40
RCD Return code Integer 0..99999
MSG Error message String UTF-8 1-80
STM Start time DateTime ISO 8601 UTC 27
ETM End time DateTime ISO 8601 UTC 27

External id (XIE) may not be present in the response.

Implementation notes

Adapting a client application to consume Acoustic Payments Web services should not be too difficult a task, once the initial obstacles have been overcome. Since the exchange between client and server use a well established transfer protocol (HTTP), and a well established message format (XML/JSON) there is really no dependency on specific platforms on either the client or the server side. And although various toolkits may be used to help in generating the application code, this is by no means a prerequisite. Please also understand, that Acoustic Payments will most likely not be able to help with questions regarding a specific toolkit or framework, even if these are Acoustic products. Such questions should be addressed to the provider of the software.

Based on experience, it’s worth keeping a couple of points in mind when integrating a client application with Acoustic Payments. While they are by no means profound, the effort of adhering to them will almost certainly turn out to be well spent.

Payment methods

Acoustic Payments support the following types of payment methods :

See also Payment method codes

Payment method type Description Native API support Checkout session support Wallet management session support
ACH/ELV A special form of Direct Debit utilizing a simplified mandate process, where payers can provide authorization to merchants on-the-fly, while they are online or on the phone.
Examples are the ACH (Automated Clearing House) in the US, and ELV/Bankeinzug in Germany.
Full Yes Yes
ATM card ATM cards have traditionally have been limited to use in ATM terminals and card present (point-of-sale) environments, where the transactions are secured with the personal identification number (PIN). But these cards are increasingly being enabled for use in “card not present” (phone, internet and recurring) payments. ATM card payments will result in an instant debit from the cardholders account (online transaction capture).
Examples are the Star, NYCE, PULSE and ACCEL ATM card networks in the US, as well as Bancontact/Mr.Cash in Belgium.
Full
See note 3.
Yes Yes
Card Credit and debit cards, including both the international credit and debit cards cards from VISA, MasterCard, American Express, JCB and Diners Club; as well as local card brands such as Dankort (DK), Discover (US), Elo (BR), Laser (IE) and many more. Full Yes Yes
Collect on delivery Collect on Delivery means that the payment for products and/or services is collected at the time and point of delivery.
Examples are payments collected by logistics providers such as UPS, DHL or national postal services.
Push payment.
Refund not supported.
See note 2.
Yes N/A
Convenience store Convenience store payments are conducted by customers walking into their local convenience store to pay for goods or services. This form of payment can be used both for utility bills and for online purchases. One typical examples are Konbini in Japan which can be performed in FamilyMart, Lawson, 7-Eleven and many other convenience store chains. Another example is the widespread use convenience store payments in OXXO and 7-Eleven stores in Mexico. Push payment.
Refund not supported.
See note 2.
Yes N/A
Direct debit A direct debit is an instruction that a merchant gives to his or her bank to collect an amount directly from the payers bank account.
The classic form of direct debit requires a four-party mandate to be established between the payer, the merchant, the payers bank and the merchants bank, authorizing the merchant to pull payments from the payers bank account. Direct debits are off-line transaction that does not include any validation of the payers bank account information or any “authorization” or that the payers account has sufficient funds to honour a payment.
Full Yes Yes
E-bank E-Bank payments are real-time confirmed direct credit transfers from the payers online bank account, that only can be performed while the payer is online and has access to his/her online bank account. E-Bank payments utilize a special facility inside the payers online banking system, which allows the merchant to present the “invoice” to the payer, enables the payer to push the payment to the merchant, and confirms completion of the payment back to the merchant; all in one smooth operation. E-Bank payments are final, when confirmed by the bank.
E-Bank payments comes in two main variants: E-Bank payments are real-time confirmed direct credit transfers from the payers online bank account, that only can be performed while the payer is online and has access to his/her online bank account. E-Bank payments utilize a special facility inside the payers online banking system, which allows the merchant to present the “invoice” to the payer, enables the payer to push the payment to the merchant, and confirms completion of the payment back to the merchant; all in one smooth operation. E-Bank payments are final, when confirmed by the bank.
E-Bank payments comes in two main variants:
Specific: where the payment facility utilized is for a specific bank. This is the most common case.
Multi: where a single payment facility enables payers to perform payment from multiple different online banks.
Examples are Sofortbanking (EU), GiroPay (DE),iDEAL (NL), BankAxess (NO).
Refund only Yes N/A
EFT Electronic Funds Transfer (aka “Offline Bank Transfer” or “Wire Transfer”) are push payments, where the payer initiates a bank transfer from his/her bank account to the merchants or billers bank account. The merchant cannot control the timing of EFT payments. This is entirely up to the payer.
EFT payments can be utilized both for pre-payment (where delivery is pending on receipt of payment) and as post-payment (of invoices).
EFT payments comes in two main variants:
General: where the merchant has a single collections account in a single bank (in each country), and payers must push the payment to the merchants bank from whatever payer bank. This is the most common case.
Specific: where the merchant has collections accounts in multiple different banks, and therefore can offer the payer a selection of banks, to help minimize transfer costs and time. This is standard in a number of countries such as: Mexico, Slovakia, Turkey, and more.
Refund not supported.
See note 2.
Yes N/A
Financing Financing means that the merchant enables the payer to defer and/or split the payment into a series of instalments. Financing comes in two main variants:
Merchant financing: where the merchant extends a line of credit to the payer and owns the collections risk.
Factoring services: where the merchant “sell the the obligation” to a factoring service provider, who takes over the collections risk. BillMeLater, Collector Bank, Klarna, RatePay are example factoring providers.
Conditional.
See note 1.
Yes On request
Private label card A private label card is is a closed loop card which can typically only be used with a single merchant or a group of merchants, e.g. a gift card. Full Yes Yes
Invoice Open Invoice is the traditional collection process, where the merchant sends an invoice, asking the customer to pay the purchase amount before a specified due date. Invoice payments exist in two main variants:
Merchant Invoices: where the invoices are being issued by the merchant and the merchant owns the collections risk.
Factoring services: where the merchant “sell the the obligation” to a factoring service provider, who takes over the collections risk. Collector Bank, Klarna, RatePay are example factoring providers.
Conditional.
See note 1.
Yes On request
Mobile money Mobile Money are payments performed from your mobile phone account. These payments are authorized and settled by the “carrier” (mobile phone operator).
Examples are: MPESA and Airtel.Money in Africa.
No Yes No
Portal A payment portal is an online facility which allow users to perform their payment without disclosing their payment details to the merchant.
Portals typically offer a wide range of payment options, and are designed to provide maximum choice and convenience for users.
Examples are: AliPay (CN), TenPay (CN), 99Bill (CN), WebPay (CL), ServiPag (CL), Yandex.Money (RU), Visa Qiwi (RU), WebMoney (RU), etc.
No Yes N/A
Wallet A digital wallet (also known as an e-wallet) allows users to make electronic commerce transactions quickly and securely. A digital wallets functions much like physical wallets. It is a store of value (cash, coupons, virtual currencies), payment instruments (bank accounts, cards, etc) and online shopping information such as billing and shipping addresses. The main purpose of the digital wallet is to facilitate convenient checkout for customers where they simply use the information stored in the wallet, in stead of filling out forms each time they shop.
Examples are: PayPal, PayU, etc.
Conditional
See note 1.
Yes N/A

Note 1: API support for Financing, Invoice and Wallet methods, depend on individual processors.

Note 2: Refund must be performed via another payment method.

Note 3: For ATM cards, the “Capture” transactions are processed as confirmations of the online transaction capture (instant debit).

Creating transactions

Every transaction processed is assigned a unique ID that is returned as part of the processing response. Transactions that operate on the same payment instrument can be “chained”. i.e. a transaction can refer back to a prior transaction. The effect of chaining is to copy certain elements are from the reference transaction to the current transaction. The main purpose of chaining is to allow merchants to avoid storing sensitive payment information like card or bank account numbers, but other information can be copied forward (enriched) in the same manner. For example, item information may be available in the merchant’s order system that is used for authorizing payment, but may not be available in the accounts receivable system that is used to actually capture the funds. The diagram below illustrates the concept.

foobar

A typical example of a chain could be as follows :

  1. From a web shop, a “CardAuthorize” transaction is used to authorize payment for an order. The merchant does not store the card information but only stores the transaction ID (token) returned with the response. The transaction ID is returned in the XID element in the CardAuthorize response.

  2. When the order is shipped, a “Capture” transaction is used to capture the payment. The Capture request does not contain the card information, but instead contains a reference to the “CardAuthorize” transaction. This causes the card information from the authorization to be used for the funds capture. The reference to the CardAuthorize transaction is made by providing the transaction ID from the CardAuthorize response in the XRF element in the Capture request.

  3. In the case of a complaint, a “Refund” transaction can be used to credit the customer by referencing the “Capture” transaction.

Note that several transactions may refer to the same transaction, for example several (partial) refunds may refer to a single capture. This way, transactions can be viewed as forming a tree structure:

foobar

While chaining allows a wide range of data elements to be enriched from other transactions, a similar mechanism allows payment data to be enriched from a wallet. This can be either from a specific instrument or from the wallet’s default instrument.

Enrichment from a specific instrument

foobar

Enrichment from default instrument

foobar

Hosted sessions

Hosted sessions come in two flavours.

Hosted payment sessions can be used to process a customer payment, for example when placing an order in a Web shop, or when paying bills online.

Hosted wallet management sessions can be used to let customers manage their payment information, for example letting recurring customers edit their online payment data in a Web shop.

Create hosted payment session

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com

      <TRX>
        <SVC>CheckoutStartSession</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <ORD>12345</ORD>
        <COM>Internet</COM>
        <CUR>USD</CUR>
        <NET>1000.00</NET>
        <TAX>100.00</TAX>
        <GRS>1100.00</GRS>
        <SES>
          <STY>https://example.com/styles</STY>
          <SUU>https://example.com/success</SUU>
          <FAU>https://example.com/failure</FAU>
          <CAU>https://example.com/cancel</CAU>
          <CVI>Required</CVI>
          <S3L>true</S3L>
          <ACT>Capture</ACT>
          <MPY>ACH</MPY>
          <MPY>MASTERCARD</MPY>
          <MPY>VISA</MPY>
        </SES>
      </TRX>

Sample response

      HTTP/1.1 200 OK

      <TRX>
        <XID>4WGBK0XWAP123</XID>
        <RES>
          <RCD>0</RCD>
          <MSG>Service succeeded</MSG>
          <STM>2010-10-04T15:16:30.070302Z</STM>
          <ETM>2010-10-04T15:16:30.070747Z</ETM>
        </RES>
        <SES>
          <SID>4WGBK0XWAP123</SID>
          <SEU>host.com/hpp/4WGBK0XWAP123</SEU>
          <LAN>en</LAN>
        </SES>
      </TRX>

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json

      {
        "TRX": {
          "SVC": "CheckoutStartSession",
          "PRJ": "EXAMPLE",
          "CTY": "US",
          "ORD": "12345",
          "COM": "Internet",
          "CUR": "USD",
          "NET": "1000.00",
          "TAX": "100.00",
          "GRS": "1100.00",
          "SES": {
            "STY": "https://example.com/styles",
            "SUU": "https://example.com/success",
            "FAU": "https://example.com/failure",
            "CAU": "https://example.com/cancel",
            "CVI": "Required",
            "S3L": "true",
            "ACT": "Capture",
            "MPY": ["ACH","MASTERCARD","VISA"]
          }
        }
      }

Sample response

      HTTP/1.1 200 OK

      {
        "TRX": {
          "XID": "4WGBK0XWAP123",
          "RES": {
            "RCD": "0",
            "MSG": "Service succeeded",
            "STM": "2010-10-04T15:16:30.070302Z",
            "ETM": "2010-10-04T15:16:30.070747Z"
          },
          "SES": {
            "SID": "4WGBK0XWAP123",
            "SEU": "host.com/hpp/4WGBK0XWAP123",
            "LAN": "en"
          }
        }
      }

Hosted payment sessions are created indirectly through a CheckoutStartSession transaction. The transaction contains all the information needed to process the payment, except for any payment instrument (card or bank account) data. It also contains the merchant’s return URL that is invoked at the end of the session.

Separate URLs can be supplied for successful, failed, and cancelled sessions. A session URL is returned, that the merchant application can use as the source of an in-line frame on the page. The language used, as well as the look and feel, can be controlled by the merchant.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CheckoutStartSession”
PRJ
Mandatory
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Mandatory
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
UNS
Optional
Is Unscheduled?
Valid values: ‘true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must not be present, or set to false.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must not be present, or set to false.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
COM
Mandatory
Consent medium
Valid values: 'Internet’, 'Phone’
The medium used to obtain the customer’s consent for this transaction.
ORD
Conditional
Order number
Alphanumeric+, 1-20
Either ORD or INV must be supplied if ACT is 'Capture’ or 'VoiceCapture’
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
Either ORD or INV must be supplied if ACT is 'Capture’ or 'VoiceCapture’
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL09
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match
Valid values: 'true’, 'false’. Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’. Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
MDT
Optional
Maturity date
yyyy-mm-dd
MCM
Optional
Merchant country must match
Valid values: 'true’, 'false’. Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
EAM
Optional
Is estimated amount
Valid values: 'true’, 'false’. Default: 'false’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
PAC
Optional
Partial authorization capability
Valid values: 'true’, 'false’. Default: 'false’
Flag which indicates if the merchant supports partial authorisation
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown

If no value is specified, then all card types will be allowed.
FCA
Optional
Fraud check in authorize
Valid values: 'true’, 'false’. Default: 'false’
When 'true’ fraud check is done in authorization and standard risk management is disabled
FCA is allowed in the input only when SES.ACT is 'Authorize’
HIA
Optional
High amount
Max 18 integer digits and 3 fractional digits, >=0
NSH
Optional
No shipment
Valid values: 'true’, 'false’
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
EVT
Optional
Event
Complex
MNU
Mandatory
Merchant notification URL
URI, RFC 2732, 1-2047
URL where the merchant wishes to receive the notifications.
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship-To object
ITM
Optional
Item
Complex, see Item object
SES
Mandatory
Session
Complex, see Session object
CAR
Optional
Car Rental
Complex, see Car Rental object

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
USR User
UTF8, 1-255
SES Hosted payment session
Complex
SID Session id
Alphanumeric, 13
SEU Session URL
URI, RFC 2732, 1-2047
SDU JavaScript SDK (service data kit) URL
URI, RFC 2732, 1-2047
This is an URL which is usually embedded into merchant web page for “express wallet” integrations. URL provides a javascript which will render express wallet payment buttons on merchant page and to process payments via Acoustic Payments.
LAN Language/locale
RFC 3066,2-5
PPU Process payment URL
URI, RFC 2732, 1-2047
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
LLM Long error message
UTF8, 1-100

Creating hosted wallet management sessions

Sample request

POST /trx HTTP/1.1
Host: ips.payments.goacoustic.com

    <TRX>
      <SVC>ProfileStartSession</SVC>
      <PRG>EXAMPLEGROUP</PRG>
      <PRF>Wallet1</PRF>
      <SES>
        <SUU>https://example.com/success</SUU>
        <FAU>https://example.com/failure</FAU>
      </SES>
    </TRX>

Sample xml response

    HTTP/1.1 200 OK

    <TRX>
      <XID>WBJ61AVC5B123</XID>
      <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T15:19:22.207038Z</STM>
        <ETM>2010-10-04T15:19:22.210091Z</ETM>
      </RES>
      <SES>
        <SID>WBJ61AVC5B123</SID>
        <SEU>host.com/hpp/WBJ61AVC5B123</SEU>
        <LAN>en</LAN>
      </SES>
    </TRX>


Sample json request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
      "TRX" : {
        "SVC" : "ProfileStartSession",
        "PRG" : "EXAMPLEGROUP",
        "PRF" : "Wallet1",
        "SES" : {
          "SUU" : "https://example.com/success",
          "FAU" : "https://example.com/failure"
        }
      }
    }

Sample json response

    HTTP/1.1 200 OK

    {
      "TRX" : {
        "XID" : "WBJ61AVC5B123",
        "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T15:19:22.207038Z",
          "ETM" : "2010-10-04T15:19:22.210091Z"
        },
        "SES" : {
          "SID" : "WBJ61AVC5B123",
          "SEU" : "host.com/hpp/WBJ61AVC5B123",
          "LAN" : "en"
        }
      }
    }


Currently, hosted wallet management sessions are created indirectly through a ProfileStartSession transaction. A session URL is returned, that the merchant application can use as the source of an inline frame on the page. The language used, as well as the look and feel, can be controlled by the merchant.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“ProfileStartSession”
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
If STO is present then PRJ is mandatory.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Mandatory
Country
ISO 3166-1 alpha-2
Only to be used when required for validation.
USR
Optional
User
UTF8, 1-255
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’. Default: 'false’
PRF
Mandatory
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Mandatory
Profile group
Alphanumeric, 1-20
PRG is optional in older versions of the API.
COM
Mandatory
Consent medium
Valid values: 'Internet’, 'Phone’
The medium used to obtain the customer’s consent for this transaction.
Only to be used when required for validation.
CUR
Mandatory
Currency
ISO 4217 alpha-3
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown

If no value is specified, then all card types will be allowed.
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
SES
Mandatory
Session
Complex
STY
Optional
Style sheet URL
URI, RFC 2732, 1-2047
SUU
Mandatory
Success notification URL
URI, RFC 2732, 1-2047
FAU
Mandatory
Failure notification URL
URI, RFC 2732, 1-2047
CAU
Optional
Cancel notification URL
URI, RFC 2732, 1-2047
LAN
Optional
Language/locale
RFC 3066,2-5
The default is 'en’.
CVI
Optional
CVC input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'OneClick’
ADI
Optional
Address input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'ZIPOptional’, 'ZIPRequired’
The element is used to indicate whether the address input fields will be displayed or not. 'ZIPOptional’ and 'ZIPRequired’ can be used to display the ZIP field only.
S3L
Optional
3-D Secure level
Values: 'false’, 'minimum’, 'firsttime’, 'true’, 'shift’, 'force’, 'forcefirsttime’, 'cond1’
Default: 'false’
See 3D Secure authentication level codes
ACT
Mandatory
Action
Values: 'AddCard’, 'AddBankAccount’, 'UpdateInstrument’, 'AutoPay’, 'AddExternalInstrument’,'AddPayPal’
MPY
Optional
Payment method
Alphanumeric, 1-10
Can occur multiple times.
CSM
Optional
CustomerSupportMode?
Values: 'true’, 'false’
MBV
Optional
MobileVersion?
Values: 'true’, 'false’
VOD
Optional
Version of doorman (HPP version)
Values: 'V2’, 'V21’, V22’
SIN
Optional
Single instrument wallet
Values: 'true’, 'false’
CUS
Optional
Customer
Complex, see Customer object

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
USR User
UTF8, 1-255
SES Hosted payment session
Complex
SID Session id
Alphanumeric, 13
SEU Session URL
URI, RFC 2732, 1-2047
LAN Language/locale
RFC 3066,2-5
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
LLM Long error message
UTF8, 1-100

Retrieving hosted payment sessions

Sample request

    GET /ses/WBJ61AVC5B123?view=status HTTP/1.1
    Host: ips.payments.goacoustic.com

Sample response

    HTTP/1.1 200 OK
    <SES>
        <SID>LCZA38PR5MUC1</SID>
        <SST>Completed</SST>
        <PRJ>EXAMPLE</PRJ>
        <STM>2016-05-18T07:28:30.111441Z</STM>
        <ETM>2016-05-18T07:28:50.441124Z</ETM>
           <SEU>https://host.com/LCZA38PR5MUC1</SEU>
           <STY>https://example.com/styles</STY>
           <SUU>https://example.com/success</SUU>
           <FAU>https://example.com/failure</FAU>
           <CAU>https://example.com/cancel</CAU>
        <RWU>https://example.com/review</RWU>
        <LAN>en</LAN>
        <CVI>Optional</CVI>
        <S3L>false</S3L>
        <ACT>Capture</ACT>
        <AVP>CSDUMMY</AVP>
        <MBV>false</MBV>
        <VAD>false</VAD>
        <MPY>ACH</MPY>
        <MPY>VISA</MPY>
        <MPY>MASTERCARD</MPY>
        <SPM>
            <SPI>AZ2ZR2Z4N5AW1</SPI>
            <MPY>VISA</MPY>
            <NET>10.00</NET>
            <TAX>0.00</TAX>
            <GRS>10.00</GRS>
            <CRD>
                <SCN>****1111</SCN>
                <EXP>0322</EXP>
            </CRD>
        </SPM>
        <TRX>
            <XID>DHV1GGG4WXUC1</XID>
            <CUR>USD</CUR>
            <NET>10.00</NET>
            <TAX>0.00</TAX>
            <GRS>10.00</GRS>
            <MPY>VISA</MPY>
            <CRD>
                <SCN>****1111</SCN>
                <EXP>0322</EXP>
                <CLV>1</CLV>
                <CBT>D</CBT>
                <TKI>25JCTW4ZL8UC5</TKI>
            </CRD>
            <RES>
                <RCD>0</RCD>
                <MSG>Service succeeded</MSG>
                <STM>2016-05-18T07:28:49.203810Z</STM>
                <ETM>2016-05-18T07:28:50.267316Z</ETM>
                <PRC>CSDUMMY</PRC>
                <TEL>999999999</TEL>
                <BRC>000</BRC>
                <CVR>M</CVR>
                <AVR>Y</AVR>
                <BRN>000</BRN>
                <CVN>M</CVN>
                <AVN>Y</AVN>
                <RMR>Neutral</RMR>
                <RMM>Risk Management message.</RMM>
                <FSC>0</FSC>
                <ACQ>Acquirer</ACQ>
            </RES>
            <AUT>
                <MID>AUTMID-DEM1234</MID>
                <AUC>530264</AUC>
            </AUT>
            <FOS>
                <SVC>Refund</SVC>
            </FOS>
        </TRX>
    </SES>

Sample response with credit card and gift card

    HTTP/1.1 200 OK

    <SES>
        <SID>C4YSNZC6MPUC1</SID>
        <SST>Created</SST>
        <PRJ>EXAMPLE</PRJ>
        <STM>2016-05-18T09:35:23.674533Z</STM>
        <TTM>2016-05-18T09:50:23.674533Z</TTM>
           <SEU>https://host.com/LCZA38PR5MUC1</SEU>
           <STY>https://example.com/styles</STY>
           <SUU>https://example.com/success</SUU>
           <FAU>https://example.com/failure</FAU>
           <CAU>https://example.com/cancel</CAU>
        <RWU>https://example.com/review</RWU>
        <LAN>en</LAN>
        <CVI>Optional</CVI>
        <S3L>false</S3L>
        <ACT>Capture</ACT>
        <AVP>CSDUMMY</AVP>
        <MBV>false</MBV>
        <VAD>false</VAD>
        <MPY>ACH</MPY>
        <MPY>VISA</MPY>
        <MPY>MASTERCARD</MPY>
        <MPY>DISCOVER</MPY>
        <MPY>GC-ACME</MPY>
        <SPM>
            <SPI>9KKZR2Z4N5AW1</SPI>
            <MPY>VISA</MPY>
            <NET>8900.00</NET>
            <TAX>0.00</TAX>
            <GRS>8900.00</GRS>
            <CRD>
                <SCN>****1111</SCN>
                <EXP>0218</EXP>
            </CRD>
        </SPM>
        <SPM>
            <SPI>NWKZR2Z4N5AW1</SPI>
            <MPY>GC-ACME</MPY>
            <NET>100.00</NET>
            <TAX>0.00</TAX>
            <GRS>100.00</GRS>
        </SPM>
        <TRX>
            <XID>C4YSNZC6MPUC1</XID>
            <CUR>USD</CUR>
            <NET>9000.00</NET>
            <TAX>0.00</TAX>
            <GRS>9000.00</GRS>
            <RES>
                <RCD>0</RCD>
                <MSG>Service succeeded</MSG>
                <STM>2016-05-18T09:35:23.674533Z</STM>
                <ETM>2016-05-18T09:35:23.687815Z</ETM>
            </RES>
            <FOS/>
        </TRX>
    </SES>

Sample request

    GET /ses/WBJ61AVC5B123?view=status HTTP/1.1
    Host: ips.payments.goacoustic.com
    Accept: application/json

Sample response

    HTTP/1.1 200 OK
    {  
      "SES" : {
        "SID" : "LCZA38PR5MUC1",
        "SST" : "Completed",
        "PRJ" : "EXAMPLE",
        "STM" : "2016-05-18T07:28:30.111441Z",
        "ETM" : "2016-05-18T07:28:50.441124Z",
        "SEU" : "https://host.com/LCZA38PR5MUC1",
        "STY" : "https://example.com/styles",
        "SUU" : "https://example.com/success",
        "FAU" : "https://example.com/failure",
        "CAU" : "https://example.com/cancel",
        "RWU" : "https://example.com/review",
        "LAN" : "en",
        "CVI" : "Optional",
        "S3L" : "false",
        "ACT" : "Capture",
        "AVP" : "CSDUMMY",
        "MBV" : false,
        "VAD" : false,
        "MPY" : ["ACH","VISA","MASTERCARD"],
        "SPM" : [{
          "SPI" : "AZ2ZR2Z4N5AW1",
          "MPY" : "VISA",
          "NET" : 10.00,
          "TAX" : 0.00,
          "GRS" : 10.00,
          "CRD" : {
            "SCN" : "****1111",
            "EXP" : "0322"
          }
        }],
        "TRX" : [{
          "XID" : "DHV1GGG4WXUC1",
          "CUR" : "USD",
          "NET" : 10.00,
          "TAX" : 0.00,
          "GRS" : 10.00,
          "MPY" : "VISA",
          "CRD" : {
            "SCN" : "****1111",
            "EXP" : "0322",
            "CLV" : "1",
            "CBT" : "D",
            "TKI" : "25JCTW4ZL8UC5"
          },
          "RES" : {
            "RCD" : 0,
            "MSG" : "Service succeeded",
            "STM" : "2016-05-18T07:28:49.203810Z",
            "ETM" : "2016-05-18T07:28:50.267316Z",
            "PRC" : "CSDUMMY",
            "TEL" : "999999999",
            "BRC" : "000",
            "CVR" : "M",
            "AVR" : "Y",
            "BRN" : "000",
            "CVN" : "M",
            "AVN" : "Y",
            "RMR" : "Neutral",
            "RMM" : "Risk Management message.",
            "FSC" : 0,
            "ACQ" : "Acquirer"
          },
          "AUT" : {
            "MID" : "AUTMID-DEM1234",
            "AUC" : "530264"
          },
          "FOS" : {
            "SVC" : ["Refund"]
          }
        }]
      }
    }


Sample response with credit card and gift card

    HTTP/1.1 200 OK
    {
      "SES" : {
        "SID" : "C4YSNZC6MPUC1",
        "SST" : "Created",
        "PRJ" : "EXAMPLE",
        "STM" : "2016-05-18T09:35:23.674533Z",
        "TTM" : "2016-05-18T09:50:23.674533Z",
        "SEU" : "https://host.com/LCZA38PR5MUC1",
        "STY" : "https://example.com/styles",
        "SUU" : "https://example.com/success",
        "FAU" : "https://example.com/failure",
        "CAU" : "https://example.com/cancel",
        "RWU" : "https://example.com/review",
        "LAN" : "en",
        "CVI" : "Optional",
        "S3L" : "false",
        "ACT" : "Capture",
        "AVP" : "CSDUMMY",
        "MBV" : false,
        "VAD" : false,
        "MPY" : ["ACH","VISA","MASTERCARD","DISCOVER","GC-ACME"],
        "SPM" : [
          {
            "SPI" : "9KKZR2Z4N5AW1",
            "MPY" : "VISA",
            "NET" : 8900.00,
            "TAX" : 0.00,
            "GRS" : 8900.00,
            "CRD" : {
              "SCN" : "****1111",
              "EXP" : "0218"
            }
          },
          {
            "SPI" : "NWKZR2Z4N5AW1",
            "MPY" : "GC-ACME",
            "NET" : 100.00,
            "TAX" : 0.00,
            "GRS" : 100.00
          }
        ],
        "TRX" : [{
          "XID" : "C4YSNZC6MPUC1",
          "CUR" : "USD",
          "NET" : 9000.00,
          "TAX" : 0.00,
          "GRS" : 9000.00,
          "RES" : {
            "RCD" : 0,
            "MSG" : "Service succeeded",
            "STM" : "2016-05-18T09:35:23.674533Z",
            "ETM" : "2016-05-18T09:35:23.687815Z"
          },
          "FOS" : null
        }]
      }
    }

Merchants may at any time inquire the status, and in particular the outcome, of a hosted payment session. This is usually done by the merchant’s Web application as a result of the session ending, and one of the specified notification URLs being invoked. But since network drops or other errors could prevent this from happening, merchants may also want to implement a batch job that at regular intervals inquires the status of all sessions that have not returned.

The session is retrieved by sending a GET request to the session URL:

GET /ses/{SID}?view=status

Response elements

The general structure and data elements of a retrieve session response are described below. Not all elements are relevant for all types of transactions.

SES Session
SID
Mandatory
Session id
Alphanumeric, 13
PRJ
Mandatory
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
SST
Mandatory
Session status
Values: 'Created’, 'Completed’, 'Expired’, 'Canceled’, 'RetryCountExceeded’, 'Declined’, 'Error’, 'MerchantNotActive’, 'Pending’, SoftDeclined’, 'HardDeclined’, 'UserInteractionDone’
STM
Optional
Start time
DateTime, ISO 8601 UTC, 27
ETM
Optional
End time
DateTime, ISO 8601 UTC, 27
TTM
Optional
Timeout time
DateTime, ISO 8601 UTC, 27
SEU
Mandatory
Session URL
URI, RFC 2732, 1-2047
STY
Optional
Style sheet URL
URI, RFC 2732, 1-2047
SUU
Mandatory
Success notification URL
URI, RFC 2732, 1-2047
FAU
Mandatory
Failure notification URL
URI, RFC 2732, 1-2047
CAU
Optional
Cancel notification URL
URI, RFC 2732, 1-2047
RWU
Optional
Review URL
URI, RFC 2732, 1-2047
LAN
Mandatory
Language/locale
RFC 3066,2-5
The default is 'en’.
CVI
Optional
CVC input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'OneClick’
ADI
Optional
Address input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'ZIPOptional’, 'ZIPRequired’
S3L
Optional
3-D Secure level
Values: 'false’, 'minimum’, 'firsttime’, 'true’, 'shift’, 'force’, 'forcefirsttime’, 'cond1’
Default: 'false’
See 3D Secure authentication level codes
ACT
Mandatory
Action
Values: 'Authorize’, 'Capture’, 'VerifyFullAmount’, 'VerifyLowAmount’, 'VoiceAuthorize’, 'VoiceCapture’, 'TempWallet’, 'AddCard’, 'AddBankAccount’, 'UpdateInstrument’ 'AutoPay’
ASA
Optional
Can assume approval?
Values: 'true’, 'false’
MPY
Optional
Payment method
Alphanumeric, 1-10
Can occur multiple times.
S3E
Optional
#D secure enabled payment method
Alphanumeric, 1-10
Can occur multiple times.
AVP
Optional
ACH verification processor
Alphanumeric, 1-10
VAD
Optional
Enable voice authorization?
Values: 'true’, 'false’
CSM
Optional
CustomerSupportMode?
Values: 'true’, 'false’
MBV
Optional
MobileVersion?
Values: 'true’, 'false’
TRX
Optional
Transaction
Complex
Can occur multiple times.
MPY
Mandatory
Payment method
Alphanumeric, 1-10
XID
Mandatory
Transaction identifier
Alphanumeric, 13
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CRD
Optional
Card
Complex
SCN
Mandatory
Scrambled card number
Alphanumeric, 8-19
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
CLV
Mandatory
Card level
Values: '1’, '2’, '3’
TKI
Optional
Token id
Alphanumeric, 1-100
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
BAC
Optional
Bank account
Complex
SAN
Mandatory
Scrambled bank account number
Alphanumeric, 1-30
RTN
Optional
Routing number
Alphanumeric, 1-20
ATP
Optional
Account type
Valid values: 'Checking’, 'MoneyMarket’, 'Savings’
RES
Mandatory
Result
Complex
RCD
Mandatory
Return code
Integer, Values: 0 to 99999, see Return Codes
MSG
Mandatory
Message
UTF8, 1-80
STM
Mandatory
Start time
DateTime, ISO 8601 UTC, 27
ETM
Mandatory
End time
DateTime, ISO 8601 UTC, 27
PRC
Optional
Processor
Alphanumeric, 1-20
TEL
Optional
Contact phone
UTF8, 1-30
BRC
Optional
Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR
Optional
CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s unique CVC response code.
AVR
Optional
AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s unique AVS response code.
ASA
Optional
Can assume approval?
Values: 'true’, 'false’
RMR
Optional
Risk management result
Alphanumeric, 1-10
RMM
Optional
Risk management message
Alphanumeric, 1-80
FSC
Optional
Fraud Score
Integer, Values: 0 to 99
RL0..9
Optional
Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM
Optional
DPL screening response message
Alphanumeric, 1-2000
ACQ
Optional
Acquirer
UTF8, 1-100
LLM
Optional
Long error message
UTF8, 1-100
EMV
Optional
EMV response data
UTF8, 1-999
ATR
Optional
Acquirer transaction reference
UTF8, 1-100
CVN
Optional
Native CVC response code
Alphanumeric, 1-10
AVN
Optional
Native AVS response code
Alphanumeric, 1-10
BRN
Optional
Native bank response code
Alphanumeric, 1-10
AUT
Optional
Authorization
Complex
MID
Optional
Merchant ID
Alphanumeric+, 1-40
AUC
Optional
Authorization code
Alphanumeric, 1-6
Approval code provided by external payment processor.
FOS
Optional
Follow on services
Complex
SVC
Optional
Service
Alphanumeric, 1-20
Can occur multiple times.
SPM
Optional
Selected payment method
Complex
Can occur multiple times.
SPI
Mandatory
Selected payment method id
Alphanumeric, 1-13
MPY
Mandatory
Payment method
Alphanumeric, 1-10
DSA
Optional
Additional description
Alphanumeric, 1-50
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
INS
Optional
Number of installments
SDA
Optional
Surcharge/discount amount
Max 18 integer digits and 3 fractional digits, >=0
CRD
Optional
Card
Complex
SCN
Mandatory
Scrambled card number
Alphanumeric, 8-19
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
BAC
Optional
Bank account
Complex
SAN
Mandatory
Scrambled bank account number
Alphanumeric, 1-30
SHT
Optional
Ship To
Complex, See Ship-To object
CUS
Optional
Customer
Complex, See Customer object

Customer


    <CUS>
        <CID>1648463</CID>
        <CTP>Private</CTP>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
    </CUS>
    {
      "CUS" : {
        "CID" : "1648463",
        "CTP" : "Private",
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066"
      }
    }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
FNM
Optional
First name
UTF8, 1-100
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
LNM
Optional
Last name
UTF8, 1-100
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
CNM
Optional
Company name
UTF8, 1-100
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
FUN
Optional
Full name
UTF8, 1-100
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
AD1
Optional
Address line 1
UTF8, 1-50
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
ZIP
Optional
Zip code
UTF8, 1-20
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
STA
Optional
State
ISO 3166-2 alpha 3
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
CTY
Optional
Country
ISO 3166-1 alpha-2
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
TEL
Optional
Telephone
UTF8, 1-30
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.
EMA
Optional
Email
UTF8, 5-254
May be required depending on the payment method and processor. Please contact Acoustic Payments for more information.

Ship To

    <SHT>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
        <EMA>johnsmith@example.net</EMA>
    </SHT>
    {
      "SHT" : {
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "johnsmith@example.net"
      }
    }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
FUN
Optional
Full name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

    <ITM>
        <ITN>91926493</ITN>
        <QTY>1</QTY>
        <UPR>14136.30</UPR>
        <NET>14136.30</NET>
        <TAX>0.00</TAX>
        <GRS>14136.30</GRS>
        <TXC>GOODS</TXC>
    </ITM>
    {
      "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 14136.30,
        "NET" : 14136.30,
        "TAX" : 0.00,
        "GRS" : 14136.30,
        "TXC" : "GOODS"
      }
    }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for p-card transactions. Also used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”
TXP
Conditional
Tax percentage
Max 2 integer digits and 2 fractional digits
Typically used when VAT percentage is required.

Billing Plan

    <BIP>
        <INS>3</INS>
        <GRS>1000.00</GRS>
        <INP>Issuer05</INP>
        <INF>1.12345</INF>
    </BIP>
    {
      "BIP" : {
        "INS" : "3",
        "GRS" : 1000.00,
        "INP" : "Issuer05",
        "INF" : "1.12345"
      }
    }
BIP Billing plan
MPY
Mandatory
Payment method
Alphanumeric, 1-10
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
ISS
Optional
Issuer
Alphanumeric, 1-20
CTY
Optional
Issuer country
ISO 3166-1 alpha-2
LOA
Optional
Low amount
Max 18 integer digits and 3 fractional digits, >=0
HIA
Optional
High amount
Max 18 integer digits and 3 fractional digits, >=0
INS
Mandatory
Number of instalments
Integer, Value: 1..999
INP
Conditional
Instalment provider
Values: 'Acquirer’,'Issuer’
Tag might be required for some processors.
INF
Conditional
Interest factor
Max 1 integer digits and 5 fractional digits, >0
Tag might be required for some processors.

Car Rental

Car rental data will only be enriched from the referenced transaction if no car rental data are supplied in the input

     <CAR>
        <RAN>978555785</RAN>
        <RNA>John Smith</RNA>
        <RBD>2016-09-20</RBD>
        <RBT>1834</RBT>
        <RBC>BROOMFIELD</RBC>
        <RBS>CO</RBS>
        <RBY>US</RBY>
        <RRD>2016-10-01</RRD>
        <RRT>1800</RRT>
        <RRC>BROOMFIELD</RRC>
        <RRS>CO</RRS>
        <RRY>US</RRY>
        <RRL>5820</RRL>
        <RDU>10</RDU>
        <TAE>false</TAE>
        <CSN>8008015860</CSN>
        <RCL>CCAR</RCL>
        <RDR>44.00</RDR>
        <MIT>1</MIT>
        <MFM>0</MFM>
        <RNS>false</RNS>
        <AHN>John Smith</AHN>
    </CAR>
    {
      "CAR" : {
        "RAN" : "978555785",
        "RNA" : "John Smith",
        "RBD" : "2016-09-20",
        "RBT" : "1834",
        "RBC" : "BROOMFIELD",
        "RBS" : "CO",
        "RBY" : "US",
        "RRD" : "2016-10-01",
        "RRT" : "1800",
        "RRC" : "BROOMFIELD",
        "RRS" : "CO",
        "RRY" : "US",
        "RRL" : "5820",
        "RDU" : 10,
        "TAE" : false,
        "CSN" : "8008015860",
        "RCL" : "CCAR",
        "RDR" : 44.00,
        "MIT" : 1,
        "MFM" : 0,
        "RNS" : false,
        "AHN" : "John Smith"
      }
    }
CAR Car rental
RAN
Mandatory
Rental agreement number
Alphanumeric, 1-25
RNA
Mandatory
Renter name
UTF8, 1-100
RBD
Mandatory
Rental begin date
date, yyyy-mm-dd
RBT
Mandatory
Rental begin time
Numeric, 1-4, hhmm format
RBC
Optional
Rental begin city
UTF8, 1-50
RBS
Optional
Rental begin state
ISO 3166-2 alpha 3
RBY
Optional
Rental begin country
ISO 3166-1 alpha-2
RRD
Mandatory
Rental return date
date, yyyy-mm-dd
RRT
Optional
Rental return time
Numeric, 1-4, hhmm format
RRC
Optional
Rental return city
UTF8, 1-50
RRS
Optional
Rental return state
ISO 3166-2 alpha 3
RRY
Optional
Rental return country
ISO 3166-1 alpha-2
RRL
Optional
Rental return location Id
Alphanumeric, 1-10
RDU
Mandatory
Rental duration
Integer, Value: 0..999
TAE
Optional
Tax exempt indicator
Values: 'true’, 'false’
CSN
Optional
Customer service 800-number
UTF8, 1-10
RCL
Optional
Rental class id
Alphanumeric, 1-4
RDR
Optional
Rental daily rate
Max 18 integer digits and 3 fractional digits, >=0
MIR
Optional
Mile rate
Max 18 integer digits and 3 fractional digits, >=0
MIT
Optional
Miles total
Integer, Value: 0..9999
MFM
Optional
Maximum free miles
Integer, Value: 0..9999
ICH
Optional
Insurance charges
Max 18 integer digits and 3 fractional digits, >=0
AAI
Conditional
Adjusted amount indicator
Values: 'DropOffCharges’, 'DeliveryCharges’, 'ParkingExpenses’, 'ExtraHours’, 'Violations’, 'Gas’, 'ExtraMileage’, 'LateReturn’, 'OneWayService’, 'ParkingViolation’, 'Multiple’
AAI vaues are card brand specific.
For MASTERCARD and Amex, valid values are: 'DropOffCharges’, 'DeliveryCharges’, 'ParkingExpenses’, 'ExtraHours’, 'Violations’, 'Multiple’.
For VISA, valid values are: 'Gas’, 'ExtraMileage’, 'LateReturn’, 'OneWayService’, 'ParkingViolation’.
Can occur multiple times.
For all other card brands AAI is not allowed.
Mandatory for Mastercard and Amex, if AAM is present, for CardAuthCap and CardVoiceAuthCap services.
AAM
Conditional
Adjusted amount
Max 18 integer digits and 3 fractional digits, >=0
Mandatory for Mastercard and Amex, if AAI is present, for SES.ACT values: 'Capture’ and 'VoiceCapture’.
RPC
Optional
Rental program code
Alphanumeric, 1-2
RNS
Optional
Rental no show indicator
Values: 'true’, 'false’
AHN
Optional
Account holder name
UTF8, 1-100
CMN
Optional
Card member notified
Values: 'true’, 'false’
CAR.CMN is allowed only for Amex and if CAR.AAM is present.

Session


    <SES>
        <STY>https://www.example.com/payment.css</STY>
        <SUU>https://www.example.com/sucess</SUU>
        <FAU>https://www.example.com/failure</FAU>
        <ACT>Authorize</ACT>
        <LAN>en-US</LAN>
        <CSM>false</CSM>
        <VOD>V21</VOD>
        <MPY>AMEX</MPY>
        <MPY>MASTERCARD</MPY>
        <MPY>VISA</MPY>
    </SES> 


    {
      "SES" : {
        "STY" : "https://www.example.com/payment.css",
        "SUU" : "https://www.example.com/sucess",
        "FAU" : "https://www.example.com/failure",
        "ACT" : "Authorize",
        "LAN" : "en-US",
        "CSM" : false,
        "VOD" : "V21",
        "MPY" : [
          "AMEX",
          "MASTERCARD",
          "VISA"
        ]
      }
    }
SES Hosted payment session
STY
Optional
Style sheet URL
URI, RFC 2732, 1-2047
SUU
Mandatory
Success notification URL
URI, RFC 2732, 1-2047
FAU
Mandatory
Failure notification URL
URI, RFC 2732, 1-2047
CAU
Optional
Cancel notification URL
URI, RFC 2732, 1-2047
RWU
Optional
Review URL
URI, RFC 2732, 1-2047
LAN
Optional
Language/locale
RFC 3066,2-5
The default is 'en’.
CVI
Optional
CVC input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'OneClick’
ADI
Optional
Address input
Values: 'NoDisplay’, 'Optional’, 'Required’, 'ZIPOptional’, 'ZIPRequired’
The element is used to indicate whether the address input fields will be displayed or not. 'ZIPOptional’ and 'ZIPRequired’ can be used to display the ZIP field only.
S3L
Optional
3-D Secure level
Values: 'false’, 'minimum’, 'firsttime’, 'true’, 'shift’, 'force’, 'forcefirsttime’, 'cond1’
Default: 'false’
See 3D Secure authentication level codes
ACT
Mandatory
Action
Values: 'Authorize’, 'Capture’, 'VerifyFullAmount’, 'VerifyLowAmount’, 'VoiceAuthorize’, 'VoiceCapture’, 'TempWallet’
ASA
Optional
Can assume approval?
Values: 'true’, 'false’
MPY
Optional
Payment method
Alphanumeric, 1-10
Can occur multiple times.
VAD
Optional
Enable voice authorization?
Values: 'true’, 'false’. Default: 'true’
CSM
Optional
CustomerSupportMode?
Values: 'true’, 'false’
MBV
Optional
MobileVersion?
Values: 'true’, 'false’
SDR
Optional
Summary display rule
Values: 'true’, 'false’. Default: 'true’
SDC
Optional
Surcharge/discount code
Alphanumeric, 1-10
VOD
Optional
Version of doorman(HPP version)
Values: 'V2’, 'V21’, V22’
TCA
Optional
Two cards allowed in order
Values: 'true’, 'false’
SHI
Optional
Shipping information requested
Values: 'true’, 'false’
BIL
Optional
Billing information requested
Values: 'true’, 'false’
BIP
Optional
Billing plan
Complex, see Billing Plan object
Can occur multiple times.

Card payment transactions

Verification

Request

POST /trx HTTP/1.1

<TRX>
    <SVC>CardVerify</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <CRD>
        <PAN>4000000000000002</PAN>
        <EXP>1218</EXP>
    </CRD>
    <VER>
        <CVC>123</CVC>
    </VER>
</TRX>
POST /trx HTTP/1.1
Content-Type: application/json

{ "TRX" : {
      "SVC" : "CardVerify",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "CRD" : {
          "PAN" : "4000000000000002",
          "EXP" : "1218"
      },
      "VER" : {
          "CVC" : "123"
      }
} }

Response

HTTP/1.1 200 OK

<TRX>
    <XID>5CPZAD6ZA5123</XID>
    <MPY>VISA</MPY>
    <CRD>
        <SCN>****0002</SCN>
        <EXP>1218</EXP>
        <CLV>1</CLV>
        <CBT>C</CBT>
    </CRD>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T11:49:02.567412Z</STM>
        <ETM>2010-10-04T11:49:04.551584Z</ETM>
        <PRC>EXBANK</PRC>
        <TEL>999999999</TEL>
        <BRC>000</BRC>
        <CVR>M</CVR>
        <AVR>NOP</AVR>
    </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "5CPZAD6ZA5123",
      "MPY" : "VISA",
      "CRD" : {
          "CLV" : "1",
          "EXP" : "1218",
          "SCN" : "****0002",
          "CBT" : "C"
      },
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T11:49:02.567412Z",
          "ETM" : "2010-10-04T11:49:04.551584Z",
          "PRC" : "EXBANK",
          "TEL" : "999999999",
          "BRC" : "000",
          "CVR" : "M",
          "AVR" : "NOP"
      }
} }

A CardVerify transaction is used to verify the validity of a customer’s card information in situations where the merchant does not want to impact the cardholder’s open-to-buy limit. For example, the exact amount may not be known at this time, or payment may not be due until a future date. A CardVerify transaction actually authorizes a low amount, approximately the equivalent of 5 USD in the specified currency. An approval obtained in this context will never be settled, and the hold on the cardholder’s account will expire according to the rules of the particular card scheme.

It is possible to specify an amount, but this will only be used for least cost routing. It has no effect on the amount being authorized.

Request elements

TRX Transaction
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
SVC
Mandatory
Service, transaction type
Value: CardVerify
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF and PRG are not provided.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF and PRG are not provided.
STO
Optional
Store code
Alphanumeric, 1-20
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRG
Optional
Profile group
Alphanumeric, 1-20
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
CRD
Optional
Card
Complex, see Card data
ATM
Optional
ATM routing?
Valid values: true, false. Default: false.
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to true and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to false the card will always be processed via the credit network even though it may support ATM processing.
VER
Optional
Verification
Complex, see Verification data
S3D
Optional
3D secure
Complex, see 3-D Secure data
CUR
Conditional
Currency
ISO 4217 alpha-3
Mandatory if PRG is not provided.
NET
Optional
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Optional
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Optional
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
COM
Mandatory
Consent medium
Valid values: Internet, Phone, Terminal.
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
UNS
Optional
Is Unscheduled?
Valid values: true, false. Default: false.
The element is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must either not be present, or must be set to false.
REC
Optional
Is Recurring?
Valid values: true, false. Default: false.
The element is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must either not be present, or must be set to false.
ENR
Optional
Is Enrollment?
Valid values: true, false. Default: false.
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
MCF
Optional
Is card on file at merchant side?
Valid values: true, false. Default: false.
The element indicates the use of a card which is kept on file with the merchant. If MCF=true then PRF and IRF must not be present.
IPI
Optional
Industry Practice Indicator
Valid Values: ‘DelayedCharge’, 'NoShow’, 'Reauthorization’, 'Resubmission’
CVM
Optional
CVC must match?
Valid values: true, false. Default: true.
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: true, false. Default: false.
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is true, transactions will fail, if the customer country does not match the country of the payment instrument.
MCM
Optional
Merchant country must match?
Valid values: true, false. Default: false.
Flag indicating that the country where the credit card is issued must match the merchant country.
CBT
Optional
Card type
Valid Values: C = credit, D = debit, P = pre-paid, U = unknown
AVC
Optional
Address verification check
Valid values: Force, Minimum, MinimumZip
See usage in AVS response codes
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: IVR, Webshop, SMS, MobileApp,SAP
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
USR
Optional
User
UTF8, 1-255
CUS
Optional
Customer
Complex, see Customer data
DAM
Optional
DPL screening approved by merchant
Valid values: true, false. Default: false.
SHT
Optional
Ship-to
Complex, see Ship-to data
SHM
Optional
Shipping method
Valid values: Express, Fast, Ground, Internet
ITM
Optional
Item
Complex, see Item data
RMP
Optional
Risk Management Profile
Alphanumeric+, 1-30
Merchant’s unique Risk Manager Profile. Acoustic Payments will perform automated real time Risk Management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk Manager service and setup of Risk Manager Profiles.
CAR
Optional
Car rental
Complex, see Car rental data
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: 1, 2, 3
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
TID External token id provided by acquirer
Alphanumeric+, 1-40
MER Merchant
Complex
MID **Merchant ID
Merchant ID with acquirer
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s CVC response code
AVR AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s AVS response code
ASA Can assume approval?
Values: true, false
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
FSC Fraud Score
Integer, Values: 0 to 99
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug-in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
NXI Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network.
RMS Risk management data
Complex, see Risk Management

Credit check

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  <TRX>
    <SVC>CardCreditCheck</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CRD>
      <PAN>4000000000000002</PAN>
      <EXP>1218</EXP>
      </CRD>
    <VER>
      <CVC>123</CVC>
    </VER>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>1H55SGXPK2123</XID>
    <MPY>VISA</MPY>
    <CRD>
      <CLV>1</CLV>
      <EXP>1218</EXP>
      <SCN>****0002</SCN>
      <CBT>C</CBT>
    </CRD><RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-10-04T12:00:36.016267Z</STM>
      <ETM>2010-10-04T12:00:37.041200Z</ETM>
      <PRC>EXBANK</PRC>
      <TEL>999999999</TEL>
      <BRC>000</BRC>
      <CVR>M</CVR>
      <AVR>NOP</AVR>
    </RES>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardCreditCheck",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CRD" : {
        "PAN" : "4000000000000002",
        "EXP" : "1218"
      },
      "VER" : {
        "CVC" : "123"
      }
    }
  }
Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "1H55SGXPK2123",
      "MPY" : "VISA",
      "CRD" : {
        "CLV" : "1",
        "EXP" : "1218",
        "SCN" : "****0002",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-10-04T12:00:36.016267Z",
        "ETM" : "2010-10-04T12:00:37.041200Z",
        "PRC" : "EXBANK",
        "TEL" : "999999999",
        "BRC" : "000",
        "CVR" : "M",
        "AVR" : "NOP"
      }
    }
  }

A CardCreditCheck transaction is used to verify that an amount can be honored at a later point in time without impacting the cardholder’s open-to-buy limit. Merchants may use this in situations where the amount is not yet due, but is sufficiently high that it may not be possible to pay it using certain types of card. A CardCreditCheck transaction actually authorizes the amount, and then immediately cancels the authorization.

Note: Some card issuers may not support cancellations, so there is a potential risk that funds will be reserved after all. Merchants should be aware of this fact, as it may lead to customer complaints.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardCreditCheck”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’, 'Terminal’
Mandatory if XRF is not specified.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match
Valid values: 'true’, 'false’, Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
ATM
Optional
ATM routing?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to ”true” and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to ”false” the card will always be processed via the credit network even though it may support ATM processing.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship to
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
CRD
Conditional
Card
Complex, see Card object
Required if neither profile data nor XRF are specified.
VER
Optional
Verification
Complex, see Verification object
S3D
Optional
3D secure
Complex, see 3D secure object
CAR
Optional
Car rental
Complex, see Car rental object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
FSC Fraud Score
Integer, Values: 0 to 99
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
NXI Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network.
RMS
Optional
Risk management section
Complex, see Risk Management Section

Authorization

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardAuthorize</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CRD>
      <PAN>4000000000000002</PAN>
      <EXP>1218</EXP>
    </CRD>
    <VER>
      <CVC>123</CVC>
    </VER>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>H7MGB5JMX1123</XID>
    <MPY>VISA</MPY>
    <CRD>
      <CLV>1</CLV>
      <EXP>1218</EXP>
      <SCN>****0002</SCN>
      <CBT>C</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-10-04T12:02:39.222085Z</STM>
      <ETM>2010-10-04T12:02:40.243214Z</ETM>
      <PRC>EXBANK</PRC>
      <TEL>999999999</TEL>
      <BRC>000</BRC>
      <CVR>M</CVR>
      <AVR>NOP</AVR>
    </RES>
    <AUT>
      <MID>12345678</MID>
      <AUC>123456</AUC>
    </AUT>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardAuthorize",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CRD" : {
        "PAN" : "4000000000000002",
        "EXP" : "1218"
      },
      "VER" : {
        "CVC" : "123"
      }
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "H7MGB5JMX1123",
      "MPY" : "VISA",
      "CRD" : {
        "CLV" : "1",
        "EXP" : "1218",
        "SCN" : "****0002",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-10-04T12:02:39.222085Z",
        "ETM" : "2010-10-04T12:02:40.243214Z",
        "PRC" : "EXBANK",
        "TEL" : "999999999",
        "BRC" : "000",
        "CVR" : "M",
        "AVR" : "NOP"
      },
      "AUT" : {
        "MID" : "12345678",
        "AUC" : "123456"
      }
    }
  }

A CardAuthorize transaction is used to authorize a credit or debit card payment. If approved by the card issuer, the requested amount is reserved on the cardholder’s account, but is not actually transferred to the merchant. The hold on the funds will expire within a certain time frame depending on the card scheme. Within this time frame, merchants can initiate a funds transfer by submitting a subsequent Capture or Collect transaction with reference to the CardAuthorize transaction.

Because a CardAuthorize transaction decreases the cardholder’s open-to-buy limit, merchants should not use this type of transaction before the actual amount is known, or unless payment is due in the immediate future (typically within one week). In fact, some card schemes may charge a fee for not complying with these guidelines.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardAuthorize”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’, 'Terminal’
Mandatory if XRF is not specified.
UNS
Optional
Is Unscheduled?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must not be present, or set to false.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must not be present, or set to false.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
MCF
Optional
Is card on file at merchant side?
Valid values: 'true’, 'false’, Default: 'false’
The element indicates the use of a card which is kept on file with the merchant. If MCF=true then PRF and IRF must not be present.
IPI
Optional
Industry Practice Indicator
Valid Values: 'DelayedCharge’, 'NoShow’, 'Reauthorization’, 'Resubmission’
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match?
Valid values: 'true’, 'false’, Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
ATM
Optional
ATM routing?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to 'true’ and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to 'false’ the card will always be processed via the credit network even though it may support ATM processing.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
EAM
Optional
Is estimated amount
Valid values: 'true’, 'false’, Default: 'false’
PAC
Optional
Partial authorization capability
Valid values: 'true’, 'false’, Default: 'false’
Flag which indicates if the merchant supports partial authorisation.
Support for partial authorisation is limited. Not all processors support this. Please contact your Acoustic Payments account representative for details.
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
EMV
Optional
Non sensitive EMV data
UTF8, 1-999
This tag should not contain the EMV tags 5A, 57 and 5F24.
EMV tag 5A should be send in TRX.CRD.PAN.
EMV tag 57 should be send in TRX.CRD.TR2.
EMV tag 5F24 should be send in TRX.CRD.EXP
FCA
Optional
Fraud check in authorize
Valid values: 'true’, 'false’, Default: 'false’
When 'true’ fraud check is done in authorization and standard risk management is disabled
CAM
Optional
Cash amount
Max 18 integer digits and 3 fractional digits, >=0
This field contains the amount handed out as cash.
PMO
Optional
Payment mode
Valid values: 'Offline’, 'OfflineLong’, 'OfflineFloorLimit’
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
AVC
Optional
Address verification check
Valid values: 'Force’, 'Minimum’, 'MinimumZip’
See usage in AVS response codes
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
CRD
Conditional
Card
Complex, see Card object
Required if neither profile data nor XRF are specified.
VER
Optional
Verification
Complex, see Verification object
S3D
Optional
3D secure
Complex, see 3D secure object
CAR
Optional
Car rental
Complex, see Car rental object
BIP
Optional
Billing plan
Complex, see Billing plan object
TER
Optional
Terminal data
Complex, see Terminal data object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
TID External token id provided by acquirer
Alphanumeric+, 1-40
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
FSC Fraud Score
Integer, Values: 0 to 99
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
EMV EMV response data
UTF8, 1-999
NXI Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network.
RMS
Optional
Risk management section
Complex, see Risk Management Section
AUT Authorization
Complex
MID Merchant ID
Alphanumeric+, 1-40
AUC Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
TEI Terminal ID
Alphanumeric, 1-8
Terminal ID used for authorization
NTW Network
Alphanumeric, 1-3
Network used for authorization

Void

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardVoid</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <XRF>H7MGB5JMX1123</XRF>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>XDL2HC6XMG123</XID>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-02-26T07:14:51.770588Z</STM>
      <ETM>2010-02-26T07:14:52.778964Z</ETM>
      <BRC>400</BRC>
    </RES>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardVoid",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "XRF" : "H7MGB5JMX1123"
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "XDL2HC6XMG123",
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-02-26T07:14:51.770588Z",
        "ETM" : "2010-02-26T07:14:52.778964Z",
        "BRC" : "400"
      }
    }
  }

A CardVoid transaction is used to cancel an authorization obtained through a CardAuthorize transaction.

Amounts are optional and only required for partial reversals. Limited support. Not all processors and issuers support authorization reversal. If the authorization could not be cancelled, a return code (RCD) of 10002 will be returned.Please contact your Acoustic Payments account representative for details.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardVoid”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Optional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Optional
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
NET
Optional
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Optional
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Optional
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
RER
Optional
Reversal reason
Values: “Technical”, “Manual”
Manual reversal: Reversal performed by the customer, where the customer reverses the payment just performed at the terminal.
Technical reversal: Reversal performed by the terminal when waiting for a response from Acoustic Payments, times out.
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
RTD
Optional
Retransmission data
UTF8, 1-255
Data from original request that must be reused in re-transmission of request
VER
Optional
Verification
Complex, see Verification object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
LLM Long error message
UTF8, 1-100
EMV EMV response data
UTF8, 1-999

Authorization and capture

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardAuthCap</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CRD>
      <PAN>4000000000000002</PAN>
      <EXP>1218</EXP>
    </CRD>
    <VER>
      <CVC>123</CVC>
    </VER>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>2N0P4AMJR8123</XID>
    <MPY>VISA</MPY>
    <CRD>
      <CLV>1</CLV>
      <EXP>1218</EXP>
      <SCN>****0002</SCN>
      <CBT>C</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-10-04T12:25:20.709020Z</STM>
      <ETM>2010-10-04T12:25:21.788608Z</ETM>
      <PRC>EXBANK</PRC>
      <TEL>999999999</TEL>
      <BRC>000</BRC>
      <CVR>M</CVR>
      <AVR>NOP</AVR>
    </RES>
    <AUT>
      <MID>12345678</MID>
      <AUC>123456</AUC>
    </AUT>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardAuthCap",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CRD" : {
        "PAN" : "4000000000000002",
        "EXP" : "1218"
      },
      "VER" : {
        "CVC" : "123"
      }
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "2N0P4AMJR8123",
      "MPY" : "VISA",
      "CRD" : {
        "CLV" : "1",
        "EXP" : "1218",
        "SCN" : "****0002",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-10-04T12:25:20.709020Z",
        "ETM" : "2010-10-04T12:25:21.788608Z",
        "PRC" : "EXBANK",
        "TEL" : "999999999",
        "BRC" : "000",
        "CVR" : "M",
        "AVR" : "NOP"
      },
      "AUT" : {
        "MID" : "12345678",
        "AUC" : "123456"
      }
    }
  }

A CardAuthCap transaction is used to combine a CardAuthorize and a Capture transaction into a single step.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardAuthCap”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’, 'Terminal’
Mandatory if XRF is not specified.
UNS
Optional
Is Unscheduled?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must not be present, or set to false.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must not be present, or set to false.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
MCF
Optional
Is card on file at merchant side?
Valid values: 'true’, 'false’, Default: 'false’
The element indicates the use of a card which is kept on file with the merchant. If MCF=true then PRF and IRF must not be present.
IPI
Optional
Industry Practice Indicator
Valid Values: 'DelayedCharge’, 'NoShow’, 'Reauthorization’, 'Resubmission’
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+,1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match?
Valid values: 'true’, 'false’, Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
ATM
Optional
ATM routing?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to 'true’ and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to 'false’ the card will always be processed via the credit network even though it may support ATM processing.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
PAC
Optional
Partial authorization capability
Valid values: 'true’, 'false’, Default: 'false’
Flag which indicates if the merchant supports partial authorisation.
Support for partial authorisation is limited. Not all processors support this. Please contact your Acoustic Payments account representative for details.
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
CAM
Optional
Cash amount
Max 18 integer digits and 3 fractional digits, >=0
This field contains the amount handed out as cash.
PMO
Optional
Payment mode
Valid values: 'Offline’, 'OfflineLong’, 'OfflineFloorLimit’
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
AVC
Optional
Address verification check
Valid values: 'Force’, 'Minimum’, 'MinimumZip’
See usage in AVS response codes
RTD
Optional
Retransmission data
UTF8, 1-255
Data from original request that must be reused in re-transmission of request
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
CRD
Conditional
Card
Complex, see Card object
Required if neither profile data nor XRF are specified.
VER
Optional
Verification
Complex, see Verification object
S3D
Optional
3D secure
Complex, see 3D secure object
CAR
Optional
Car rental
Complex, see Car rental object
BIP
Optional
Billing plan
Complex, see Billing plan object
TER
Optional
Terminal data
Complex, see Terminal data object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
FSC Fraud Score
Integer, Values: 0 to 99
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
EMV EMV response data
UTF8, 1-999
NXI Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network.
RMS
Optional
Risk management section
Complex, see Risk Management Section
AUT Authorization
Complex
MID Merchant ID
Alphanumeric+, 1-40
AUC Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
TEI Terminal ID
Alphanumeric, 1-8
Terminal ID used for authorization
NTW Network
Alphanumeric, 1-3
Network used for authorization

Voice authorization

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardVoiceAuthorize</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <AUC>123456</AUC>
    <CRD>
      <PAN>4000000000000002</PAN>
      <EXP>1218</EXP>
    </CRD>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>KVLY3FRJ5F123</XID>
    <MPY>VISA</MPY>
    <CRD>
      <SCN>****0002</SCN>
      <EXP>1218</EXP>
      <CLV>1</CLV>
      <CBT>C</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-10-04T12:28:46.896422Z</STM>
      <ETM>2010-10-04T12:28:46.896864Z</ETM>
    </RES>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardVoiceAuthorize",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "AUC" : "123456",
      "CRD" : {
        "PAN" : "4000000000000002",
        "EXP" : "1218"
      }
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "KVLY3FRJ5F123",
      "MPY" : "VISA",
      "CRD" : {
        "SCN" : "****0002",
        "EXP" : "1218",
        "CLV" : "1",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-10-04T12:28:46.896422Z",
        "ETM" : "2010-10-04T12:28:46.896864Z"
      }
    }
  }

A CardVoiceAuthorize transaction is used to record an already existing authorization, obtained outside of Acoustic Payments. For example the merchant may have called the acquirer’s authorization centre after receiving a referral response, or may have used a card swipe device directly connected to the acquirer.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardVoiceAuthorize”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’, 'Terminal’
Mandatory if XRF is not specified.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for scheduled billing.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
MCF
Optional
Is card on file at merchant side?
Valid values: 'true’, 'false’, Default: 'false’
The element indicates the use of a card which is kept on file with the merchant. If MCF=true then PRF and IRF must not be present.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match?
Valid values: 'true’, 'false’, Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
AUC
Mandatory
Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
ATM
Optional
ATM routing?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to 'true’ and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to 'false’ the card will always be processed via the credit network even though it may support ATM processing.
ATM routing is only allowed if you have a special agreement with Acoustic Payments.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
EMV
Optional
Non sensitive EMV data
UTF8, 1-999
This tag should not contain the EMV tags 5A, 57 and 5F24.
EMV tag 5A should be send in TRX.CRD.PAN.
EMV tag 57 should be send in TRX.CRD.TR2.
EMV tag 5F24 should be send in TRX.CRD.EXP
PMO
Optional
Payment mode
Valid values: 'Offline’, 'OfflineLong’, 'OfflineFloorLimit’
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
CRD
Conditional
Card
Complex, see Card object
Required if neither profile data nor XRF are specified.
VER
Optional
Verification
Complex, see Verification object
S3D
Optional
3D secure
Complex, see 3D secure object
CAR
Optional
Car rental
Complex, see Car rental object
BIP
Optional
Billing plan
Complex, see Billing plan object
TER
Optional
Terminal data
Complex, see Terminal data object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
LLM Long error message
UTF8, 1-100

Voice authorization and capture

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardVoiceAuthCap</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <AUC>123456</AUC>
    <CRD>
      <PAN>4000000000000002</PAN>
      <EXP>1210</EXP>
    </CRD>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>JM4XXMDQV0123</XID>
    <MPY>VISA</MPY>
    <CRD>
      <SCN>****0002</SCN>
      <EXP>1210</EXP>
      <CLV>1</CLV>
      <CBT>C</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2010-10-04T12:30:28.917692Z</STM>
      <ETM>2010-10-04T12:30:28.918100Z</ETM>
    </RES>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardVoiceAuthCap",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "AUC" : "123456",
      "CRD" : {
        "PAN" : "4000000000000002",
        "EXP" : "1210"
      }
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "JM4XXMDQV0123",
      "MPY" : "VISA",
      "CRD" : {
        "SCN" : "****0002",
        "EXP" : "1210",
        "CLV" : "1",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2010-10-04T12:30:28.917692Z",
        "ETM" : "2010-10-04T12:30:28.918100Z"
      }
    }
  }

A CardVoiceAuthCap transaction is used to combine a CardVoiceAuthorize and a Capture transaction into a single step.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardVoiceAuthCap”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’, 'Terminal’
Mandatory if XRF is not specified.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate whether credit card is/will be used as card on file for scheduled billing.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
MCF
Optional
Is card on file at merchant side?
Valid values: 'true’, 'false’, Default: 'false’
The element indicates the use of a card which is kept on file with the merchant. If MCF=true then PRF and IRF must not be present.
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+, 1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CVM
Optional
CVC must match?
Valid values: 'true’, 'false’, Default: 'true’
Card verification code policy. Successful card authorizations will be declined, if the CVC code does not match, when this flag is set to true.
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
AUC
Mandatory
Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
ATM
Optional
ATM routing?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if merchant supports processing of cards via the ATM network. If ATM is set to 'true’ and card can be processed as ATM, Acoustic Payments will send request to the merchant’s processor for ATM transactions. If the ATM is set to 'false’ the card will always be processed via the credit network even though it may support ATM processing.
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
CBT
Optional
Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
PMO
Optional
Payment mode
Valid values: 'Offline’, 'OfflineLong’, 'OfflineFloorLimit’
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
RTD
Optional
Retransmission data
UTF8, 1-255
Data from original request that must be reused in re-transmission of request
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
CRD
Conditional
Card
Complex, see Card object
Required if neither profile data nor XRF are specified.
VER
Optional
Verification
Complex, see Verification object
S3D
Optional
3D secure
Complex, see 3D secure object
CAR
Optional
Car rental
Complex, see Car rental object
BIP
Optional
Billing plan
Complex, see Billing plan object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
LLM Long error message
UTF8, 1-100

Incremental authorization

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardAuthInc</SVC>
    <PRJ>EXAMPLE</PRJ>
    <XRF>746CLMQ3YCTC1</XRF>
    <CTY>US</CTY>
    <ORD>150706</ORD>
    <INV>150706</INV>
    <NET>100</NET>
    <TAX>0</TAX>
    <GRS>100</GRS>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>746YQT0B8HTC1</XID>
    <MPY>VISA</MPY>
    <CRD>
      <SCN>****2149</SCN>
      <EXP>1218</EXP>
      <CLV>1</CLV>
      <CBT>C</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2015-09-04T10:55:28.206048Z</STM>
      <ETM>2015-09-04T10:55:30.628714Z</ETM>
      <PRC>RAPID</PRC>
      <TEL>999999999</TEL>
      <BRC>000</BRC>
    </RES>
    <AUT>
      <MID>10001-RCTST0000006106</MID>
      <AUC>OK0299</AUC>
    </AUT>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardAuthInc",
      "PRJ" : "EXAMPLE",
      "XRF" : "746CLMQ3YCTC1",
      "CTY" : "US",
      "ORD" : "150706",
      "INV" : "150706",
      "NET" : 100,
      "TAX" : 0,
      "GRS" : 100
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "746YQT0B8HTC1",
      "MPY" : "VISA",
      "CRD" : {
        "SCN" : "****2149",
        "EXP" : "1218",
        "CLV" : "1",
        "CBT" : "C"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2015-09-04T10:55:28.206048Z",
        "ETM" : "2015-09-04T10:55:30.628714Z",
        "PRC" : "RAPID",
        "TEL" : "999999999",
        "BRC" : "000"
      },
      "AUT" : {
        "MID" : "10001-RCTST0000006106",
        "AUC" : "OK0299"
      }
    }
  }

An incremental authorization is used to charge an additional amount to a customer’s card that their initial authorization would not have covered. This is used in Lodging and Auto rental industries, where the customer extends the stay or car rental period, so that the original authorised amount does not cover the actual final amount.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardAuthInc”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
The XRF should be first authorisation transaction (This could also be a voice authorisation) that was approved. Any subsequent transaction following an incremental authorisation should also refer to the first authorisation transaction that was approved.
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Optional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Optional
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
VER
Optional
Verification
Complex, see Verification object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
CVR CVC response code
Alphanumeric, 1-3, see CVC response codes
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3, see AVS response codes
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
FSC Fraud Score
Integer, Values: 0 to 99
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
AUT Authorization
Complex
MID Merchant ID
Alphanumeric+, 1-40
AUC Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
TEI Terminal ID
Alphanumeric, 1-8
Terminal ID used for authorization
NTW Network
Alphanumeric, 1-3
Network used for authorization

Incremental voice authorization

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com

  <TRX>
    <SVC>CardVoiceAuthInc</SVC>
    <XRF>746Z4Y4X3QTC5</XRF>
    <ORD>Order Number123</ORD>
    <INV>Invoice number123</INV>
    <TL0>TestTL</TL0>
    <TL1>TestTL</TL1>
    <TL2>Client002</TL2>
    <NET>10.25</NET>
    <TAX>0.00</TAX>
    <GRS>10.25</GRS>
    <AUC>OK1432</AUC>
    <OSY>TESTOSY</OSY>
    <VER>
      <CL4>0034</CL4>
    </VER>
  </TRX>

Sample response

  HTTP/1.1 200 OK

  <TRX>
    <XID>74675S0SVKTC5</XID>
    <MPY>MASTERCARD</MPY>
    <CRD>
      <SCN>****0034</SCN>
      <EXP>1218</EXP>
      <CLV>1</CLV>
      <CBT>D</CBT>
    </CRD>
    <RES>
      <RCD>0</RCD>
      <MSG>Service succeeded</MSG>
      <STM>2015-09-01T19:28:17.837429Z</STM>
      <ETM>2015-09-01T19:28:17.842265Z</ETM>
    </RES>
  </TRX>

Sample request

  POST /trx HTTP/1.1
  Host: ips.payments.goacoustic.com
  Content-Type: application/json

  {
    "TRX" : {
      "SVC" : "CardVoiceAuthInc",
      "XRF" : "746Z4Y4X3QTC5",
      "ORD" : "Order Number123",
      "INV" : "Invoice number123",
      "TL0" : "TestTL",
      "TL1" : "TestTL",
      "TL2" : "Client002",
      "NET" : 10.25,
      "TAX" : 0.00,
      "GRS" : 10.25,
      "AUC" : "OK1432",
      "OSY" : "TESTOSY",
      "VER" : {
        "CL4" : "0034"
      }
    }
  }

Sample response

  HTTP/1.1 200 OK

  {
    "TRX" : {
      "XID" : "74675S0SVKTC5",
      "MPY" : "MASTERCARD",
      "CRD" : {
        "SCN" : "****0034",
        "EXP" : "1218",
        "CLV" : "1",
        "CBT" : "D"
      },
      "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2015-09-01T19:28:17.837429Z",
        "ETM" : "2015-09-01T19:28:17.842265Z"
      }
    }
  }

A CardVoiceAuthInc transaction is used to record an already existing incremental authorization, obtained outside of Acoustic Payments.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“CardVoiceAuthInc”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
The XRF should be first authorisation transaction (This could also be a voice authorisation) that was approved. Any subsequent transaction following an incremental authorisation should also refer to the first authorisation transaction that was approved.
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Optional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Optional
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
AUC
Mandatory
Authorization code
Alphanumeric, 1-20
Approval code provided by external payment processor.
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
VER
Optional
Verification
Complex, see Verification object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
LLM Long error message
UTF8, 1-100

Customer


  <CUS>
    <CID>1648463</CID>
    <CTP>Private</CTP>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
  </CUS>
  {
    "CUS" : {
      "CID" : "1648463",
      "CTP" : "Private",
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066"
    }
  }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Ship To

  <SHT>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
    <EMA>johnsmith@example.net</EMA>
  </SHT>
  {
    "SHT" : {
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066",
      "EMA" : "johnsmith@example.net"
    }
  }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

  <ITM>
    <ITN>91926493</ITN>
    <QTY>1</QTY>
    <UPR>14136.30</UPR>
    <NET>14136.30</NET>
    <TAX>0.00</TAX>
    <GRS>14136.30</GRS>
    <TXC>GOODS</TXC>
  </ITM>
  {
    "ITM" : {
      "ITN" : "91926493",
      "QTY" : 1,
      "UPR" : 14136.30,
      "NET" : 14136.30,
      "TAX" : 0.00,
      "GRS" : 14136.30,
      "TXC" : "GOODS"
    }
  }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for p-card transactions. Also used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”

Card

  <CRD>
    <PAN>4111111111111111</PAN>
    <EXP>0718</EXP>
    <AHN>John Smith</AHN>
  </CRD>
  {
    "CRD" : {
      "PAN" : "4111111111111111",
      "EXP" : "0718",
      "AHN" : "John Smith"
    }
  }
CRD Card
PAN
Conditional
Card number
Numeric, 8-19
Either PAN or TKI is required.If both are present PAN will have precedence.
In case on EMV transactions the card number should be extracted from EMV tag 5A and sent in CRD.PAN. In case of card swiped transactions the card number should be extracted from track data and sent in CRD.PAN.
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
In case on EMV transactions the expiry date should be extracted from EMV tag 5F24 and sent in CRD.EXP. In case of card swiped transactions the expiry date should be extracted from track data and sent in CRD.EXP.
AHN
Optional
Account holder name
UTF8, 1-100
TR1
Optional
Track 1 data
UTF8, 1-79
Allowed only in CardAuthorize and CardVoiceAuthorize services.
TR2
Optional
Track 2 data
UTF8, 1-40
Allowed only in CardAuthorize and CardVoiceAuthorize services.
In case on EMV transactions the track 2 data should be extracted from EMV tag 57 and sent in CRD.TR2.
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Either PAN or TKI is required.If both are present PAN will have precedence.
NXI
Optional
Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network, used to identify and link all related transactions for authorization and settlement.

Verification

  <VER>
    <CVC>123</CVC>
    <CL4>0718</CL4>
  </VER>
  {
    "VER" : {
      "CVC" : "123",
      "CL4" : "0718"
    }
  }
VER Verification
CVC
Optional
Card verification code
Numeric, 3-4
Allowed only in CardVerify,CardCreditCheck,CardAuthorize and CardAuthCap services.
CL4
Optional
Card number last 4 digits
Numeric, 4
KSN
Optional
Key serial number
Alphanumeric, 1-20
Key serial number used to create the base PIN encryption key for DUKPT.
Allowed in the interface for processing via terminal for CardAuthorize, CardVoiceAuthorize, CardAuthCap and CardVoiceAuthCap services.
PIN
Optional
Pin
Alphanumeric, 1-16
Allowed in the interface for processing via terminal for CardAuthorize, CardVoiceAuthorize, CardAuthCap and CardVoiceAuthCap services.
KID
Optional
Key ID
Alphanumeric+, 1-40
Key Id used for identifying the key information needed for PIN translation.
Allowed in the interface for processing via terminal for CardAuthorize and CardAuthCap services.
IKG
Optional
Input key group
Alphanumeric+, 1-20
Key group or PIN translation.
Allowed in the interface for processing via terminal for CardAuthorize, CardAuthCap, CardVoiceAuthCap and CardVoiceAuthorize services.

3-D Secure

  <S3D>
    <S3I>0LVY5D2PSXPC10000000</S3I>
    <S3R>1</S3R>
    <ECI>05</ECI>
    <AAV>AAABBgkSkQEjRWeGgUESAAAAAAA=</AAV>
    <S3N>0</S3N>
  </S3D>
  {
    "S3D" : {
      "S3I" : "0LVY5D2PSXPC10000000",
      "S3R" : "1",
      "ECI" : "05",
      "AAV" : "AAABBgkSkQEjRWeGgUESAAAAAAA=",
      "S3N" : "0"
    }
  }
S3D 3D secure
S3I
Optional
3D Secure XID
UTF8, 20
S3R
Optional
3D Secure status
Integer, Value:0..9
S3N
Optional
3D Secure native status
Alphanumeric, 1-10
ECI
Optional
E-commerce indicator
Numeric, 2
AAV
Optional
Accountholder authentication value
Base 64, 1-28
S3V
Optional
3-D Secure enrollment status
Values:
'N’ = Not enrolled
'Y’ = Enrolled
'U’ = Unable to enroll
S3A
Optional
3-D Secure authentication status
Values:
'N’ = Authentication failed
'Y’ = Authentication approved
'A’ = Authentication attempted
'U’ = Unable to authenticate
PRS
Conditional
Payer authentication response
Base 64, 1-5000
Mandatory if the processor is ECENTRIC

Billing plan

  <BIP>
    <INS>3</INS>
    <GRS>1000.00</GRS>
    <INP>Issuer05</INP>
    <INF>1.12345</INF>
  </BIP>
  {
    "BIP" : {
      "INS" : "3",
      "GRS" : 1000.00,
      "INP" : "Issuer05",
      "INF" : "1.12345"
    }
  }
BIP Billing plan
INS
Mandatory
Number of instalments
Integer, Value:0..999
GRS
Conditional
Gross amount per instalment
Max 18 integer digits and 3 fractional digits, >=0
Tag might be required for some processors.
INP
Conditional
Instalment provider
Values: 'Acquirer’,'Issuer’
Tag might be required for some processors.
INF
Conditional
Interest factor
Max 1 integer digits and 5 fractional digits, >0
Tag might be required for some processors.

Terminal data

  <TER>
    <TSN>284239987</TSN>
    <DTY>Mx915P</DTY>
    <TEM>EMVChip</TEM>
    <PEC>WithPin</PEC>
    <TEI>8839625</TEI>
    <CNO>8</CNO>
    <LNE>0</LNE>
    <SNO>ECARS</SNO>
    <TEC>KeyEntry;MagneticStripe;EMVChip</TEC>
  </TER>
  {
    "TER" : {
      "TSN" : "284239987",
      "DTY" : "Mx915P",
      "TEM" : "EMVChip",
      "PEC" : "WithPin",
      "TEI" : "8839625",
      "CNO" : "8",
      "LNE" : "0",
      "SNO" : "ECARS",
      "TEC" : "KeyEntry;MagneticStripe;EMVChip"
    }
  }
TER Terminal data
TSN
Mandatory
Terminal serial number
UTF8, 1-50
DTY
Mandatory
Terminal device type
UTF8, 1-30
TEM
Mandatory
Terminal entry mode
Values: 'KeyEntry’, 'MagneticStripe’, 'EMVChip’, 'EMVContactless’, 'KeyEntryCNP’, 'MSRContactless’, 'EMVFallbackToMSR’
TEC
Optional
Terminal entry capability
Values: 'KeyEntry’, 'MagneticStripe’, 'EMVChip’, 'EMVContactless’
If there are multiple values they should be delimited by ; eg: 'KeyEntry;MagneticStripe;EMVChip;EMVContactless’
PEC
Optional
Pin entry capability
Values: 'NoPin’, 'WithPin’
TEI
Mandatory
Terminal Id
Alphanumeric, 1-8
CNO
Optional
Cashier number
Alphanumeric+, 1-10
SNO
Optional
Store number
Alphanumeric+, 1-10
LNE
Optional
Lane
Alphanumeric+, 1-10
MCV
Optional
Method of cardholder verification
Values: 'OfflinePIN’, 'OnlinePIN’, 'NoVerification’, 'ManualVerification’
ECV
Optional
Entity of cardholder verification
Values: 'EMVChip’, 'UnattendedDevice’, 'Attendant’, 'NoVerification’, 'Issuer’
SCI
Optional
Strong customer indicator
Values: 'Initial’, 'FollowUp’

Car rental data

Car rental data will only be enriched from the referenced transaction if no car rental data are supplied in the input

  <CAR>
    <RAN>978555785</RAN>
    <RNA>John Smith</RNA>
    <RBD>2016-09-20</RBD>
    <RBT>1834</RBT>
    <RBC>BROOMFIELD</RBC>
    <RBS>CO</RBS>
    <RBY>US</RBY>
    <RRD>2016-10-01</RRD>
    <RRT>1800</RRT>
    <RRC>BROOMFIELD</RRC>
    <RRS>CO</RRS>
    <RRY>US</RRY>
    <RRL>5820</RRL>
    <RDU>10</RDU>
    <TAE>false</TAE>
    <CSN>8008015860</CSN>
    <RCL>CCAR</RCL>
    <RDR>44.00</RDR>
    <MIT>1</MIT>
    <MFM>0</MFM>
    <RNS>false</RNS>
    <AHN>John Smith</AHN>
  </CAR>
  {
    "CAR" : {
      "RAN" : "978555785",
      "RNA" : "John Smith",
      "RBD" : "2016-09-20",
      "RBT" : "1834",
      "RBC" : "BROOMFIELD",
      "RBS" : "CO",
      "RBY" : "US",
      "RRD" : "2016-10-01",
      "RRT" : "1800",
      "RRC" : "BROOMFIELD",
      "RRS" : "CO",
      "RRY" : "US",
      "RRL" : "5820",
      "RDU" : 10,
      "TAE" : false,
      "CSN" : "8008015860",
      "RCL" : "CCAR",
      "RDR" : 44.00,
      "MIT" : 1,
      "MFM" : 0,
      "RNS" : false,
      "AHN" : "John Smith"
    }
  }
CAR Car rental
RAN
Mandatory
Rental agreement number
Alphanumeric, 1-25
RNA
Mandatory
Renter name
UTF8, 1-100
RBD
Mandatory
Rental begin date
date, yyyy-mm-dd
RBT
Mandatory
Rental begin time
Numeric, 1-4, hhmm format
RBC
Optional
Rental begin city
UTF8, 1-50
RBS
Optional
Rental begin state
ISO 3166-2 alpha 3
RBY
Optional
Rental begin country
ISO 3166-1 alpha-2
RRD
Mandatory
Rental return date
date, yyyy-mm-dd
RRT
Optional
Rental return time
Numeric, 1-4, hhmm format
RRC
Optional
Rental return city
UTF8, 1-50
RRS
Optional
Rental return state
ISO 3166-2 alpha 3
RRY
Optional
Rental return country
ISO 3166-1 alpha-2
RRL
Optional
Rental return location Id
Alphanumeric, 1-10
RDU
Mandatory
Rental duration
Integer, Value: 0..999
TAE
Optional
Tax exempt indicator
Values: 'true’, 'false’
CSN
Optional
Customer service 800-number
UTF8, 1-10
RCL
Optional
Rental class id
Alphanumeric, 1-4
RDR
Optional
Rental daily rate
Max 18 integer digits and 3 fractional digits, >=0
MIR
Optional
Mile rate
Max 18 integer digits and 3 fractional digits, >=0
MIT
Optional
Miles total
Integer, Value: 0..9999
MFM
Optional
Maximum free miles
Integer, Value: 0..9999
ICH
Optional
Insurance charges
Max 18 integer digits and 3 fractional digits, >=0
AAI
Conditional
Adjusted amount indicator
Values: 'DropOffCharges’, 'DeliveryCharges’, 'ParkingExpenses’, 'ExtraHours’, 'Violations’, 'Gas’, 'ExtraMileage’, 'LateReturn’, 'OneWayService’, 'ParkingViolation’, 'Multiple’
AAI vaues are card brand specific.
For MASTERCARD and Amex, valid values are: 'DropOffCharges’, 'DeliveryCharges’, 'ParkingExpenses’, 'ExtraHours’, 'Violations’, 'Multiple’.
For VISA, valid values are: 'Gas’, 'ExtraMileage’, 'LateReturn’, 'OneWayService’, 'ParkingViolation’.
Can occur multiple times.
For all other card brands AAI is not allowed.
Mandatory for Mastercard and Amex, if AAM is present, for CardAuthCap and CardVoiceAuthCap services.
AAM
Conditional
Adjusted amount
Max 18 integer digits and 3 fractional digits, >=0
Mandatory for Mastercard and Amex, if AAI is present, for CardAuthCap and CardVoiceAuthCap services.
RPC
Optional
Rental program code
Alphanumeric, 1-2
RNS
Optional
Rental no show indicator
Values: 'true’, 'false’
AHN
Optional
Account holder name
UTF8, 1-100
CMN
Optional
Card member notified
Values: 'true’, 'false’
CAR.CMN is allowed only for Amex and if CAR.AAM is present.

DCC

DCC elements passed in the request will be not echoed back on response.

  <DCC>
    <BCC>HKD</BCC>
    <BAM>325.52</BAM>
    <RVF>2019-12-04T14:06:07.000000Z</RVF>
    <RVT>2019-12-05T03:56:00.000000Z</RVT>
    <CCR>9.30051</CCR>
    <MUP>3.5</MUP>
    <SRN>Elavon Merchant Services</SRN>
    <DRN>19120414067283</DRN>
  </DCC>
  {
    "DCC" : {
      "BCC" : "HKD",
      "BAM" : 325.52,
      "RVF" : "2019-12-04T14:06:07.000000Z",
      "RVT" : "2019-12-05T03:56:00.000000Z",
      "CCR" : 9.30051,
      "MUP" : 3.5,
      "SRN" : "Elavon Merchant Services",
      "DRN" : "19120414067283"
    }
  }
DCC Dynamic Currency Conversion
BAM
Mandatory
Billing Amount
Max 21 integer digits and 3 fractional digits, >=0
BCC
Mandatory
Billing Currency Code
ISO 4217 alpha-3
CCR
Mandatory
Currency Conversion Rate
Max 16 integer digits and 8 fractional digits, >=0
DRN
Mandatory
DCC Reference Number
UTF8, 1-14
MUP
Optional
Mark Up Percentage
Max 5 integer digits and 3 fractional digits, >=0
RVF
Optional
Rate Valid From timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
RVT
Mandatory
Rate Valid To timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
SRN
Optional
Source Name
UTF8, 1-100

3-D Secure

Verifying enrollment

Sample request

    POST /s3d/enrollment HTTP/1.1
    Host: ips.payments.goacoustic.com


    <S3D>
         <PRJ>EXAMPLE</PRJ>
         <CTY>US</CTY>
         <CUR>USD</CUR>
         <GRS>100.00</GRS>
         <CRD>
              <PAN>4111111111111111</PAN>
              <EXP>1219</EXP>
         </CRD>
    </S3D>

Sample response

    HTTP/1.1 200 OK

    <S3D>
      <S3I>PTTDBK679ZPC10000000</S3I>
      <S3R>5</S3R>
      <S3N>0</S3N>
      <ACU>https://example.net/acs</ACU>
      <S3V>Y</S3V>
      <PRQ>SXQgd2FzIHRoZSBiZXN0...cnN0IG9mIHRpbWVzLi4u</PRQ>
    </S3D>

Sample request

    POST /s3d/enrollment HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
      "S3D" : {
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "GRS" : 100.00,
        "CRD" : {
          "PAN" : "4111111111111111",
          "EXP" : "1219"
        }
      }
    }

Sample response

    HTTP/1.1 200 OK

    {
      "S3D" : {
        "S3I" : "PTTDBK679ZPC10000000",
        "S3R" : "5",
        "S3N" : "0",
        "ACU" : "https://example.net/acs",
        "S3V" : "Y",
        "PRQ" : "SXQgd2FzIHRoZSBiZXN0...cnN0IG9mIHRpbWVzLi4u"
      }
    }

A merchants can verify whether a particular card is enrolled in 3-D Secure authentication by sending a POST request to the generic 3-D Secure enrollment URL:

POST /s3d/enrollment

If the card is enrolled, a URL for the appropriate ACS is returned, together with a PAReq that the merchant must forward in order to launch the cardholder authentication session, typically inside an inline frame.

The request elements can be specified in keyword value pair format as well as xml and json format.

Request elements for keyword value pair format

Element Description
PRJ
Mandatory
Project code
Alphanumeric, 1-10
CTY
Mandatory
Country
ISO 3166-1 alpha-2
STO
Optional
Store code
Alphanumeric, 1-20
PRF
Conditional
Wallet reference
Alphanumeric+ (no blanks), 1-40
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI), must be specified.
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Conditional
Instrument reference
Alphanumeric, 13
If an instrument reference (IRF) is specified, a wallet reference (PRF) must be specified as well. If a wallet reference is specified but no instrument reference is specified, the default instrument in the wallet will be used.
PAN
Conditional
Card number
Numeric, 8-19
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
CUR
Mandatory
Currency
ISO 4217 alpha-3
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
REC
Optional
Is recurring
Values: ‘true’, 'false’
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required if DATACASH is used as 3DS processor.
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required if DATACASH is used as 3DS processor.
MEU
Conditional
Merchant URL
URI, 1-2047
Mandatory if DATACASH is used as 3DS processor.
Value should be URL encoded in the request.
UAG
Conditional
User agent(browser)
UTF8, 1-2047
Mandatory if DATACASH is used as 3DS processor.
Value should be URL encoded in the request.
AHE
Conditional
Accept header(browser)
UTF8, 1-2047
Mandatory if DATACASH is used as 3DS processor.
Value should be URL encoded in the request.
CVC
Conditional
Card verification code
Numeric, 3-4
Mandatory if ECENTRIC is used as 3DS processor.
AHN
Conditional
Account holder name
UTF8, 1-100
Mandatory if ECENTRIC is used as 3DS processor.
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI), must be specified.

The request elements are to be specified in keyword value format separated by &.

example: PRJ=EXAMPLE&CTY=US&PAN=4111111111111111&EXP=1010&CUR=USD&GRS=100.00

Request elements for xml/json format

S3D 3D Secure
PRJ
Mandatory
Project code
Alphanumeric, 1-10
CTY
Mandatory
Country
ISO 3166-1 alpha-2
STO
Optional
Store code
Alphanumeric, 1-20
PRF
Conditional
Wallet reference
Alphanumeric+ (no blanks), 1-40
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Conditional
Instrument reference
Alphanumeric, 13
If an instrument reference (IRF) is specified, a wallet reference (PRF) must be specified as well. If a wallet reference is specified but no instrument reference is specified, the default instrument in the wallet will be used.
CRD
Conditional
Card
PAN
Conditional
Card number
Numeric, 8-19
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
AHN
Conditional
Account holder name
UTF8, 1-100
Mandatory if ECENTRIC is used as 3DS processor.
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI), must be specified.
CUR
Mandatory
Currency
ISO 4217 alpha-3
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
REC
Optional
Is recurring
Values: 'true’, 'false’
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required if DATACASH is used as 3DS processor.
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required if DATACASH is used as 3DS processor.
MEU
Conditional
Merchant URL
URI, 1-2047
Mandatory if DATACASH is used as 3DS processor.
UAG
Conditional
User agent(browser)
UTF8, 1-2047
Mandatory if DATACASH is used as 3DS processor.
AHE
Conditional
Accept header(browser)
UTF8, 1-2047
Mandatory if DATACASH is used as 3DS processor.
VER
Conditional
Verification
CVC
Optional
Card verification code
Numeric, 3-4
Mandatory if ECENTRIC is used as 3DS processor.

Response elements

S3D 3D Secure
S3I
Optional
3D Secure XID
Alphanumeric,20
S3R
Mandatory
3D Secure status code
Values: '0 to 9’
'0’ = Not enrolled
'4’ = Technical error
'5’ = Continue authentication process
'6’ = Unable to enroll
S3N
Optional
3D Secure native status
UTF8, 1-10
ACB
Optional
Acquirer bin
UTF8, 1-24
ACU
Optional
ACS url
URI,RFC 2732, 1-2047
PRQ
Optional
Payer authentication request
Base64,1-1000
C3S
Optional
3D Secure status
Values: '3DSNotEnrolled’, '3DSTechFailureEnrol’
ATR
Optional
Acquirer transaction reference
UTF8, 1-100
S3V
Optional
3-D Secure enrollment status
Values:
'N’ = Not enrolled
'Y’ = Enrolled
'U’ = Unable to enroll
PRC
Optional
3D Secure processor
Alphanumeric,1-20

Verifying authentication

Sample request

    POST /s3d/authentication HTTP/1.1
    Host: ips.payments.goacoustic.com

    <S3D>
         <PRJ>EXAMPLE</PRJ>
         <CTY>US</CTY>
         <CUR>USD</CUR>
         <CRD>
              <PAN>4111111111111111</PAN>
         </CRD>
         <A3I>
              <S3I>PTTDBK679ZPC10000000</S3I>
              <PRS>SXQgaXMgYS...</PRS>
         </A3I>
    </S3D>

Sample response

    HTTP/1.1 200 OK

    <S3D>
      <S3I>PTTDBK679ZPC10000000</S3I>
      <S3R>1</S3R>
      <S3N>0</S3N>
      <ECI>05</ECI>
      <AAV>AAACBFCJU3QQEplVgolTAAAAAAA=</AAV>
      <S3A>Y</S3A>
      <C3S>3DSPassed</C3S>
    </S3D>

Sample request

    POST /s3d/authentication HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
      "S3D" : {
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "CRD" : {
          "PAN" : "4111111111111111"
        },
        "A3I" : {
          "S3I" : "PTTDBK679ZPC10000000",
          "PRS" : "SXQgaXMgYS..."
        }
      }
    }

Sample response

    HTTP/1.1 200 OK

    {
      "S3D" : {
        "S3I" : "PTTDBK679ZPC10000000",
        "S3R" : "1",
        "S3N" : "0",
        "ECI" : "05",
        "S3A" : "Y",
        "AAV" : "AAACBFCJU3QQEplVgolTAAAAAAA=",
        "C3S" : "3DSPassed"
      }
    }

After receiving a PARes from the ACS, a merchant can verify the outcome of the cardholder authentication session by sending a POST request to the generic 3-D Secure authentication URL:

POST /s3d/authentication

If the authentication was successful, ECI and AVV values will be returned, that must be included in a subsequent CardAuthorize transaction.

The request elements can be specified in keyword value pair format as well as xml and json format.

Request elements

Element Description
PRJ
Mandatory
Project code
Alphanumeric, 1-10
CTY
Mandatory
Country
ISO 3166-1 alpha-2
STO
Optional
Store code
Alphanumeric, 1-20
PRF
Conditional
Wallet reference
Alphanumeric+ (no blanks), 1-40
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
If an instrument reference (IRF) is specified, a wallet reference (PRF) must be specified as well.
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Conditional
Instrument reference
Alphanumeric, 13
If an instrument reference (IRF) is specified, a wallet reference (PRF) must be specified as well. If a wallet reference but no instrument reference is specified, the default instrument in the wallet will be used.
CUR
Mandatory
Currency
ISO 4217 alpha-3
REC
Optional
Is recurring
Values: 'true’, 'false’
PAN
Conditional
Card number
Numeric, 8-19
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
S3I
Conditional
3D secure transaction id
Alphanumeric, 20
Mandatory if G-PAY is used as 3DS processor.
PRS
Optional
Payer authentication response
UTF8,1-5000
ATR
Conditional
Acquirer transaction reference
UTF8, 1-100
Mandatory if DATACASH is used as 3DS processor.
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI), must be specified.

The request elements are to be specified in keyword value format separated by &.

example: PRJ=EXAMPLE&CTY=US&CUR=USD&PAN=4111111111111111&S3I=PTTDBK679ZPC10000000&PRS=SXQgaXMgYS…

Request elements for xml/json format

S3D 3D Secure
PRJ
Mandatory
Project code
Alphanumeric, 1-10
CTY
Mandatory
Country
ISO 3166-1 alpha-2
STO
Optional
Store code
Alphanumeric, 1-20
PRF
Conditional
Wallet reference
Alphanumeric+ (no blanks), 1-40
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Conditional
Instrument reference
Alphanumeric, 13
If an instrument reference (IRF) is specified, a wallet reference (PRF) must be specified as well. If a wallet reference but no instrument reference is specified, the default instrument in the wallet will be used.
CUR
Mandatory
Currency
ISO 4217 alpha-3
REC
Optional
Is recurring
Values: 'true’, 'false’
CRD
Conditional
Card
PAN
Conditional
Card number
Numeric, 8-19
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI) must be specified.
If either card number (PAN) or expiration date (EXP) is specified, the other must be specified as well.
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Exactly one of wallet reference (PRF) or card number (PAN) or token (TKI), must be specified.
A3I
Mandatory
3D aunthentication information
S3I
Conditional
3D secure transaction id
Alphanumeric, 20
Mandatory if G-PAY is used as 3DS processor.
PRS
Optional
Payer authentication response
UTF8,1-5000
ATR
Conditional
Acquirer transaction reference
UTF8, 1-100
Mandatory if DATACASH is used as 3DS processor.

Response elements

S3D 3D Secure
S3I
Optional
3D Secure XID
Alphanumeric,20
S3R
Mandatory
3D Secure status code
Values: '0 to 9’
'1’ = Authenticated
'2’ = Attempted authentication
'3’ = Unable to authenticate, retry required
'4’ = Technical error
S3N
Optional
3D Secure native status
UTF8, 1-10
ECI
Optional
E-commerce indicator
Numeric, 2
AAV
Optional
Accountholder authentication value
Base64, 1-28
C3S
Optional
3D Secure status
Values: '3DSPassed’, '3DSPassedAttempts’, 3DSNotPassed’, '3DSTechFailureAuth’
S3A
Optional
3-D Secure authentication status
Values:
'N’ = Authentication failed
'Y’= Authentication approved
'A’ = Authentication attempted
'U’= Unable to authenticate
PRC
Optional
3D Secure processor
Alphanumeric,1-20

ACH payment transactions

Verification

Request

POST /trx HTTP/1.1
<TRX>
    <SVC>ACHVerify</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CUS>
        <CTP>Private</CTP>
    </CUS>
    <BAC>
        <ACN>1234567890</ACN>
        <RTN>123123123</RTN>
    </BAC>
</TRX>
POST /trx HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "TRX" : {
      "SVC" : "ACHVerify",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CUS" : {
          "CTP" : "Private"
      },
      "BAC" : {
          "ACN" : "1234567890",
          "RTN" : "123123123"
      }
} }

Response

HTTP/1.1 200 OK

<TRX>
    <XID>AR7ZV9N126123</XID>
    <MPY>ACH</MPY>  
    <BAC>
        <SAN>****7890</SAN> 
        <RTN>123123123</RTN> 
    </BAC>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T12:43:17.323750Z</STM>
        <ETM>2010-10-04T12:43:18.341868Z</ETM>
        <PRC>EXBANK</PRC>
        <TEL>999999999</TEL>
        <BRC>A00</BRC>
      </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "AR7ZV9N126123",
      "MPY" : "ACH",
      "BAC" : {
          "SAN" : "****7890",
          "RTN" : "123123123"
      },
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T12:43:17.323750Z",
          "ETM" : "2010-10-04T12:43:18.341868Z",
          "PRC" : "EXBANK",
          "TEL" : "999999999",
          "BRC" : "A00"
      }
} }

An ACHVerify transaction is used to perform real-time verification of an ACH payment. Account and routing numbers are syntactically checked, but neither the existence of the specified account, nor its applicability for ACH debit is established at this time, and no funds are transferred. Merchants can initiate a funds transfer by submitting a subsequent Capture or Collect transaction with reference to the ACHVerify transaction. ACH is only supported in the US.

The basic data verification may be combined with a lookup on the merchant’s delinquent list (if such a list has been established) and/or a callout to a third-party service to verify the status of the account, and to authenticate the customer based on for example date of birth, driver’s license, and social security number.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value: ACHVerify
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a payment profile (wallet). Input data provided for the current transaction will be enriched with data from the referenced profile. If an instrument reference is provided, the referred instrument will be added to the current transaction. Otherwise the Default instrument for the profile will be used.
PRF
Optional
Profile reference
Alphanumeric+ (no blanks), 1-40
Refers to a payment profile (wallet). Input data provided for the current transaction will be enriched with data from the referenced profile. If an instrument reference is provided, the referred instrument will be added to the current transaction. Otherwise the Default instrument for the profile will be used
PRG
Optional
Profile group
Alphanumeric, 1-20
Merchant’s account code group. The profile group can be used if a merchant’s wallets needs to be shareable across merchant’s account codes.
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
REC
Optional
Is recurring?
Valid values: true, false. Default: false.
Indicates that the transaction is a recurring payment.
ENR
Optional
Is enrollment?
Valid values: true, false. Default: false.
Indicates that the transaction is made during enrollment in a recurring payment setup.
COM
Mandatory
Consent medium
Valid values: Internet, Phone
The medium used to obtain the customer’s consent for this transaction.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference
COC
Optional
Cost centre
Alphanumeric+, 1-30
CUC
Optional
Customer code
Alphanumeric+, 1-30
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optiona
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s unique Risk manager profile. Acoustic Payments will perform automated real time Risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk manger service and setup of Risk manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: true, false. Default: false.
SHM
Optional
Shipping method
Valid values: Express, Fast, Ground, Internet
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments.
Example values: IVR, Webshop, SMS, MobileApp, SAP.
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer data
SHT
Optional
Ship-to
Complex, see Ship-to data
ITM
Optional
Item
Complex, see Item data
BAC
Optional
Bank account
Complex, see Bank account data
VER
Optional
Verification
Complex, see Verification data

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference.
MPY Payment method
Alphanumeric, 1-10
BAC Bank account
Complex
RTN Routing number
Alphanumeric, 1-20
SAN Scrambled account number
Alphanumeric, 1-30
SBN Scrambled IBAN account number
Alphanumeric, 15-34
BIC BIC number
Alphanumeric, 8-11
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
ASA Can assume approval?
Values: true, false
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Verification and capture

Request

POST /trx HTTP/1.1

<TRX>
    <SVC>ACHVerCap</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>US</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>USD</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <BAC>
        <ACN>123456789</ACN>
        <RTN>123123123</RTN>
    </BAC>
</TRX>
POST /trx HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "TRX" : {
  "SVC" : "ACHVerCap",
      "PRJ" : "EXAMPLE",
      "CTY" : "US",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "USD",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "BAC" : {
          "ACN" : "123456789",
          "RTN" : "123123123"
      }
} }

Response

HTTP/1.1 200 OK

<TRX>
    <XID>F3ZZ32L9MQ123</XID>
    <MPY>ACH</MPY>
    <BAC>
        <SAN>****6789</SAN>
        <RTN>123123123</RTN>
    </BAC>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T12:49:38.094017Z</STM>
        <ETM>2010-10-04T12:49:39.107227Z</ETM>
        <PRC>EXBANK</PRC>
        <TEL>999999999</TEL>
        <BRC>A00</BRC>
    </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "F3ZZ32L9MQ123",
      "MPY" : "ACH",
      "BAC" : {
          "SAN" : "****6789",
          "RTN" : "123123123"
      },
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T12:49:38.094017Z",
          "ETM" : "2010-10-04T12:49:39.107227Z",
          "PRC" : "EXBANK",
          "TEL" : "999999999",
          "BRC" : "A00"
      }
} }

An ACHVerCap transaction is used to combine an ACHVerify and a Capture transaction into a single step.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value: ACHVerCap
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Profile reference
Alphanumeric+ (no blanks), 1-40
Refers to a payment profile (wallet). Input data provided for the current transaction will be enriched with data from the referenced profile. If an instrument reference is provided, the referred instrument will be added to the current transaction. Otherwise the Default instrument for the profile will be used.
PRG
Optional
Profile group
Alphanumeric, 1-20
Merchant’s account code group. The profile group can be used if a merchant’s wallets needs to be shareable across merchant’s account codes.
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
REC
Optional
Is recurring?
Valid values: true, false. Default: false
Indicates that the transaction is a recurring payment
ENR
Optional
Is enrollment?
Valid values: true, false. Default: false
Indicates that the transaction is made during enrollment in a recurring payment setup.
COM
Mandatory
Consent medium
Valid values: Internet, Phone
The medium used to obtain the customer’s consent for this transaction.
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference
COC
Optional
Cost centre
Alphanumeric+, 1-30
CUC
Optional
Customer code
Alphanumeric+, 1-30
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s Risk Manager profile. Please refer to your Acoustic Payments Account representative for information on the Risk Manager service and setup of Risk Manager profiles.
DAM
Optional
DPL screening approved by merchant
Valid values: true, false. Default: false.
SHM
Optional
Shipping method
Valid values: Express, Fast, Ground, Internet
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments.
Example values: IVR, Webshop, SMS, MobileApp, SAP.
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer data
SHT
Optional
Ship-to
Complex, see Ship-to data
ITM
Optional
Item
Complex, see Item data
BAC
Optional
Bank account
Complex, see Bank account data
VER
Optional
Verification
Complex, see Verification data

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
MPY Payment method
Alphanumeric, 1-10
BAC Bank account
Complex
RTN Routing number
Alphanumeric, 1-20
SAN Scrambled account number
Alphanumeric, 1-30
SBN Scrambled IBAN account number
Alphanumeric, 15-34
BIC BIC number
Alphanumeric, 8-11
RES Result
Complex
RCD Return code
Integer, values: 0 to 99999, see Return codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
ASA Can assume approval?
Values: true, false
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Customer data

<CUS>
    <CID>1648463</CID>
    <CTP>Private</CTP>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
</CUS>
{ "CUS" : {
      "CID" : "1648463",
      "CTP" : "Private",
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066"
} }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Conditional
Customer type
Valid values: Private, Business
Required for processing consumer and corporate debits through Certegy.
Required for processing through JPMorgan Chase
FNM
Conditional
First name
UTF8, 1-100
Required for processing consumer debits through Certegy
LNM
Conditional
Last name
UTF8, 1-100
Required for processing consumer debits through Certegy
CNM
Conditional
Company name
UTF8, 1-100
Required for processing corporate debits through Certegy
AD1
Conditional
Address line 1
UTF8, 1-50
Required for processing consumer and corporate debits through Certegy
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Conditional
City
UTF8, 1-50
Required for processing consumer and corporate debits through Certegy
ZIP
Conditional
Zip code
UTF8, 1-20
Required for processing consumer and corporate debits through Certegy
STA
Conditional
State
ISO 3166-2 alpha 3
Required for processing consumer and corporate debits through Certegy
CTY
Conditional
Country
ISO 3166-1 alpha-2
Required for processing consumer and corporate debits through Certegy
TEL
Conditional
Telephone
UTF8, 1-30
Required for processing consumer and corporate debits through Certegy
EMA
Conditional
Email
UTF8, 5-254
Required for processing consumer and corporate debits through Certegy

Ship-to data

<SHT>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
    <EMA>johnsmith@example.net</EMA>
</SHT>
{ "SHT" : {
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066",
      "EMA" : "johnsmith@example.net"
} }
SHT Ship-to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item data

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

<ITM>
    <ITN>91926493</ITN>
    <QTY>1</QTY>
    <UPR>14136.30</UPR>
    <NET>14136.30</NET>
    <TAX>0.00</TAX>
    <GRS>14136.30</GRS>
    <TXC>GOODS</TXC>
</ITM>
{ "ITM" : {
      "ITN" : "91926493",
      "QTY" : 1,
      "UPR" : 14136.30,
      "NET" : 14136.30,
      "TAX" : 0.00,
      "GRS" : 14136.30,
      "TXC" : "GOODS"
} }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for Commodity code.
ITT
Optional
Item type
Values: Shipping, Discount, Surcharge

Bank account

<BAC>
    <ACN>123445588</ACN>
    <RTN>121042882</RTN>
    <ATP>Checking</ATP>
</BAC>
{ "BAC" : {
      "ACN" : "123445588",
      "RTN" : "121042882",
      "ATP" : "Checking"
} }

BAC Bank account
ACN
Mandatory
Account number
Alphanumeric, 1-10
RTN
Conditional
Routing number
Alphanumeric, 1-20
Routing number is required depending on country. Please contact Acoustic Payments for more information.
BNM
Optional
Bank name
UTF8, 1-30
ATP
Conditional
Account type
Valid values: Checking, MoneyMarket, Savings
Required for processing through JPMorgan Chase
MAN
Optional
Mandate number
Alphanumeric+, 1-30

Verification

<VER>
    <BDT>1975-04-04</RTN>
</VER>
{ "VER" : {
      "BDT" : "1975-04-04"
} }     

VER Verification
BDT
Conditional
Date of birth
yyyy-mm-dd
May be required depending on the ACH processor. Please contact Acoustic Payments for more information.
DLN
Conditional
Driver’s license number
Alphanumeric, 1-30
May be required depending on the ACH processor. Please contact Acoustic Payments for more information.
DLS
Conditional
Driver’s license state
ISO 3166-2 alpha 3
May be required depending on the ACH processor. Please contact Acoustic Payments for more information.

Direct Debit payment transactions

Verification

Request:

POST /trx HTTP/1.1

<TRX>
    <SVC>DDVerify</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>DK</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>DKK</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CUS>
        <CTP>Private</CTP>
        <AD1>Nymøllevej 91</AD1>
        <CIT>Lyngby</CIT>
        <ZIP>2800</ZIP>
        <CTY>DK</CTY>
    </CUS>
    <BAC>
        <ACN>1234567890</ACN>
        <RTN>1234</RTN>
    </BAC>
</TRX>      
POST /trx HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "TRX" : {
      "SVC" : "DDVerify",
      "PRJ" : "EXAMPLE",
      "CTY" : "DK",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "DKK",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CUS" : {
          "CTP" : "Private",
          "AD1" : "Nymøllevej 91",
          "CIT" : "Lyngby",
          "ZIP" : "2800",
          "CTY" : "DK"
      },
      "BAC" : {
          "ACN" : "1234567890",
          "RTN" : "1234"
      }
} }

Response:

HTTP/1.1 200 OK

<TRX>
    <XID>ZKYZFW2AQM123</XID>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T13:19:34.000721Z</STM>
        <ETM>2010-10-04T13:19:34.001045Z</ETM>
    </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "ZKYZFW2AQM123",
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T13:19:34.000721Z",
          "ETM" : "2010-10-04T13:19:34.001045Z"
      }
} }

A DDVerify transaction is used to perform real-time verification of a Direct Debit payment. Account and routing numbers are syntactically verified, but neither the existence of the specified account, nor its applicability for Direct Debit is established at this time, and no funds are transferred. Merchants can initiate a funds transfer by submitting a subsequent Capture or Collect transaction with reference to the DDVerify transaction.

The basic data verification may be combined with a lookup on the merchant’s delinquent list (if such a list has been established).

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value: DDVerify
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
External transaction ID. Merchant’s unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the referenced transaction.
PRF
Optional
Profile reference
Alphanumeric+ (no blanks), 1-40
Refers to a payment profile (wallet). Input data provided for the current transaction will be enriched with data from the referenced profile. If an instrument reference is provided, the referred instrument will be added to the current transaction. Otherwise the default instrument for the profile will be used.
PRG
Optional
Profile group
Alphanumeric, 1-20
Merchant’s profile group. The profile group can be used if a merchant’s wallets needs to be shared by multiple account codes.
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet).
REC
Optional
Is recurring?
Valid values: true, false. Default: false.
Indicates that the transaction is a recurring payment.
ENR
Optional
Is enrollment?
Valid values: true, false. Default: false.
Indicates that the transaction is made during enrollment in a recurring payment setup.
COM
Mandatory
Consent medium
Valid values: Internet, Phone
The medium used to obtain the customer’s consent for this transaction.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference
COC
Optional
Cost centre
Alphanumeric+, 1-30
CUC
Optional
Customer code
Alphanumeric+, 1-30
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s Risk Manager profile. Acoustic Payments will perform automated real time risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments account representative for the Risk Manager service and setup of Risk Manager profiles.
DDT
Optional
Direct debit type
Alphanumeric, 1-10
DAM
Optional
DPL screening approved by merchant
Valid values: true, false. Default: false.
SHM
Optional
Shipping method
Valid values: Express, Fast, Ground, Internet
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: IVR, Webshop, SMS, MobileApp, SAP.
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer data
SHT
Optional
Ship-to
Complex, see Ship-to data
ITM
Optional
Item
Complex, see Item data
BAC
Mandatory
Bank account
Complex, see Bank account data

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
RES Result
Complex
RCD Return code
Integer, values: 0 to 99999, see Return codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug-in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Verification and capture

Request:

POST /trx HTTP/1.1

<TRX>
    <SVC>DDVerCap</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>DK</CTY>
    <ORD>12345</ORD>
    <COM>Internet</COM>
    <CUR>DKK</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CUS>
        <CTP>Private</CTP>
        <AD1>Nymøllevej 91</AD1>
        <CIT>Lyngby</CIT>
        <ZIP>2800</ZIP>
        <CTY>DK</CTY>
    </CUS>
    <BAC>
        <ACN>1234567890</ACN>
        <RTN>1234</RTN>
    </BAC>
</TRX>      
POST /trx HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "TRX" : {
      "SVC" : "DDVerCap",
      "PRJ" : "EXAMPLE",
      "CTY" : "DK",
      "ORD" : "12345",
      "COM" : "Internet",
      "CUR" : "DKK",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CUS" : {
          "CTP" : "Private",
          "AD1" : "Nymøllevej 91",
          "CIT" : "Lyngby",
          "ZIP" : "2800",
          "CTY" : "DK"
      },
      "BAC" : {
          "ACN" : "1234567890",
          "RTN" : "1234"
      }
} }

Response:

HTTP/1.1 200 OK

<TRX>
    <XID>4WDXV6PXAK123</XID>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2010-10-04T13:19:34.000721Z</STM>
        <ETM>2010-10-04T13:19:34.001045Z</ETM>
    </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "4WDXV6PXAK123",
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2010-10-04T13:19:34.000721Z",
          "ETM" : "2010-10-04T13:19:34.001045Z"
      }
} }

A DDVerCap transaction is used to combine a DDVerify and a Capture transaction into a single step.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value: DDVerCap
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
External transaction ID. Merchant’s unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the referenced transaction.
PRG
Optional
Profile group
Alphanumeric, 1-20
Merchant’s profile group. The profile group can be used if a merchant’s wallets needs to be shareable across merchant’s account codes.
PRF
Optional
Profile reference
Alphanumeric+ (no blanks), 1-40
Refers to a payment profile (wallet). Input data provided for the current transaction will be enriched with data from the referenced profile. If an instrument reference is provided, the referred instrument will be added to the current transaction. Otherwise the default instrument for the profile will be used.
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet).
REC
Optional
Is Recurring?
Valid values: true, false. Default: false.
Indicates that the transaction is a recurring payment.
ENR
Optional
Is Enrollment?
Valid values: true, false. Default: false.
Indicates that the transaction is made during enrollment in a recurring payment setup.
COM
Mandatory
Consent medium
Valid values: Internet, Phone
The medium used to obtain the customer’s consent for this transaction.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference
COC
Optional
Cost center
Alphanumeric+, 1-30
CUC
Optional
Customer code
Alphanumeric+, 1-30
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
RMP
Optional
Risk management profile
Alphanumeric+, 1-30
Merchant’s Risk Manager profile. Acoustic Payments will perform automated real time risk management on transactions that includes the RMP input tag. Please refer to your Acoustic Payments Account representative for the Risk Manager service and setup of Risk Manager profiles.
DDT
Optional
Direct debit type
Alphanumeric, 1-10
DAM
Optional
DPL screening approved by merchant
Valid values: true, false. Default: false.
SHM
Optional
Shipping method
Valid values: Express, Fast, Ground, Internet
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments.
Example values: IVR, Webshop, SMS, MobileApp, SAP.
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer data
SHT
Optional
Ship To
Complex, see Ship-to data
ITM
Optional
Item
Complex, see Item data
BAC
Mandatory
Bank Account
Complex, see Bank account data

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
RES Result
Complex
RCD Return code
Integer, values: 0 to 99999, see Return codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RMR Risk management result
Alphanumeric, 1-10
RMM Risk management message
Alphanumeric, 1-80
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug-in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Customer data

<CUS>
    <CID>1648463</CID>
    <CTP>Private</CTP>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
</CUS>
{ "CUS" : {
      "CID" : "1648463",
      "CTP" : "Private",
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066"
} }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Conditional
Customer type
Valid values: Private, Business
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
FNM
Conditional
First name
UTF8, 1-100
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
LNM
Conditional
Last name
UTF8, 1-100
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
CNM
Conditional
Company name
UTF8, 1-100
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
AD1
Conditional
Address line 1
UTF8, 1-50
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Conditional
City
UTF8, 1-50
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
ZIP
Conditional
Zip code
UTF8, 1-20
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
STA
Conditional
State
ISO 3166-2 alpha 3
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
CTY
Conditional
Country
ISO 3166-1 alpha-2
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
TEL
Conditional
Telephone
UTF8, 1-30
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
EMA
Conditional
Email
UTF8, 5-254
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.

Ship-to data

<SHT>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
    <EMA>johnsmith@example.net</EMA>
</SHT>
{ "SHT" : {
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066",
      "EMA" : "johnsmith@example.net"
} }
SHT Ship-to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item data

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

<ITM>
    <ITN>91926493</ITN>
    <QTY>1</QTY>
    <UPR>14136.30</UPR>
    <NET>14136.30</NET>
    <TAX>0.00</TAX>
    <GRS>14136.30</GRS>
    <TXC>GOODS</TXC>
</ITM>
{ "ITM" : {
      "ITN" : "91926493",
      "QTY" : 1,
      "UPR" : 14136.30,
      "NET" : 14136.30,
      "TAX" : 0.00,
      "GRS" : 14136.30,
      "TXC" : "GOODS"
} }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for Commodity code.
ITT
Optional
Item type
Values: Shipping, Discount, Surcharge

Bank account data

<BAC>
    <ACN>123445588</ACN>
    <RTN>121042882</RTN>
    <ATP>Checking</ATP>
</BAC>
{ "BAC" : {
      "ACN" : "123445588",
      "RTN" : "121042882",
      "ATP" : "Checking"
} } 
BAC Bank account
ACN
Conditional
Account number
Alphanumeric, 1-10
Either Account number (ACN) or IBAN number (IBN) must be present.
RTN
Conditional
Routing number
Alphanumeric, 1-20
May be required depending on country. Please contact Acoustic Payments for more information.
IBN
Conditional
IBAN number
Alphanumeric, 1-10
Either Account number (ACN) or IBAN number (IBN) must be present.
BIC
Optional
BIC number
Alphanumeric, 8-11
BNM
Optional
Bank name
UTF8, 1-30
BBN
Optional
Branch name
UTF8, 1-30
ATP
Conditional
Account type
Valid values: Checking, MoneyMarket, Savings
May be required depending on the direct debit processor. Please contact Acoustic Payments for more information.
MAN
Optional
Mandate number
Alphanumeric+, 1-30
MAD
Optional
Mandate date
yyyy-mm-dd

Dynamic Currency Conversion Transactions

DCC Inquiry

Sample request

      POST /dcc/inquiry HTTP/1.1
      Host: ips.payments.goacoustic.com

        <DCC>
            <PRJ>EXAMPLE</PRJ>
            <CTY>US</CTY>
            <COM>Internet</COM>
            <CUR>USD</CUR>
            <NET>10.08</NET>
            <TAX>0.51</TAX>
            <GRS>10.59</GRS>
            <CRD>
                <PAN>4000000000000002</PAN>
                <EXP>1218</EXP>
            </CRD>
        </DCC>

Sample response

      HTTP/1.1 200 OK

        <DCC>
            <XID>3H60SLJDP6D31</XID>
            <MPY>VISA</MPY>
            <BCC>USD</BCC>
            <BAM>11.89</BAM>
            <CCR>1.187352</CCR>
            <DRN>19100409330335</DRN>
            <MUP>3.5</MUP>
            <SRN>Elavon Merchant Services</SRN>
            <RVF>2019-10-04T08:33:43.000000Z</RVF>
            <RVT>2019-10-05T02:55:00.000000Z</RVT>
            <CRD>
                <SCN>491581XXXX0008</SCN>
                <EXP>0199</EXP>
                <CLV>2</CLV>
                <CBT>D</CBT>
            </CRD>
            <RES>
                <RCD>0</RCD>
                <MSG>Service succeeded</MSG>
                <STM>2019-10-04T08:33:43.437324Z</STM>
                <ETM>2019-10-04T08:33:43.659944Z</ETM>
                <PRC>ELAVONEU</PRC>
                <TEL>999999999</TEL>
                <BRC>000</BRC>
                <BRN>000</BRN>
            </RES>
        </DCC>
Sample request

      POST /dcc/inquiry HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json

        {
           "DCC": {
              "PRJ": "EXAMPLE",
              "CTY": "US",
              "COM": "Internet",
              "CUR": "USD",
              "NET": "10.08",
              "TAX": "0.51",
              "GRS": "10.59",
              "CRD": {
                 "PAN": "4000000000000002",
                 "EXP": "1218"
              }
           }
        }

Sample response

      HTTP/1.1 200 OK

        {
           "DCC": {
              "XID": "5CPZAD6ZA5123",
              "MPY": "VISA",
              "BCC": "EUR",
              "BAM": "12.34",
              "CCR": "1.234",
              "DRN": "Darn",
              "MUP": "0.33",
              "SRN": "SourceName",
              "RVF": "2017-01-01T00:00:00.000000Z",
              "RVT": "2017-12-31T23:59:59.999999Z"
              "CRD": {
                 "SCN": "****0002",
                 "EXP": "0118",
                 "CLV": "1",
                 "CBT": "C"
              },
              "RES": {
                 "RCD": "0",
                 "MSG": "Service succeeded",
                 "STM": "2017-10-20T10:59:50.007857Z",
                 "ETM": "2017-10-20T10:59:51.011018Z",
                 "PRC": "CSDUMMY",
                 "TEL": "999999999",
                 "BRC": "000",
                 "BRN": "000"
              }
           }
        }

The DCC Inquiry transaction is used to determine if the card is eligible or not for DCC, and if it is eligible the response message will include the currency and current exchange rate.

Request elements

DCC Dynamic Currency Conversion
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Mandatory
Project code
Alphanumeric, 1-20
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Mandatory
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
COM
Optional
Consent medium
Valid values: ‘Internet’, 'Phone’, 'Terminal’
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
EMV
Optional
Non sensitive EMV data
UTF8, 1-999
This tag should not contain the EMV tags 5A, 57 and 5F24.
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CRD
Mandatory
Card
Complex, see Card object
TER
Optional
Terminal data
Complex, see Terminal data object

Response elements

DCC Dynamic Currency Conversion
XID Transaction ID
Alphanumeric, 13
MPY Payment method
Alphanumeric, 1-10
BCC Billing currency code
ISO 4217 alpha-3
BAM Billing amount
Max 21 integer digits and 3 fractional digits, >=0
CCR Conversion rate
Max 16 integer digits and 8 fractional digits, >=0
DRN DCC reference number
Alphanumeric, 1-14
MUP MarkUp percentage
Max 5 integer digits and 3 fractional digits, >=0
SRN Source name
Alphanumeric, 1-100
RVF Valid from
DateTime, ISO 8601 UTC, 27
RVT Valid to
DateTime, ISO 8601 UTC, 27
CRD Card
Complex
CLV Card level
Values: '1’, '2’, '3’
SCN Scrambled card number
Alphanumeric, 8-19
EXP Expiration date
Numeric, MMYY, 4
TKI Token id for the card
Alphanumeric, 1-100
TID External token id provided by acquirer
Alphanumeric+, 1-40
CBT Card type
Valid Values:
'C’ = Credit
’D’ = Debit
'P’ = Prepaid
'U’ = Unknown
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
BRN Native bank response code
Alphanumeric, 1-10
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
LLM Long error message
UTF8, 1-100

Card

    <CRD>
        <PAN>4111111111111111</PAN>
        <EXP>0718</EXP>
        <AHN>John Smith</AHN>
    </CRD>
    {
      "CRD" : {
        "PAN" : "4111111111111111",
        "EXP" : "0718",
        "AHN" : "John Smith"
      }
    }
CRD Card
PAN
Conditional
Card number
Numeric, 8-19
Either PAN or TKI is required. If both are present PAN will have precedence.
In case on EMV transactions the card number should be extracted from EMV tag 5A and sent in CRD.PAN. In case of card swiped transactions the card number should be extracted from track data and sent in CRD.PAN.
EXP
Optional
Expiration date
Numeric, MMYY, 4
In case on EMV transactions the expiry date should be extracted from EMV tag 5F24 and sent in CRD.EXP. In case of card swiped transactions the expiry date should be extracted from track data and sent in CRD.EXP.
AHN
Optional
Account holder name
UTF8, 1-100
TKI
Conditional
Token id for the card
Alphanumeric, 1-100
Either PAN or TKI is required. If both are present PAN will have precedence.

Terminal Data

    <TER>
        <TSN>284239987</TSN>
        <DTY>Mx915P</DTY>
        <TEM>EMVChip</TEM>
        <PEC>WithPin</PEC>
        <TEI>8839625</TEI>
        <CNO>8</CNO>
        <LNE>0</LNE>
        <SNO>ECARS</SNO>
        <TEC>KeyEntry;MagneticStripe;EMVChip</TEC>
    </TER>
    {
      "TER" : {
        "TSN" : "284239987",
        "DTY" : "Mx915P",
        "TEM" : "EMVChip",
        "PEC" : "WithPin",
        "TEI" : "8839625",
        "CNO" : "8",
        "LNE" : "0",
        "SNO" : "ECARS",
        "TEC" : "KeyEntry;MagneticStripe;EMVChip"
      }
    }
TER Terminal data
TSN
Mandatory
Terminal serial number
UTF8, 1-50
DTY
Mandatory
Terminal device type
UTF8, 1-30
TEM
Mandatory
Terminal entry mode
Values: 'KeyEntry’, 'MagneticStripe’, 'EMVChip’, 'EMVContactless’, 'KeyEntryCNP’, 'MSRContactless’, 'EMVFallbackToMSR’
TEC
Optional
Terminal entry capability
Values: 'KeyEntry’, 'MagneticStripe’, 'EMVChip’, 'EMVContactless’
If there are multiple values they should be delimited by ; eg: 'KeyEntry;MagneticStripe;EMVChip;EMVContactless’
PEC
Optional
Pin entry capability
Values: 'NoPin’, 'WithPin’
TEI
Mandatory
Terminal Id
Alphanumeric, 1-8
CNO
Optional
Cashier number
Alphanumeric+, 1-10
SNO
Optional
Store number
Alphanumeric+, 1-10
LNE
Optional
Lane
Alphanumeric+, 1-10
MCV
Optional
Method of cardholder verification
Values: 'OfflinePIN’, 'OnlinePIN’, 'NoVerification’, 'ManualVerification’
ECV
Optional
Entity of cardholder verification
Values: 'EMVChip’, 'UnattendedDevice’, 'Attendant’, 'NoVerification’, 'Issuer’

Private label card payment transactions

Balance check

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>PrivateCardBalance</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <PCD>
            <PCN>1111222233334444555</PCN>
            <PCP>1234</PCP>
            <MPY>GC-ACME</MPY>
        </PCD>
    </TRX>

Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>02K4P0ZD4G123</XID>
        <PCD>
            <BAL>100.0</BAL>
        </PCD>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2016-11-02T09:55:36.050565Z</STM>
            <ETM>2016-11-02T09:55:37.078674Z</ETM>
            <PRC>ACME</PRC>
            <BRC>000</BRC>
            <ACQ>Test acquirer</ACQ>
        </RES>
    </TRX>
Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json
      Accept: application/json

    {
      "TRX" : {
        "SVC" : "PrivateCardBalance",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "PCD" : {
          "PCN" : "1111222233334444555",
          "PCP" : "1234"
          "MPY" : "GC-ACME"
        }
      }
    }


Sample response

      HTTP/1.1 200 OK

    {
      "TRX" : {
        "XID" : "02K4P0ZD4G123",
        "PCD" : {
          "BAL" : 100.0
        },
        "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2016-11-02T09:55:36.050565Z",
          "ETM" : "2016-11-02T09:55:37.078674Z",
          "PRC" : "ACME",
          "BRC" : "000",
          "ACQ" : "Test acquirer"
        }
      }
    }

A PrivateCardBalance transaction is used to verify the available funds on a private label card, e.g. a gift card.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“PrivateCardBalance”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CUR
Mandatory
Currency
ISO 4217 alpha-3
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
PCD
Conditional
Private label card
Complex, see Private label card object
Required if neither profile data nor XRF are specified.

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PCD Private label card
Complex
BAL Balance
Max 18 integer digits and 3 fractional digits, >=0
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Authorization

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>PrivateCardAuthorize</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <COM>Internet</COM>
        <GRS>150.00</GRS>
        <NET>150.00</NET>
        <TAX>0.00</TAX>
        <PCD>
            <PCN>1111222233334444555</PCN>
            <PCP>1234</PCP>
            <MPY>GC-CERIDN</MPY>
        </PCD>
    </TRX>


Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>PZFK7480ZP123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2016-11-02T10:03:20.464530Z</STM>
            <ETM>2016-11-02T10:03:21.496310Z</ETM>
            <PRC>CERIDIAND</PRC>
            <BRC>000</BRC>
            <ACQ>Test acquirer</ACQ>
        </RES>
    </TRX>
Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
      "TRX" : {
        "SVC" : "PrivateCardAuthorize",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "COM" : "Internet",
        "GRS" : 150.00,
        "NET" : 150.00,
        "TAX" : 0.00,
        "PCD" : {
          "PCN" : "1111222233334444555",
          "PCP" : "1234"
          "MPY" : "GC-CERIDN"
        }
      }
    }


Sample response

    HTTP/1.1 200 OK

    {
      "TRX" : {
        "XID" : "PZFK7480ZP123",
        "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2016-11-02T10:03:20.464530Z",
          "ETM" : "2016-11-02T10:03:21.496310Z",
          "PRC" : "CERIDIAND",
          "BRC" : "000",
          "ACQ" : "Test acquirer"
        }
      }
    }

A PrivateCardAuthorize transaction is used to place a reserve on funds on a private label card. Depending on the private label card provider, this could be valid for a limited period of time configured at the provider. A subsequent Capture or Collect transaction is used to debit the card.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“PrivateCardAuthorize”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: ‘Internet’, 'Phone’
Mandatory if XRF is not specified.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
PCD
Conditional
Private label card
Complex, see Private label card object
Required if neither profile data nor XRF are specified.

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Authorization and capture

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>PrivateCardAuthCap</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <COM>Internet</COM>
        <ORD>Order Number</ORD>
        <GRS>150.00</GRS>
        <NET>150.00</NET>
        <TAX>0.00</TAX>
        <PCD>
            <PCN>1111222233334444555</PCN>
            <PCP>1234</PCP>
            <MPY>GC-CERIDN</MPY>
        </PCD>
    </TRX>

Sample response

    HTTP/1.1 200 OK

    <TRX>
      <XID>WFT0TR2WGY123</XID>
      <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2014-12-10T13:08:04.316863Z</STM>
        <ETM>2014-12-10T13:08:05.395416Z</ETM>
        <PRC>CSDUMMY</PRC>
        <BRC>000</BRC>
      </RES>
    </TRX>
Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
      "TRX" : {
        "SVC" : "PrivateCardAuthCap",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "COM" : "Internet",
        "ORD" : "Order Number",
        "GRS" : 150.00,
        "NET" : 150.00,
        "TAX" : 0.00,
        "PCD" : {
          "PCN" : "1111222233334444555",
          "PCP" : "1234",
          "MPY" : "GC-CERIDN"
        }
      }
    }


Sample response

    HTTP/1.1 200 OK

    {
      "TRX" : {
        "XID" : "PZFK7480ZP123",
        "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2016-11-02T10:03:20.464530Z",
          "ETM" : "2016-11-02T10:03:21.496310Z",
          "PRC" : "CERIDIAND",
          "BRC" : "000",
          "ACQ" : "Test acquirer"
        }
      }
    }

A PrivateCardAuthCap transaction is used to combine a PrivateCardAuthorize and a Capture transaction into a single step.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“PrivateCardAuthCap”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’
Mandatory if XRF is not specified.
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
PCD
Conditional
Private label card
Complex, see Private label card object
Required if neither profile data nor XRF are specified.

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Private label card

    <PCD>
        <PCN>1111222233334444555</PCN>
        <PCP>1234</PCP>
        <MPY>GC-CERIDN</MPY>
    </PCD>
    {
      "PCD" : {
        "PCN" : "1111222233334444555",
        "PCP" : "1234",
        "MPY" : "GC-CERIDN"
      }
    }
PCD Private label card
PCN
Mandatory
Private label card number
Alphanumeric, 1-40
PCP
Optional
Private label card pin
Alphanumeric, 1-40
MPY
Mandatory
Payment method
Alphanumeric, 1-10

Customer


    <CUS>
        <CID>1648463</CID>
        <CTP>Private</CTP>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
    </CUS>
    {
      "CUS" : {
        "CID" : "1648463",
        "CTP" : "Private",
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066"
      }
    }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Ship To

    <SHT>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
        <EMA>johnsmith@example.net</EMA>
    </SHT>
    {
      "SHT" : {
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "johnsmith@example.net"
      }
    }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

    <ITM>
        <ITN>91926493</ITN>
        <QTY>1</QTY>
        <UPR>14136.30</UPR>
        <NET>14136.30</NET>
        <TAX>0.00</TAX>
        <GRS>14136.30</GRS>
        <TXC>GOODS</TXC>
    </ITM>
    {
      "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 14136.30,
        "NET" : 14136.30,
        "TAX" : 0.00,
        "GRS" : 14136.30,
        "TXC" : "GOODS"
      }
    }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”

Loyalty transactions

Create loyalty account

Sample request

    POST /loy HTTP/1.1
    Host: ips.payments.goacoustic.com

    <LOY>
        <LOS>LOYSCHEME1</LOS>
        <LOI>1234567</LOI>
        <CUS>
            <FNM>John</FNM>
            <LNM>Doe</LNM>
            <CTP>Private</CTP>
            <AD1>72 Arrow Lake Rd</AD1>
            <CIT>Pine Grove</CIT>
            <ZIP>17963</ZIP>
            <STA>PA</STA>
            <CTY>US</CTY>
            <TEL>123-345-2066</TEL>
            <EMA>JohnDoe@example.com</EMA>
        </CUS>
    </LOY>

Sample response

    HTTP/1.1 201 Created
    Location: https://ips.payments.goacoustic.com:50443/loy/LOYSCHEME1/1234567

    <LOY>
        <LOI>1234567</LOI>
        <XID>BYRCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </LOY>

Sample decline response 

    HTTP/1.1 200 OK

    <LOY>
        <XID>BYRCJRYBFV123</XID>
        <RES>
            <RCD>10011</RCD>
            <MSG>Declined</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>600</BRC>
        </RES>
    </LOY>

Sample error response   

HTTP/1.1 400 Bad Request

<ERR>
  <XID>BYRCJRYBFV123</XID>
  <RCD>20017</RCD>
  <MSG>Invalid input</MSG>
  <STM>2017-02-04T00:04:32.559580Z</STM>
  <ETM>2017-02-04T00:04:32.774511Z</ETM>
</ERR>

Sample request

      POST /loy HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json
      Accept: application/json

    {
    "LOY" : {
        "LOS" : "LOYSCHEME1",
        "LOI" : "1234567",
        "CUS" : {
        "FNM" : "John",
        "LNM" : "Doe",
        "CTP" : "Private",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "JohnDoe@example.com"
        }
      }
    }


Sample response

    HTTP/1.1 201 Created
    Location: https://ips.payments.goacoustic.com:50443/loy/LOYSCHEME1/1234567

    {
    "LOY" : {
        "LOI" : "1234567",
        "XID" : "BYRCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }
Sample decline response 
    HTTP/1.1 200 OK

    {
    "LOY" : {
        "XID" : "BYRCJRYBFV123",
        "RES" : {
        "RCD" : 10011,
        "MSG" : "Declined",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "600"
        }
      }
    }
Sample error response   

    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "BYRCJRYBFV123",
        "RCD" : 20017,
        "MSG" : "Invalid input",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
     }
    }

A loyalty account can be created by sending a POST request to the URL:

POST /loy

Request elements

LOY Loyalty
LOS
Mandatory
Loyalty schemed Id
UTF8, 1-10
LOI
Optional
Loyalty number
UTF8, 1-40
The tag might be mandatory for some loyalty scheme providers.
CUS
Mandatory
Customer
Complex
CTP
Optional
Customer type
Valid values: ‘Private’, 'Business’
If CTP= Private, then FNM and LNM are required. If CTP=Business then CNM is required. If CTP is not present, FNM and LNM are required.
FNM
Conditional
First name
UTF8, 1-100
If CTP= Private, then FNM and LNM are required. If CTP=Business then CNM is required. If CTP is not present, FNM and LNM are required.
LNM
Conditional
Last name
UTF8, 1-100
If CTP= Private, then FNM and LNM are required. If CTP=Business then CNM is required. If CTP is not present, FNM and LNM are required.
CNM
Conditional
Company name
UTF8, 1-100
If CTP= Private, then FNM and LNM are required. If CTP=Business then CNM is required. If CTP is not present, FNM and LNM are required.
AD1
Optional
Address line 1
UTF8, 1-50
The tag might be mandatory for some loyalty scheme providers.
AD2
Optional
Address line 2
UTF8, 1-50
The tag might be mandatory for some loyalty scheme providers.
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
The tag might be mandatory for some loyalty scheme providers.
ZIP
Optional
Zip code
UTF8, 1-20
The tag might be mandatory for some loyalty scheme providers.
STA
Optional
State
ISO 3166-2 alpha 3
The tag might be mandatory for some loyalty scheme providers.
CTY
Optional
Country
ISO 3166-1 alpha-2
The tag might be mandatory for some loyalty scheme providers.
TEL
Optional
Telephone
UTF8, 1-30
The tag might be mandatory for some loyalty scheme providers.
EMA
Mandatory
Email
UTF8, 5-254
TLT
Optional
Title
UTF8, 1-50

Response elements

LOY Loyalty
XID Transaction ID
Alphanumeric, 13
LOI Loyalty number
UTF8, 1-40
If the service is successful the loyalty number will be returned in the response.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
LLM Long error message
UTF8, 1-100

Update loyalty account

Sample request

    PUT /loy/LOYSCHEME1/1234567 HTTP/1.1
    Host: ips.payments.goacoustic.com

    <LOY>
        <CUS>
            <AD1>72 Arrow Lake Road</AD1>
            <CIT>Pine Grove</CIT>
        </CUS>
    </LOY>


Sample response

    HTTP/1.1 200 OK

    <LOY>
        <XID>ABCCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </LOY>


Sample error response   

    HTTP/1.1 400 Bad Request

    <ERR>
        <XID>ABCCJRYBFV123</XID>
        <RCD>20017</RCD>
        <MSG>Invalid input</MSG>
        <STM>2017-02-04T00:04:32.559580Z</STM>
        <ETM>2017-02-04T00:04:32.774511Z</ETM>
    </ERR>

Sample request

    PUT /loy/LOYSCHEME1/1234567 HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
    "LOY" : {
        "CUS" : {
        "AD1" : "72 Arrow Lake Road",
        "CIT" : "Pine Grove"
        }
      }
    }


Sample response

    HTTP/1.1 200 OK

    {
    "LOY" : {
        "XID" : "ABCCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }

Sample error response   
    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "ABCCJRYBFV123",
        "RCD" : 20017,
        "MSG" : "Invalid input",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
      }
    }

A loyalty account can be updated by sending a PUT request to the URL:

PUT /loy/{LOS}/{LOI}

Request elements

LOY Loyalty
CUS
Mandatory
Customer
Complex
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254
TLT
Optional
Title
UTF8, 1-50

Response elements

LOY Loyalty
XID Transaction ID
Alphanumeric, 13
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
LLM Long error message
UTF8, 1-100

Get loyalty account details

A loyalty account data can be retrieved by sending a GET request to the URL:

GET /loy/{LOS}/{LOI}

Sample request

    GET /loy/LOYSCHEME1/1234567 HTTP/1.1
    Host: ips.payments.goacoustic.com

Sample response

    HTTP/1.1 200 OK

    <LOY>
        <XID>DEFCJRYBFV123</XID>
        <LOS>LOYSCHEME1</LOS>
        <LOI>1234567</LOI>
        <CUS>
            <AD1>72 Arrow Lake Rd</AD1>
            <CIT>Pine Grove</CIT>
            <ZIP>17963</ZIP>
            <STA>PA</STA>
            <CTY>US</CTY>
            <TEL>123-345-2066</TEL>
            <EMA>JohnDoe@example.com</EMA>
        </CUS>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </LOY>

Sample request

    GET /loy/LOYSCHEME1/1234567 HTTP/1.1
    Host: ips.payments.goacoustic.com
    Accept: application/json

Sample response

    HTTP/1.1 200 OK

    {
    "LOY" : {
        "XID" : "DEFCJRYBFV123",
        "LOS" : "LOYSCHEME1",
        "LOI" : "1234567",
        "CUS" : {
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "JohnDoe@example.com"
        },
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }

Response elements

LOY Loyalty
LOS Loyalty schemed Id
UTF8, 1-10
LOI Loyalty number
UTF8, 1-40
CUS Customer
Complex
CTP Customer type
Valid values: 'Private’, 'Business’
FNM First name
UTF8, 1-100
LNM Last name
UTF8, 1-100
CNM Company name
UTF8, 1-100
AD1 Address line 1
UTF8, 1-50
AD2 Address line 2
UTF8, 1-50
AD3 Address line 3
UTF8, 1-50
AD4 Address line 4
UTF8, 1-50
CIT City
UTF8, 1-50
ZIP Zip code
UTF8, 1-20
STA State
ISO 3166-2 alpha 3
CTY Country
ISO 3166-1 alpha-2
TEL Telephone
UTF8, 1-30
EMA Email
UTF8, 5-254
TLT Title
UTF8, 1-50

Balance check

Sample request

    GET /loy/LOYSCHEME1/1234567?balance HTTP/1.1
    Host: ips.payments.goacoustic.com      


Sample response

    HTTP/1.1 200 OK

    <LOY>
        <XID>GHICJRYBFV123</XID>
        <GRS>125.00</GRS>
        <CUR>USD</CUR>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </LOY>


Sample request

    GET /loy/LOYSCHEME1/1234567 HTTP/1.1
    Host: ips.payments.goacoustic.com
    Accept: application/json

Sample response

    HTTP/1.1 200 OK

    {
    "LOY" : {
        "XID" : "GHICJRYBFV123",
        "GRS" : 125.00,
        "CUR" : "USD",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }

The balance on a loyalty account can be retrieved by sending a GET request to the URL:

GET /loy/{LOS}/{LOI}?balance

Response elements

LOY Loyalty
XID Transaction ID
Alphanumeric, 13
CUR Currency
ISO 4217 alpha-3
GRS Loyalty amount balance
Max 18 integer digits and 3 fractional digits, >=0
POB Point balance
Integer, Values: 0 to 99999999
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
LLM Long error message
UTF8, 1-100

Loyalty point issuance

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>LoyaltyPointIssue</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <GRS>120.00</GRS>
        <NET>120.00</NET>
        <TAX>0.00</TAX>
        <LOY>
            <LOS>LOYSCHEME1</LOS>
            <LOI>1234567</LOI>
        </LOY>
        <ITM>
            <ITN>91926493</ITN>
            <QTY>1</QTY>
            <UPR>120.00</UPR>
            <NET>120.00</NET>
            <TAX>0.00</TAX>
            <GRS>120.00</GRS>
        </ITM>
    </TRX>      



Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>HIJCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </TRX>

Sample decline response

    HTTP/1.1 200 OK

    <TRX>
        <XID>HIJCJRYBFV123</XID>
        <RES>
            <RCD>10011</RCD>
            <MSG>Declined</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>111</BRC>
        </RES>
    </TRX>

Sample error response

    HTTP/1.1 400 Bad Request

    <ERR>
    <XID>HIJCJRYBFV123</XID>
    <RCD>20017</RCD>
    <MSG>Invalid input</MSG>
    <STM>2017-02-04T00:04:32.559580Z</STM>
    <ETM>2017-02-04T00:04:32.774511Z</ETM>
    </ERR>
Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
    "TRX" : {
        "SVC" : "LoyaltyPointIssue",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "GRS" : 120.00,
        "NET" : 120.00,
        "TAX" : 0.00,
        "LOY" : {
        "LOS" : "LOYSCHEME1",
        "LOI" : "1234567"
        },
        "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 120.00,
        "NET" : 120.00,
        "TAX" : 0.00,
        "GRS" : 120.00
        }
      }
    }


Sample response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "HIJCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }


Sample decline response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "HIJCJRYBFV123",
        "RES" : {
        "RCD" : 10011,
        "MSG" : "Declined",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "111"
        }
      }
    }

Sample error response

    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "HIJCJRYBFV123",
        "RCD" : 20017,
        "MSG" : "Invalid input",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
      }
    }

Loyalty points can be added to a loyalty account by sending a POST request to the URL:

POST /trx

The points will be calculated according to the rules set up at the scheme provider based on amount, items, promotion code etc.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“LoyaltyPointIssue”
PRJ
Mandatory
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
CTY
Mandatory
Country
ISO 3166-1 alpha-2
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
PMC
Optional
Promotion code
Alphanumeric+, 1-100
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
LOY
Mandatory
Loyalty
Complex
LOS
Mandatory
Loyalty scheme id
UTF8, 1-10
LOI
Mandatory
Loyalty number
UTF8, 1-40
ITM
Optional
Item
Complex, see Item object

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
LLM Long error message
UTF8, 1-100
ATR Acquirer transaction reference
UTF8, 1-100

Loyalty point cancellation

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>LoyaltyPointCancel</SVC>
        <XRF>HIJCJRYBFV123</XRF>
    </TRX>      


Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>NOPJCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
        </RES>
    </TRX>

Sample decline response

HTTP/1.1 200 OK

<TRX>
    <XID>NOPJCJRYBFV123</XID>
    <RES>
        <RCD>10011</RCD>
        <MSG>Declined</MSG>
        <STM>2017-02-04T12:02:39.222085Z</STM>
        <ETM>2017-02-04T12:02:40.243214Z</ETM>
        <PRC>GIVEX</PRC>
      <BRC>602</BRC>
    </RES>
</TRX>

Sample error response
    HTTP/1.1 400 Bad Request

    <ERR>
    <XID>NOPJCJRYBFV123</XID>
    <RCD>20016</RCD>
    <MSG>Invalid value for element</MSG>
    <STM>2017-02-04T00:04:32.559580Z</STM>
    <ETM>2017-02-04T00:04:32.774511Z</ETM>
    </ERR>
Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
    "TRX" : {
        "SVC" : "LoyaltyPointCancel",
        "XRF" : "HIJCJRYBFV123"
      }
    }


Sample response
    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "NOPJCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000"
        }
      }
    }

Sample decline response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "NOPJCJRYBFV123",
        "RES" : {
        "RCD" : 10011,
        "MSG" : "Declined",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "602"
        }
      }
    }

Sample error response

    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "NOPJCJRYBFV123",
        "RCD" : 20016,
        "MSG" : "Invalid value for element",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
      }
    }

Loyalty points added to a loyalty account, by a Loyalty Point Issue call, can be cancelled ,by sending a POST request to the URL:

POST /trx

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“LoyaltyPointCancel”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
The XRF should refer to the point issuance transaction which is to be cancelled.
PRJ
Mandatory
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
CTY
Mandatory
Country
ISO 3166-1 alpha-2
NET
Optional
Net amount
Max 18 integer digits and 3 fractional digits, >=0
Amounts are optional and only required for partial cancellations. Not all processors support partial cancellations. Please contact your Acoustic Payments account representative for details.
TAX
Optional
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
Amounts are optional and only required for partial cancellations. Not all processors support partial cancellations. Please contact your Acoustic Payments account representative for details.
GRS
Optional
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
Amounts are optional and only required for partial cancellations. Not all processors support partial cancellations. Please contact your Acoustic Payments account representative for details.
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
LLM Long error message
UTF8, 1-100
ATR Acquirer transaction reference
UTF8, 1-100

Authorization

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>LoyaltyAuthorize</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <GRS>120.00</GRS>
        <NET>120.00</NET>
        <TAX>0.00</TAX>
        <ORD>OrderNumber</ORD>
        <LOY>
            <LOS>LOYSCHEME1</LOS>
            <LOI>1234567</LOI>
        </LOY>
    </TRX>


Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>KLMCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
            <ATR>ReferenceNumber</ATR>
        </RES>
    </TRX>


Sample decline response

    HTTP/1.1 200 OK

    <TRX>
        <XID>HIJCJRYBFV123</XID>
        <RES>
            <RCD>10011</RCD>
            <MSG>Declined</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>110</BRC>
        </RES>
    </TRX>

Sample error response

    HTTP/1.1 400 Bad Request

    <ERR>
    <XID>HIJCJRYBFV123</XID>
    <RCD>20017</RCD>
    <MSG>Invalid input</MSG>
    <STM>2017-02-04T00:04:32.559580Z</STM>
    <ETM>2017-02-04T00:04:32.774511Z</ETM>
    </ERR>
Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
    "TRX" : {
        "SVC" : "LoyaltyAuthorize",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "GRS" : 120.00,
        "NET" : 120.00,
        "TAX" : 0.00,
        "ORD" : "OrderNumber",
        "LOY" : {
        "LOS" : "LOYSCHEME1",
        "LOI" : "1234567"
        }
      }
    }


Sample response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "KLMCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000",
        "ATR" : "ReferenceNumber"
        }
      }
    }

Sample decline response
    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "KLMCJRYBFV123",
        "RES" : {
        "RCD" : 10011,
        "MSG" : "Declined",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "110"
        }
      }
    }
Sample error response

    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "KLMCJRYBFV123",
        "RCD" : 20017,
        "MSG" : "Invalid input",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
      }
    }

A LoyaltyAuthorize transaction is used for authorization of a payment using loyalty. The request is send as a POST request to the URL:

POST /trx

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“LoyaltyAuthorize”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’
Mandatory if XRF is not specified.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC
LOY
Conditional
Loyalty
Complex
Required if neither profile data nor XRF are specified.
LOS
Mandatory
Loyalty scheme Id
UTF8, 1-10
LOI
Mandatory
Loyalty number
UTF8, 1-40

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Authorization and capture

Sample request
    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com

    <TRX>
        <SVC>LoyaltyAuthCap</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <CUR>USD</CUR>
        <GRS>120.00</GRS>
        <NET>120.00</NET>
        <TAX>0.00</TAX>
        <ORD>OrderNumber</ORD>
        <LOY>
            <LOS>LOYSCHEME1</LOS>
            <LOI>1234567</LOI>
        </LOY>
    </TRX>

Sample response

    HTTP/1.1 200 OK

    <TRX>
        <XID>KLMCJRYBFV123</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>000</BRC>
            <ATR>ReferenceNumber</ATR>
        </RES>
    </TRX>

Sample decline response

    HTTP/1.1 200 OK

    <TRX>
        <XID>HIJCJRYBFV123</XID>
        <RES>
            <RCD>10011</RCD>
            <MSG>Declined</MSG>
            <STM>2017-02-04T12:02:39.222085Z</STM>
            <ETM>2017-02-04T12:02:40.243214Z</ETM>
            <PRC>GIVEX</PRC>
        <BRC>110</BRC>
        </RES>
    </TRX>

Sample error response

    HTTP/1.1 400 Bad Request

    <ERR>
        <XID>HIJCJRYBFV123</XID>
        <RCD>20017</RCD>
        <MSG>Invalid input</MSG>
        <STM>2017-02-04T00:04:32.559580Z</STM>
        <ETM>2017-02-04T00:04:32.774511Z</ETM>
    </ERR>

Sample request

    POST /trx HTTP/1.1
    Host: ips.payments.goacoustic.com
    Content-Type: application/json
    Accept: application/json

    {
    "TRX" : {
        "SVC" : "LoyaltyAuthCap",
        "PRJ" : "EXAMPLE",
        "CTY" : "US",
        "CUR" : "USD",
        "GRS" : 120.00,
        "NET" : 120.00,
        "TAX" : 0.00,
        "ORD" : "OrderNumber",
        "LOY" : {
        "LOS" : "LOYSCHEME1",
        "LOI" : "1234567"
        }
      }
    }

Sample response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "KLMCJRYBFV123",
        "RES" : {
        "RCD" : 0,
        "MSG" : "Service succeeded",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "000",
        "ATR" : "ReferenceNumber"
        }
      }
    }

Sample decline response

    HTTP/1.1 200 OK

    {
    "TRX" : {
        "XID" : "KLMCJRYBFV123",
        "RES" : {
        "RCD" : 10011,
        "MSG" : "Declined",
        "STM" : "2017-02-04T12:02:39.222085Z",
        "ETM" : "2017-02-04T12:02:40.243214Z",
        "PRC" : "GIVEX",
        "BRC" : "110"
        }
      }
    }

Sample error response

    HTTP/1.1 400 Bad Request

    {
    "ERR" : {
        "XID" : "KLMCJRYBFV123",
        "RCD" : 20017,
        "MSG" : "Invalid input",
        "STM" : "2017-02-04T00:04:32.559580Z",
        "ETM" : "2017-02-04T00:04:32.774511Z"
      }
    }

A LoyaltyAuthCap transaction is used to combine a Loyalty Authorize and a Capture transaction into a single step. The request is send as a POST request to the URL:

POST /trx

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“LoyaltyAuthCap”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’
Mandatory if XRF is not specified.
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC
LOY
Conditional
LOS
Mandatory
LOI
Mandatory

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
BRC Bank response code
Alphanumeric, 1-3, see Bank response codes
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100

Customer


    <CUS>
        <CID>1648463</CID>
        <CTP>Private</CTP>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
    </CUS>
    {
      "CUS" : {
        "CID" : "1648463",
        "CTP" : "Private",
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066"
      }
    }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Ship To

    <SHT>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
        <EMA>johnsmith@example.net</EMA>
    </SHT>
    {
      "SHT" : {
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "johnsmith@example.net"
      }
    }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

    <ITM>
        <ITN>91926493</ITN>
        <QTY>1</QTY>
        <UPR>14136.30</UPR>
        <NET>14136.30</NET>
        <TAX>0.00</TAX>
        <GRS>14136.30</GRS>
        <TXC>GOODS</TXC>
    </ITM>
    {
      "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 14136.30,
        "NET" : 14136.30,
        "TAX" : 0.00,
        "GRS" : 14136.30,
        "TXC" : "GOODS"
      }
    }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”

DCC

DCC elements passed in the request will be not echoed back on response.

  <DCC>
    <BCC>HKD</BCC>
    <BAM>325.52</BAM>
    <RVF>2019-12-04T14:06:07.000000Z</RVF>
    <RVT>2019-12-05T03:56:00.000000Z</RVT>
    <CCR>9.30051</CCR>
    <MUP>3.5</MUP>
    <SRN>Elavon Merchant Services</SRN>
    <DRN>19120414067283</DRN>
  </DCC>
  {
    "DCC" : {
      "BCC" : "HKD",
      "BAM" : 325.52,
      "RVF" : "2019-12-04T14:06:07.000000Z",
      "RVT" : "2019-12-05T03:56:00.000000Z",
      "CCR" : 9.30051,
      "MUP" : 3.5,
      "SRN" : "Elavon Merchant Services",
      "DRN" : "19120414067283"
    }
  }
DCC Dynamic Currency Conversion
BAM
Mandatory
Billing Amount
Max 21 integer digits and 3 fractional digits, >=0
BCC
Mandatory
Billing Currency Code
ISO 4217 alpha-3
CCR
Mandatory
Currency Conversion Rate
Max 16 integer digits and 8 fractional digits, >=0
DRN
Mandatory
DCC Reference Number
UTF8, 1-14
MUP
Optional
Mark Up Percentage
Max 5 integer digits and 3 fractional digits, >=0
RVF
Optional
Rate Valid From timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
RVT
Mandatory
Rate Valid To timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
SRN
Optional
Source Name
UTF8, 1-100

Credit transfer transactions

Credit transfer

Request:

POST /trx HTTP/1.1

<TRX>
    <SVC>CreditTransfer</SVC>
    <PRJ>EXAMPLE</PRJ>
    <CTY>DK</CTY>
    <INV>12345</INV>
    <TL3>4056</TL3>
    <CUR>EUR</CUR>
    <NET>1000.00</NET>
    <TAX>100.00</TAX>
    <GRS>1100.00</GRS>
    <CUS>
        <CID>76786786AB</CID>
        <CTP>Business</CTP>
        <CNM>The company</CNM>
    </CUS>
    <BAC>
        <ACN>1234567890</ACN>
        <RTN>1234</RTN>
    </BAC>
    <CTT>ABCDEFGHI</CTT>
</TRX>
POST /trx HTTP/1.1
Content-Type: application/json
Accept: application/json

{ "TRX" : {
      "SVC" : "CreditTransfer",
      "PRJ" : "EXAMPLE",
      "CTY" : "DK",
      "INV" : "12345",
      "TL3" : "4056",
      "CUR" : "EUR",
      "NET" : 1000.00,
      "TAX" : 100.00,
      "GRS" : 1100.00,
      "CUS" : {
          "CID" : "76786786AB",
          "CTP" : "Business",
          "CNM" : "The company"
      },
      "BAC" : {
          "ACN" : "1234567890",
          "RTN" : "1234"
      },
      "CTT" : "ABCDEFGHI"
} }

Response:

HTTP/1.1 200 OK

<TRX>
    <XID>4WDXFFPXAK123</XID>
    <MPY>CREDTRANS</MPY>
    <RES>
        <RCD>0</RCD>
        <MSG>Service succeeded</MSG>
        <STM>2013-08-20T10:21:45.346877Z</STM>
        <ETM>2013-08-20T10:21:45.347275Z</ETM>
    </RES>
</TRX>
HTTP/1.1 200 OK

{ "TRX" : {
      "XID" : "4WDXFFPXAK123",
      "MPY" : "CREDTRANS",
      "RES" : {
          "RCD" : 0,
          "MSG" : "Service succeeded",
          "STM" : "2013-08-20T10:21:45.346877Z",
          "ETM" : "2013-08-20T10:21:45.347275Z"
      }
} }

A credit transfer transaction is used to transfer funds from the merchant’s account to a customer’s account.

All credit transfer requests must be signed using an RSA private key, generated by the merchant, as part of a key pair with length 2048 bits and public exponent 65537 (0x10001). The public key, together with a corresponding key ID, must be provided to Acoustic Payments prior to using this service. The RSA public key should be provided in PEM format (a base64 representation of DER with ASCII armor). The key pair can be generated using OpenSSL or the Java standard keytool. The key ID must be provided as part of the request, identifying the public key to use for signature verification. The RSA key ID can be up to 20 characters long, and may contain alphanumeric characters as well as hyphen (“-”), underscore (“”), and dot (“.”). It is recommended that the ID includes a version number to easily identify keys over time, e.g. MYPUBLICKEY_V1.

This service is not supported by all payment processors, and requires special configuration in Acoustic Payments. Please contact your Acoustic Payments representative if you want to use this service.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value: CreditTransfer
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
PRJ
Mandatory
Project code
Alphanumeric, 1-10
Merchant’s account code with Acoustic
CTY
Mandatory
Country
ISO 3166-1 alpha-2
STO
Optional
Store code
Alphanumeric, 1-20
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the referenced transaction.
PRG
Optional
Profile group
Alphanumeric, 1-20
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet).
ORD
Optional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
TL0..9
Conditional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data.
TL3 is mandatory for certain processors. TL0-TL2 and TL4-TL9 are optional.
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
ATM
Optional
ATM routing?
Valid values: true, false. Default: false.
Flag indicating if the merchant supports processing of cards via ATM networks. If ATM is set to true, and the card can be processed as an ATM card, Acoustic Payments will route the request to the merchant’s ATM processor. If ATM is set to false, the card will always be processed via the credit card network, even though it may be eligible for ATM processing.
MDT
Optional
Maturity date
Date, yyyy-mm-dd
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: IVR, Webshop, SMS, MobileApp, SAP.
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
CUS
Optional
Customer
Complex, see Customer data.
BAC
Conditional
Bank account
Complex, see Bank account data.
Either BAC, CRD, PCD, XRF, or PRF is required.
CRD
Conditional
Card
Complex, see Card data.
Either BAC, CRD, PCD, XRF, or PRF is required.
PCD
Conditional
Private label card
Complex, see Private label card data.
Either BAC, CRD, PCD, XRF, or PRF is required.
EMV
Optional
Non-sensitive EMV data
UTF8, 1-999
This tag should not contain the EMV tags 5A, 57 or 5F24.
EMV tag 57 should be sent in TRX/CRD/TR2.
EMV tag 5A should be sent in TRX/CRD/PAN.
EMV tag 5F24 should be sent in TRX/CRD/EXP.
TER
Optional
Terminal data
Complex, see Terminal data.
CTT
Conditional
Credit transfer token
UTF8, 1-255
System generated value.
TSG
Conditional
Transaction signature
Complex, see Transaction signature data.
Either CTT or TSG is required.
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC.

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchant’s unique reference
MPY Payment method
Alphanumeric, 1-10
RES Result
Complex
RCD Return code
Integer, values: 0 to 99999, see Return codes.
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug-in generated data
DSM DPL screening response message
Alphanumeric, 1-2000
LLM Long error message
UTF8, 1-100
DTR Duplicate transaction reference
Alphanumeric, 13

Customer data

<CUS>
    <CID>1648463</CID>
    <CTP>Private</CTP>
    <FNM>John</FNM>
    <LNM>Smith</LNM>
    <AD1>72 Arrow Lake Rd</AD1>
    <CIT>Pine Grove</CIT>
    <ZIP>17963</ZIP>
    <STA>PA</STA>
    <CTY>US</CTY>
    <TEL>123-345-2066</TEL>
</CUS>
{ "CUS" : {
      "CID" : "1648463",
      "CTP" : "Private",
      "FNM" : "John",
      "LNM" : "Smith",
      "AD1" : "72 Arrow Lake Rd",
      "CIT" : "Pine Grove",
      "ZIP" : "17963",
      "STA" : "PA",
      "CTY" : "US",
      "TEL" : "123-345-2066"
} }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Mandatory
Customer type
Valid values: Private, Business
FNM
Optional
First name
UTF8, 1-100
Use first name and last name for CTP = Private
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
Use company name for CTP = Business
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Bank account data

<BAC>
    <ACN>12345678</ACN>
    <RTN>1234567</RTN>
</BAC>
{ "BAC" : {
      "ACN" : "12345678",
      "RTN" : "1234567"
} }
BAC Bank account
ACN
Conditional
Account number
Alphanumeric, 1-30
Either account number (ACN) or IBAN number (IBN) must be present.
RTN
Conditional
Routing number
Alphanumeric, 1-20
May be required depending on country. Please contact Acoustic Payments for more information.
IBN
Conditional
IBAN number
Alphanumeric, 15-34
Either account number (ACN) or IBAN number (IBN) must be present.
BIC
Optional
BIC number
Alphanumeric, 8-11
BNM
Optional
Bank name
UTF8, 1-30
BBN
Optional
Branch name
UTF8, 1-30
ATP
Conditional
Account type
Valid values: Checking, MoneyMarket, Savings
May be required depending on the merchant bank. Please contact Acoustic Payments for more information.

Card data

<CRD>
    <PAN>4111111111111111</PAN>
    <EXP>0718</EXP>
    <AHN>John Smith</AHN>
</CRD>
{ "CRD" : {
      "PAN" : "4111111111111111",
      "EXP" : "0718",
      "AHN" : "John Smith"
} }
CRD Card
PAN
Conditional
Card number
Numeric, 8-19
Either PAN or TKI is required. If both are present, PAN takes precedence.
For EMV transactions, the card number should be extracted from EMV tag 5A. For swiped transactions, the card number should be extracted from track data.
EXP
Mandatory
Expiration date
Numeric, MMYY, 4
For EMV transactions, expiration date should be extracted from EMV tag 5F24. For swiped transactions, the expiration date should be extracted from track data.
AHN
Optional
Account holder name
UTF8, 1-100
TR1
Optional
Track 1 data
UTF8, 1-79
TR2
Optional
Track 2 data
_UTF8, 1-40_For EMV transactions, track 2 data should be extracted from EMV tag 57.
TKI
Conditional
Token ID for the card
Alphanumeric, 1-100
Either PAN or TKI is required. If both are present, PAN takes precedence.
NXI
Optional
Network Transaction ID
Alphanumeric, 1-20
A unique value assigned by the card brand network, used to identify and link all related transactions for authorization and settlement.

Private label card data

<PCD>
    <MPY>GC-CERIDN</MPY>
    <PCN>1111222233334444555</PCN>
    <PCP>1234</PCP>
</PCD>
{ "PCD" : {
      "MPY" : "GC-CERIDN",
      "PCN" : "1111222233334444555",
      "PCP" : "1234"
} }
PCD Private label card
MPY
Mandatory
Payment method
Alphanumeric, 1-10
PCN
Mandatory
Private label card number
Alphanumeric, 1-40
PCP
Optional
Private label card PIN
Alphanumeric, 1-40

Terminal data

<TER>
     <TEI>8839625</TEI>
     <TSN>284239987</TSN>
     <DTY>Mx915P</DTY>
     <TEC>KeyEntry;MagneticStripe;EMVChip</TEC>
     <TEM>EMVChip</TEM>
     <PEC>WithPin</PEC>
     <LNE>0</LNE>
     <SNO>ECARS</SNO>
     <CNO>8</CNO>
</TER>
{ "TER" : {
      "TEI" : "8839625",
      "TSN" : "284239987",
      "DTY" : "Mx915P",
      "TEC" : "KeyEntry;MagneticStripe;EMVChip",
      "TEM" : "EMVChip",
      "PEC" : "WithPin",
      "LNE" : "0",
      "SNO" : "ECARS",
      "CNO" : "8"
} }
TER Terminal data
TEI
Mandatory
Terminal ID
Alphanumeric, 1-8
TSN
Mandatory
Terminal serial number
UTF8, 1-50
DTY
Mandatory
Terminal device type
UTF8, 1-30
TEC
Optional
Terminal entry capability
Valid values: KeyEntry, MagneticStripe, EMVChip, EMVContactless
Multiple values can be concatenated, separated by semicolon (“;”), e.g. KeyEntry;MagneticStripe;EMVChip;EMVContactless.
TEM
Mandatory
Terminal entry mode
Valid values: KeyEntry, MagneticStripe, EMVChip, EMVContactless, KeyEntryCNP, MSRContactless, EMVFallbackToMSR
PEC
Optional
PIN entry capability
Valid values: NoPin, WithPin
SNO
Optional
Store number
Alphanumeric+, 1-10
LNE
Optional
Lane
Alphanumeric+, 1-10
CNO
Optional
Cashier number
Alphanumeric+, 1-10

Transaction signature data

<TSG>
    <SGT>JtQoZhWszL...ysBH5Wqw==</SGT>
    <UTI>12345678</UTI>
    <KEY>MY_PUBLICKEY_V1</KEY>
</TSG>
{ "TSG" : {
      "SGT" : "JtQoZhWszL...ysBH5Wqw==",
      "UTI" : "12345678",
      "KEY" : "MY_PUBLICKEY_V1"
} }
TSG Transaction signature
SGT
Mandatory
Signature
Base64
The signature is generated by first creating a string containing the values of the elements SVC, XRF, CUR, GRS, and UTI. The values should be concatenated in the specified order, separated by semicolon (“;”). The resulting string is then signed using the merchant’s RSA private key. An example of the concatenated string is “CreditTransfer;SP2W7SX6ZC123;USD;550.00;12345678”. If XRF is not present, the field should be left empty as in “CreditTransfer;;USD;550.00;12345678”. Decimals must be provided for GRS field, even if the decimal part is zero.
The signature is generated according to the RSASSA-PKCS1-v1_5 standard - block type 01. The OpenSSL command “openssl dgst -sha256 -d -sign privateKey.pem -out signature.sign file.txt” can be used to generate such a signature. Here file.txt holds the string to sign, and the file signature.sign will contain the calculated signature (256 bytes of binary data).
UTI
Mandatory
Unique transaction identifier
UTF8, 1-40
Merchants must generate and provide a unique transaction identifier with each request. The unique transaction identifier is an important part of the transaction security, and merchants must ensure that the value provided is indeed unique to this request. There is no requirement wrt. the content or format of the unique transaction identifier.
KEY
Mandatory
Key
Alphanumeric+, 1-20
Merchant’s public key ID

DCC

DCC elements passed in the request will be not echoed back on response.

  <DCC>
    <BCC>HKD</BCC>
    <BAM>325.52</BAM>
    <RVF>2019-12-04T14:06:07.000000Z</RVF>
    <RVT>2019-12-05T03:56:00.000000Z</RVT>
    <CCR>9.30051</CCR>
    <MUP>3.5</MUP>
    <SRN>Elavon Merchant Services</SRN>
    <DRN>19120414067283</DRN>
  </DCC>
  {
    "DCC" : {
      "BCC" : "HKD",
      "BAM" : 325.52,
      "RVF" : "2019-12-04T14:06:07.000000Z",
      "RVT" : "2019-12-05T03:56:00.000000Z",
      "CCR" : 9.30051,
      "MUP" : 3.5,
      "SRN" : "Elavon Merchant Services",
      "DRN" : "19120414067283"
    }
  }
DCC Dynamic Currency Conversion
BAM
Mandatory
Billing Amount
Max 21 integer digits and 3 fractional digits, >=0
BCC
Mandatory
Billing Currency Code
ISO 4217 alpha-3
CCR
Mandatory
Currency Conversion Rate
Max 16 integer digits and 8 fractional digits, >=0
DRN
Mandatory
DCC Reference Number
UTF8, 1-14
MUP
Optional
Mark Up Percentage
Max 5 integer digits and 3 fractional digits, >=0
RVF
Optional
Rate Valid From timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
RVT
Mandatory
Rate Valid To timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
SRN
Optional
Source Name
UTF8, 1-100

PayPal transactions

Authorization

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com

      <TRX>
        <SVC>PayPalAuthorize2</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <XRF>H7MGB5JMX1123</XRF>
        <CUR>USD</CUR>
        <GRS>1100.00</GRS>
        <NET>1100.00</NET>
        <TAX>0.00</TAX>
      </TRX>

Sample response

      HTTP/1.1 200 OK

    <TRX>
        <XID>0ZBHRD7N1XTC6</XID>
        <RES>
            <RCD>0</RCD>
            <MSG>Service succeeded</MSG>
            <STM>2016-09-27T11:33:22.027534Z</STM>
            <ETM>2016-09-27T11:33:28.951800Z</ETM>
            <PPE>Ineligible</PPE>
            <PPR>authorization</PPR>
            <PPS>Pending</PPS>
            <PPT>None</PPT>
        </RES>
    </TRX>
Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json
      Accept: application/json

      {
         "TRX" : {
           "SVC" : "PayPalAuthorize2",
           "PRJ" : "EXAMPLE",
           "CTY" : "US",
           "XRF" : "H7MGB5JMX1123",
           "CUR" : "USD",
           "GRS" : 1100.00,
           "NET" : 1100.00,
           "TAX" : 0.00
         }
       }


Sample response

      HTTP/1.1 200 OK

{
  "TRX" : {
    "XID" : "0ZBHRD7N1X123",
    "RES" : {
      "RCD" : 0,
      "MSG" : "Service succeeded",
      "STM" : "2016-09-27T11:33:22.027534Z",
      "ETM" : "2016-09-27T11:33:28.951800Z",
      "PPE" : "Ineligible",
      "PPR" : "authorization",
      "PPS" : "Pending",
      "PPT" : "None"
    }
  }
}

The PayPalAuthorize2 service authorizes all of or a part of a previously reserved amount. PayPal can be set up to accept multiple authorizations. The PayPal authorization is valid for three days.

The PayPalAuthorize2 service is useful when the merchant is shipping goods, and therefore only a reservation of the funds is performed at ordering time. If in this case, the merchant has implemented a two step process for authorising the funds before shipment of the goods before a a capture of the funds is performed when the goods have been shipped, the PaypalAuthorize2 service is used to perform this authorization of the funds.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“PayPalAuthorize2”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
The XRF should be first authorisation transaction (This could also be a voice authorisation) that was approved. Any subsequent transaction following an incremental authorisation should also refer to the first authorisation transaction that was approved.
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Optional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Optional
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
PPS Payment Status at External provider
Alphanumeric+, 1-20
PPR Pending reason for payment at external provider
Alphanumeric+, 1-20
PAS Address status returned from external provider
Alphanumeric, 1-15
PPE Protection eligibility (by external provider)
Alphanumeric, 1-20
PPT Protection eligibility type (from external provider)
Alphanumeric, 1-20
LLM Long error message
UTF8, 1-100

Re-authorization

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com

      <TRX>
        <SVC>ReAuthorize</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>GB</CTY>
        <XRF>VRCQ7JJ1HK123</XRF>
        <CUR>GBP</CUR>
        <GRS>10.00</GRS>
        <NET>10.00</NET>
        <TAX>0.00</TAX>
      </TRX>

Sample response

      HTTP/1.1 200 OK

      <TRX>
         <XID>QQSVB9NRFR123</XID>
         <RES>
           <RCD>0</RCD>
           <MSG>Service succeeded</MSG>
           <STM>2017-01-04T08:29:12.614072Z</STM>
           <ETM>2017-01-04T08:29:17.315892Z</ETM>
           <PPE>Eligible</PPE>
           <PPR>authorization</PPR>
           <PPS>Pending</PPS>
           <PPT>ItemNotReceivedEligible,UnauthorizedPaymentEligible</PPT>
         </RES>
      </TRX>
Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json
      Accept: application/json

      {
        "TRX" : {
          "SVC" : "ReAuthorize",
          "PRJ" : "EXAMPLE",
          "CTY" : "GB",
          "XRF" : "VRCQ7JJ1HK123",
          "CUR" : "GBP",
          "GRS" : 10.00,
          "NET" : 10.00,
          "TAX" : 0.00
        }
      }


Sample response

      HTTP/1.1 200 OK

      {
        "TRX" : {
          "XID" : "QQSVB9NRFR123",
          "RES" : {
            "RCD" : 0,
            "MSG" : "Service succeeded",
            "STM" : "2017-01-04T08:29:12.614072Z",
            "ETM" : "2017-01-04T08:29:17.315892Z",
            "PPE" : "Eligible",
            "PPR" : "authorization",
            "PPS" : "Pending",
            "PPT" : "ItemNotReceivedEligible,UnauthorizedPaymentEligible"
          }
        }
      }

The ReAuthorize service can be used to cancel the existing PayPal authorization and create a new PayPal authorization, based on the existing PayPal order.

The ReAuthorize transaction must refer to the PayPal authorization that is to be cancelled.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“ReAuthorize”
XRF
Mandatory
Transaction reference
Alphanumeric, 13
Refers to a previous PayPal authorization. Input data provided for the current transaction will be enriched with data from the reference transaction.
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Optional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Optional
Country
ISO 3166-1 alpha-2
USR
Optional
User
UTF8, 1-255
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999, see Return Codes
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
PPS Payment Status at External provider
Alphanumeric+, 1-20
PPR Pending reason for payment at external provider
Alphanumeric+, 1-20
PAS Address status returned from external provider
Alphanumeric, 1-15
PPE Protection eligibility (by external provider)
Alphanumeric, 1-20
PPT Protection eligibility type (from external provider)
Alphanumeric, 1-20
LLM Long error message
UTF8, 1-100

Customer


    <CUS>
        <CID>1648463</CID>
        <CTP>Private</CTP>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
    </CUS>
    {
      "CUS" : {
        "CID" : "1648463",
        "CTP" : "Private",
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066"
      }
    }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: ‘Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Ship To

    <SHT>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
        <EMA>johnsmith@example.net</EMA>
    </SHT>
    {
      "SHT" : {
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "johnsmith@example.net"
      }
    }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

    <ITM>
        <ITN>91926493</ITN>
        <QTY>1</QTY>
        <UPR>14136.30</UPR>
        <NET>14136.30</NET>
        <TAX>0.00</TAX>
        <GRS>14136.30</GRS>
        <TXC>GOODS</TXC>
    </ITM>
    {
      "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 14136.30,
        "NET" : 14136.30,
        "TAX" : 0.00,
        "GRS" : 14136.30,
        "TXC" : "GOODS"
      }
    }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”

Token payment transactions

Authorization

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com

      <TRX>
        <SVC>TokenAuthorize</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <ORD>12345</ORD>
        <COM>Internet</COM>
        <CUR>USD</CUR>
        <NET>1000.00</NET>
        <TAX>100.00</TAX>
        <GRS>1100.00</GRS>
        <EXI>
          <EII>4761735194560010</EII>
          <MPY>ACI-CARD</MPY>
          <CBR>VISA</CBR>
          <EXP>0121</EXP>
        </EXI>
      </TRX>


Sample response

      HTTP/1.1 200 OK

      <TRX>
        <XID>H7MGB5JMX1123</XID>
        <MPY>ACI-CARD</MPY>
        <RES>
          <RCD>0</RCD>
          <MSG>Service succeeded</MSG>
          <STM>2010-10-04T12:02:39.222085Z</STM>
          <ETM>2010-10-04T12:02:40.243214Z</ETM>
          <PRC>ACI</PRC>
          <TEL>999999999</TEL>
          <BRC>000</BRC>
          <AVR>NOP</AVR>
          <ACQ>Acquirer</ACQ>
        </RES>
        <AUT>
          <MID>12345678</MID>
          <AUC>123456</AUC>
        </AUT>
      </TRX>

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json

      {
         "TRX" : {
           "SVC" : "TokenAuthorize",
           "PRJ" : "EXAMPLE",
           "CTY" : "US",
           "ORD" : "12345",
           "COM" : "Internet",
           "CUR" : "USD",
           "NET" : 1000.00,
           "TAX" : 100.00,
           "GRS" : 1100.00,
           "EXI" : {
             "EII" : "4761735194560010",
             "MPY" : "ACI-CARD",
             "CBR" : "VISA",
             "EXP" : "0121"
           }
         }
       }

Sample response

      HTTP/1.1 200 OK

      {
        "TRX" : {
          "XID" : "H7MGB5JMX1123",
          "MPY" : "ACI-CARD",
          "RES" : {
            "RCD" : 0,
            "MSG" : "Service succeeded",
            "STM" : "2010-10-04T12:02:39.222085Z",
            "ETM" : "2010-10-04T12:02:40.243214Z",
            "PRC" : "ACI",
            "TEL" : "999999999",
            "BRC" : "000",
            "AVR" : "NOP",
            "ACQ" : "Acquirer"
          },
          "AUT" : {
            "MID" : "12345678",
            "AUC" : "123456"
          }
        }
      }

A TokenAuthorize transaction is used to authorise a payment, using a token provided by an external provider.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“TokenAuthorize”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: ‘Internet’, 'Phone’
Mandatory if XRF is not specified.
UNS
Optional
Is Unscheduled?
Valid values: 'true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must not be present, or set to false.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must not be present, or set to false.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
ORD
Optional
Order number
Alphanumeric+, 1-20
ODT
Optional
Order date
yyyy-mm-dd
INV
Optional
Invoice number
Alphanumeric+, 1-20
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+,1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
EXI
Conditional
External instrument
Complex, see External instrument object
Required if neither profile data nor XRF are specified.
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3
CVR CVC response code
Alphanumeric, 1-3
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
AUT Authorization
Complex
MID Merchant ID
Alphanumeric+, 1-40
AUC Authorization code
Alphanumeric, 1-6
Approval code provided by external payment processor.

Authorization and capture

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com

      <TRX>
        <SVC>TokenAuthCap</SVC>
        <PRJ>EXAMPLE</PRJ>
        <CTY>US</CTY>
        <ORD>12345</ORD>
        <COM>Internet</COM>
        <CUR>USD</CUR>
        <NET>1000.00</NET>
        <TAX>100.00</TAX>
        <GRS>1100.00</GRS>
        <EXI>
          <EII>4761735194560010</EII>
          <MPY>ACI-CARD</MPY>
          <CBR>VISA</CBR>
          <EXP>0121</EXP>
        </EXI>
      </TRX>


Sample response

      HTTP/1.1 200 OK

      <TRX>
        <XID>H7MGB5JMX1123</XID>
        <MPY>ACI-CARD</MPY>
        <RES>
          <RCD>0</RCD>
          <MSG>Service succeeded</MSG>
          <STM>2010-10-04T12:02:39.222085Z</STM>
          <ETM>2010-10-04T12:02:40.243214Z</ETM>
          <PRC>ACI</PRC>
          <TEL>999999999</TEL>
          <BRC>000</BRC>
          <AVR>NOP</AVR>
          <ACQ>Acquirer</ACQ>
        </RES>
        <AUT>
          <MID>12345678</MID>
          <AUC>123456</AUC>
        </AUT>
      </TRX>

Sample request

      POST /trx HTTP/1.1
      Host: ips.payments.goacoustic.com
      Content-Type: application/json

      {
         "TRX" : {
           "SVC" : "TokenAuthCap",
           "PRJ" : "EXAMPLE",
           "CTY" : "US",
           "ORD" : "12345",
           "COM" : "Internet",
           "CUR" : "USD",
           "NET" : 1000.00,
           "TAX" : 100.00,
           "GRS" : 1100.00,
           "EXI" : {
             "EII" : "4761735194560010",
             "MPY" : "ACI-CARD",
             "CBR" : "VISA",
             "EXP" : "0121"
           }
         }
       }

Sample response

      HTTP/1.1 200 OK

      {
        "TRX" : {
          "XID" : "H7MGB5JMX1123",
          "MPY" : "ACI-CARD",
          "RES" : {
            "RCD" : 0,
            "MSG" : "Service succeeded",
            "STM" : "2010-10-04T12:02:39.222085Z",
            "ETM" : "2010-10-04T12:02:40.243214Z",
            "PRC" : "ACI",
            "TEL" : "999999999",
            "BRC" : "000",
            "AVR" : "NOP",
            "ACQ" : "Acquirer"
          },
          "AUT" : {
            "MID" : "12345678",
            "AUC" : "123456"
          }
        }
      }

A TokenAuthCap transaction is used to authorise and capture a payment, using a token provided by an external provider.

Request elements

TRX Transaction
SVC
Mandatory
Service, transaction type
Value:“TokenAuthCap”
XIE
Optional
External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
PRJ
Conditional
Project code
Alphanumeric, 1-10
The merchant’s account code with Acoustic.
Mandatory if XRF is not specified.
STO
Optional
Store code
Alphanumeric, 1-20
CTY
Conditional
Country
ISO 3166-1 alpha-2
Mandatory if XRF is not specified.
USR
Optional
User
UTF8, 1-255
XRF
Optional
Transaction reference
Alphanumeric, 13
Refers to a previous transaction. Input data provided for the current transaction will be enriched with data from the reference transaction.
PRF
Optional
Wallet reference
Alphanumeric+ (no blanks), 1-40
PRG
Optional
Profile group
Alphanumeric, 1-20
IRF
Optional
Instrument reference
Alphanumeric, 13
Refers to a specific payment instrument within a payment profile (wallet)
COM
Conditional
Consent medium
Valid values: 'Internet’, 'Phone’
Mandatory if XRF is not specified.
UNS
Optional
Is Unscheduled?
Valid values: 'true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for unscheduled billing. If UNS=true then REC must not be present, or set to false.
REC
Optional
Is Recurring?
Valid values: 'true’, 'false’, Default: 'false’
The element is is used to indicate whether credit card is/will be used as card on file for scheduled billing. If REC=true then UNS must not be present, or set to false.
ENR
Optional
Is Enrollment?
Valid values: 'true’, 'false’, Default: 'false’
The element is used to indicate that the transaction is made during enrollment in a recurring billing setup.
ORD
Conditional
Order number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
ODT
Optional
Order date
yyyy-mm-dd
INV
Conditional
Invoice number
Alphanumeric+, 1-20
At least one of ORD (order number) and INV (invoice number) is required.
IDT
Optional
Invoice date
yyyy-mm-dd
PNO
Optional
Payment number
Alphanumeric+, 1-30
Merchant’s payment reference.
COC
Optional
Cost center
Alphanumeric+,1-30
Input for P-Card transactions
CUC
Optional
Customer code
Alphanumeric+, 1-30
Input for P-Card transactions
CMR
Optional
Customer merchant reference
Alphanumeric, 1-10
TL0..9
Optional
Transaction label 0 to 9 (TL0 to TL9)
UTF8, 1-40
Merchant defined data
CUR
Mandatory
Currency
ISO 4217 alpha-3
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
CCM
Optional
Customer country must match?
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating if the card issuer country or bank account country must match the customer country. If the value of this element is 'true’, transactions will fail, if the customer country does not match the country of the payment instrument.
DAM
Optional
DPL screening approved by merchant
Valid values: 'true’, 'false’, Default: 'false’
MCM
Optional
Merchant country must match
Valid values: 'true’, 'false’, Default: 'false’
Flag indicating that the country where the credit card is issued, must match the Merchant country.
SHM
Optional
Shipping method
Valid values: 'Express’, 'Fast’, 'Ground’, 'Internet’
OSY
Optional
Originating system
Alphanumeric, 1-20
Value to be agreed with Acoustic Payments. Value can be included in the settlement reports upon agreement with Acoustic Payments
Example values: 'IVR’, 'Webshop’, 'SMS’, 'MobileApp’,'SAP’
OSS
Optional
Originating subsystem
Alphanumeric, 1-10
LTT
Optional
Local time of the transaction
DateTime, ISO 8601 UTC, 27
CUS
Optional
Customer
Complex, see Customer object
SHT
Optional
Ship To
Complex, see Ship to object
ITM
Optional
Item
Complex, see Item object
EXI
Conditional
External instrument
Complex, see External instrument object
Required if neither profile data nor XRF are specified.
DCC
Optional
Dynamic Currency Conversion
Complex, see DCC

Response elements

TRX Transaction
XID Transaction ID
Alphanumeric, 13
XIE External transaction ID
Alphanumeric+, 1-40
Merchants unique reference.
MPY Payment method
Alphanumeric, 1-10
RES Result
Complex
RCD Return code
Integer, Values: 0 to 99999
MSG Message
UTF8, 1-80
STM Start time
DateTime, ISO 8601 UTC, 27
ETM End time
DateTime, ISO 8601 UTC, 27
PRC Processor
Alphanumeric, 1-20
TEL Contact phone
UTF8, 1-30
BRC Bank response code
Alphanumeric, 1-3
CVR CVC response code
Alphanumeric, 1-3
Acoustic Payments’s unique CVC response code.
AVR AVS response code
Alphanumeric, 1-3
Acoustic Payments’s unique AVS response code.
ASA Can assume approval?
Values: 'true’, 'false’
RL0..9 Result label 0 to 9 (RL0 to RL9)
UTF8, 1-40
Merchant plug in generated data.
DSM DPL screening response message
Alphanumeric, 1-2000
ACQ Acquirer
UTF8, 1-100
LLM Long error message
UTF8, 1-100
AUT Authorization
Complex
MID Merchant ID
Alphanumeric+, 1-40
AUC Authorization code
Alphanumeric, 1-6
Approval code provided by external payment processor.

Customer


    <CUS>
        <CID>1648463</CID>
        <CTP>Private</CTP>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
    </CUS>
    {
      "CUS" : {
        "CID" : "1648463",
        "CTP" : "Private",
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066"
      }
    }
CUS Customer
CID
Optional
Merchant’s customer number
Alphanumeric+, 1-40
CTP
Optional
Customer type
Valid values: 'Private’, 'Business’
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Ship To

    <SHT>
        <FNM>John</FNM>
        <LNM>Smith</LNM>
        <AD1>72 Arrow Lake Rd</AD1>
        <CIT>Pine Grove</CIT>
        <ZIP>17963</ZIP>
        <STA>PA</STA>
        <CTY>US</CTY>
        <TEL>123-345-2066</TEL>
        <EMA>johnsmith@example.net</EMA>
    </SHT>
    {
      "SHT" : {
        "FNM" : "John",
        "LNM" : "Smith",
        "AD1" : "72 Arrow Lake Rd",
        "CIT" : "Pine Grove",
        "ZIP" : "17963",
        "STA" : "PA",
        "CTY" : "US",
        "TEL" : "123-345-2066",
        "EMA" : "johnsmith@example.net"
      }
    }
SHT Ship to
FNM
Optional
First name
UTF8, 1-100
LNM
Optional
Last name
UTF8, 1-100
CNM
Optional
Company name
UTF8, 1-100
AD1
Optional
Address line 1
UTF8, 1-50
AD2
Optional
Address line 2
UTF8, 1-50
AD3
Optional
Address line 3
UTF8, 1-50
AD4
Optional
Address line 4
UTF8, 1-50
CIT
Optional
City
UTF8, 1-50
ZIP
Optional
Zip code
UTF8, 1-20
STA
Optional
State
ISO 3166-2 alpha 3
CTY
Optional
Country
ISO 3166-1 alpha-2
TEL
Optional
Telephone
UTF8, 1-30
EMA
Optional
Email
UTF8, 5-254

Item

Items will only be enriched from the referenced transaction if (1) no items are supplied in the input, and (2) the transaction amounts are identical.

    <ITM>
        <ITN>91926493</ITN>
        <QTY>1</QTY>
        <UPR>14136.30</UPR>
        <NET>14136.30</NET>
        <TAX>0.00</TAX>
        <GRS>14136.30</GRS>
        <TXC>GOODS</TXC>
    </ITM>
    {
      "ITM" : {
        "ITN" : "91926493",
        "QTY" : 1,
        "UPR" : 14136.30,
        "NET" : 14136.30,
        "TAX" : 0.00,
        "GRS" : 14136.30,
        "TXC" : "GOODS"
      }
    }
ITM Item
ITN
Mandatory
Item number
Alphanumeric+, 1-20
DSC
Optional
Description
UTF8, 1-50
QTY
Mandatory
Quantity
Max 10 integer digits and 5 fractional digits, >=0
UPR
Mandatory
Unit price
Max 18 integer digits and 3 fractional digits, >=0
NET
Mandatory
Net amount
Max 18 integer digits and 3 fractional digits, >=0
TAX
Mandatory
Tax amount
Max 18 integer digits and 3 fractional digits, >=0
GRS
Mandatory
Gross amount
Max 18 integer digits and 3 fractional digits, >=0
TXC
Optional
Tax class
Alphanumeric, 1-10
Used for p-card transactions. Also used for Commodity code.
ITT
Optional
Item type
Values: “Shipping”, “Discount”, “Surcharge”

External instrument

    <EXI>
        <EII>4761735194560010</EII>
        <MPY>ACI-CARD</MPY>
        <CBR>VISA</CBR>
        <EXP>0121</EXP>
    </EXI>
    {
      "EXI" : {
        "EII" : "4761735194560010",
        "MPY" : "ACI-CARD",
        "CBR" : "VISA",
        "EXP" : "0121"
      }
    }
EXI External instrument
EII
Mandatory
External instrument Id (Token)
Alphanumeric+, 1-40
EXP
Conditional
Expiration date
Numeric, MMYY, 4
Mandatory if MPY='ACI-CARD’.
CBR
Conditional
Card brand
For values see Card brands
Mandatory if MPY='ACI-CARD’.
MPY
Mandatory
Payment method
Values: 'ACI-CARD’

DCC

DCC elements passed in the request will be not echoed back on response.

  <DCC>
    <BCC>HKD</BCC>
    <BAM>325.52</BAM>
    <RVF>2019-12-04T14:06:07.000000Z</RVF>
    <RVT>2019-12-05T03:56:00.000000Z</RVT>
    <CCR>9.30051</CCR>
    <MUP>3.5</MUP>
    <SRN>Elavon Merchant Services</SRN>
    <DRN>19120414067283</DRN>
  </DCC>
  {
    "DCC" : {
      "BCC" : "HKD",
      "BAM" : 325.52,
      "RVF" : "2019-12-04T14:06:07.000000Z",
      "RVT" : "2019-12-05T03:56:00.000000Z",
      "CCR" : 9.30051,
      "MUP" : 3.5,
      "SRN" : "Elavon Merchant Services",
      "DRN" : "19120414067283"
    }
  }
DCC Dynamic Currency Conversion
BAM
Mandatory
Billing Amount
Max 21 integer digits and 3 fractional digits, >=0
BCC
Mandatory
Billing Currency Code
ISO 4217 alpha-3
CCR
Mandatory
Currency Conversion Rate
Max 16 integer digits and 8 fractional digits, >=0
DRN
Mandatory
DCC Reference Number
UTF8, 1-14
MUP
Optional
Mark Up Percentage
Max 5 integer digits and 3 fractional digits, >=0
RVF
Optional
Rate Valid From timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
RVT
Mandatory
Rate Valid To timestamp
yyyy-mm-ddThh:mm:ss.nnnnnnZ
SRN
Optional
Source Name
UTF8, 1-100

General payment transactions

Authorization

Sample request with profile

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com

        <TRX>
          <SVC>Authorize</SVC>
          <PRJ>EXAMPLE</PRJ>
          <CTY>US</CTY>
          <ORD>12345</ORD>
          <COM>Internet</COM>
          <CUR>USD</CUR>
          <NET>1000.00</NET>
          <TAX>100.00</TAX>
          <GRS>1100.00</GRS>
          <PRF>SAMPLEWALLETID</PRF>
          <IRF>SAMPLEINSTRID</IRF>
        </TRX>

Sample request with credit card

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com

        <TRX>
          <SVC>Authorize</SVC>
          <PRJ>EXAMPLE</PRJ>
          <CTY>US</CTY>
          <ORD>12345</ORD>
          <COM>Internet</COM>
          <CUR>USD</CUR>
          <NET>1000.00</NET>
          <TAX>100.00</TAX>
          <GRS>1100.00</GRS>
          <CRD>
            <PAN>4000000000000002</PAN>
            <EXP>1218</EXP>
          </CRD>
          <VER>
            <CVC>123</CVC>
          </VER>
        </TRX>


Sample request with private label card

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com

        <TRX>
          <SVC>Authorize</SVC>
          <PRJ>EXAMPLE</PRJ>
          <CTY>US</CTY>
          <CUR>USD</CUR>
          <COM>Internet</COM>
          <GRS>150.00</GRS>
          <NET>150.00</NET>
          <TAX>0.00</TAX>
          <PCD>
            <MPY>GC-ACME</MPY>
            <PCN>1111222233334444555</PCN>
            <PCP>1234</GCP>
          </PCD>
        </TRX>


Sample request with external token

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com

        <TRX>
          <SVC>Authorize</SVC>
          <PRJ>EXAMPLE</PRJ>
          <CTY>US</CTY>
          <ORD>12345</ORD>
          <COM>Internet</COM>
          <CUR>USD</CUR>
          <NET>1000.00</NET>
          <TAX>100.00</TAX>
          <GRS>1100.00</GRS>
          <EXI>
            <EII>4761735194560010</EII>    
            <MPY>ACI-CARD</MPY>
            <CBR>VISA</CBR>
            <EXP>0121</EXP>
          </EXI>
        </TRX>


Sample request with ACH

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com

        <TRX>
          <SVC>Authorize</SVC>
          <PRJ>EXAMPLE</PRJ>
          <CTY>US</CTY>
          <ORD>12345</ORD>
          <COM>Internet</COM>
          <CUR>USD</CUR>
          <NET>1000.00</NET>
          <TAX>100.00</TAX>
          <GRS>1100.00</GRS>
          <CUS>
            <CTP>Private</CTP>
          </CUS>
          <BAC>
            <ACN>1234567890</ACN>
            <RTN>123123123</RTN>
          </BAC>
        </TRX>

Sample request with wallet

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com
        Content-Type: application/json
        Accept: application/json

        {
          "TRX" : {
            "SVC" : "Authorize",
            "PRJ" : "EXAMPLE",
            "CTY" : "US",
            "ORD" : "12345",
            "COM" : "Internet",
            "CUR" : "USD",
            "NET" : 1000.00,
            "TAX" : 100.00,
            "GRS" : 1100.00,
            "PRF" : "SAMPLEWALLETID",
            "IRF" : "SAMPLEINSTRID"
          }
        }

Sample request with credit card

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com
        Content-Type: application/json
        Accept: application/json

        {
          "TRX" : {
            "SVC" : "Authorize",
            "PRJ" : "EXAMPLE",
            "CTY" : "US",
            "ORD" : "12345",
            "COM" : "Internet",
            "CUR" : "USD",
            "NET" : 1000.00,
            "TAX" : 100.00,
            "GRS" : 1100.00,
            "CRD" : {
              "PAN" : "4000000000000002",
              "EXP" : "1218"
            },
            "VER" : {
              "CVC" : "123"
            }
          }
        }

Sample request with private label card

        POST /trx HTTP/1.1
        Host: ips.payments.goacoustic.com
        Content-Type: application/json
        Accept: application/json

        {
          "TRX" : {
            "SVC" : "Authorize",
            "PRJ" : "EXAMPLE",
            "CTY" : "US"