This section describes how to use this guide and where to find further information.
Audience and Purpose
This guide is written for merchants who want to use the invoicing services. It describes tasks
that a merchant must complete in order to create, send, and manage invoices using the
invoicing API or Microsoft Outlook add-in. It also describes how to include extra
security to your invoices with payer authentication and how to set up automated
webhook notifications when an invoice is updated. It is intended to help the merchant
provide a seamless customer payment experience.
Convention
This special statement is used in this document:
IMPORTANT
An
Important
statement contains information essential to successfully completing a task or learning a concept.
Customer Support
For support information about any service, visit the Support Center:
VISA Platform Connect: Specifications and Conditions for
Resellers/Partners
The following are specifications and conditions that apply to a Reseller/Partner enabling
its merchants through
Visa Acceptance platform
. Failure to meet any of the specifications and conditions below is
subject to the liability provisions and indemnification obligations under
Reseller/Partner’s contract with Visa/Cybersource.
Before boarding merchants for payment processing on a VPC acquirer’s connection,
Reseller/Partner and the VPC acquirer must have a contract or other legal agreement
that permits Reseller/Partner to enable its merchants to process payments with the
acquirer through the dedicated VPC connection and/or traditional connection with
such VPC acquirer.
Reseller/Partner is responsible for boarding and enabling its merchants in
accordance with the terms of the contract or other legal agreement with the relevant
VPC acquirer.
Reseller/Partner acknowledges and agrees that all considerations and fees associated
with chargebacks, interchange downgrades, settlement issues, funding delays, and
other processing related activities are strictly between Reseller and the relevant
VPC acquirer.
Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is
responsible for payment processing issues, including but not limited to, transaction
declines by network/issuer, decline rates, and interchange qualification, as may be
agreed to or outlined in the contract or other legal agreement between
Reseller/Partner and such VPC acquirer.
DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR
OMISSIONS BY THE
Visa Platform Connect
ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA
NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR
ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE
RELEVANT
Visa Platform Connect
ACQUIRER.
Introduction to Invoicing
The Invoicing API enables you to create and send invoices as well as track outstanding
invoices. Your customers can pay using their preferred payment method from any device on
a secure
Visa Acceptance Solutions
hosted website. Automated reminders are available
to help you remind customers of upcoming due dates or overdue invoices. For more
information, see Invoicing API Requests.
You can also customize your invoice payment page to display your brand logo and color, as well
as add custom messages to your invoice emails. Shipping information and phone numbers
can also be collected at the time of payment. For more information, see Invoice Settings API Requests.
The Invoicing API uses
Visa Acceptance Solutions
's
Unified Checkout
to securely
process payments so that you do not have to handle confidential payment data. Fraud and
risk management tools are incorporated into
Unified Checkout
to prevent
fraud and reduce chargebacks. For additional security, you can add payer authentication
to your invoice payment processing. For more information, see Add Payer Authentication to Invoicing.
To quickly and easily create, send, and manage invoices from your Microsoft Outlook
desktop application,
Visa Acceptance Solutions
offers the Visa Invoicing Add-In. The
add-in can be downloaded and installed from Microsoft's AppSource. For more information,
see Add Invoicing Add-In to Outlook.
To receive notifications when an invoice is paid, sent, or
cancelled, you can create a subscription to receive invoicing webhook notifications. For
more information, see Webhook Notifications for Invoicing.
IMPORTANT
The merchant is responsible for complying with any legal
and tax requirements when issuing invoices to clients.
Visa Acceptance Solutions
does not certify that the invoicing tool meets any such client requirements.
Use the
Business Center
You can also create, process, and manage invoices using the
Business Center
. For
information about how to access and use invoicing in the
When creating an invoice, you can choose to create a draft or published invoice. If you
create a published invoice, you can specify whether the invoice is immediately emailed to the
customer or not. This table describes the different methods for creating an invoice.
Invoice Creation Methods
Invoice Method
Description
Field Values Specific to this Method
Create a Draft Invoice
Create an invoice draft that is only viewable by you. When you are ready to share
the invoice with the customer, you must publish it by sending a
Create a published invoice that you can share with the customer by sending the
customer the generated URL. This method gives you control over the distribution of
the invoices. For more information, see Create an Invoice without Sending it.
invoiceInformation.deliveryMode
Set to
none
.
invoiceInformation.sendImmediately
Set to
true
.
The invoicing API also enables you to perform these follow-on services after creating an invoice:
You can also customize your invoices to align with your brand. For more information, see
Invoice Settings API Requests.
Create a Draft Invoice
Drafting an invoice creates an unpublished invoice that is viewable only by you. When sending
the draft invoice request, set the
invoiceInformation.deliveryMode
field to
none
to ensure that the invoice draft is not automatically sent in an email
message to the customer when the invoice is published. When you are ready to publish the draft
invoice, you can send a
send invoice
request. After publishing the drafted invoice, the
invoice's status updates from
DRAFT
to
CREATED
.
Itemized Invoices
An invoice can display a single billed amount or list up to 30 billed
items. To list the billed items in the invoice, include the items in the request using the
line item array fields. An invoice with line items is known as an
request field. The invoice number is
required for follow-on API requests and tracking. You should store the invoice number in your
system so that you can optimally perform the follow-on requests. If you do not include a
unique invoice number when creating an invoice,
Visa Acceptance Solutions
generates a unique
invoice number for you in the
invoiceInformation.invoiceNumber
response
field.
IMPORTANT
You cannot update the invoice number after it is
generated.
Installment Payments
Invoices can be paid in installment payments when these fields and values are included in the
request. If an invoice is payable in installments, multiple customers can make payments
towards the same invoice.
Send an API POST request message to one of these endpoints:
Test:
POST
https://apitest.visaacceptance.com
/invoicing/v2/invoices
Production:
POST
https://api.visaacceptance.com
/invoicing/v2/invoices
Response to a Successful Request
A successfully drafted invoice is indicated by the
DRAFT
status in the
status
response field.
The redirect URL generated in the
invoiceInformation.paymentLink
response field is usable only by you and not the
customer.
Additional invoice details are included in the response message for you to review.
Follow-On API Requests
After successfully drafting an invoice, you can send these follow-on API requests.
Send an Invoice
After drafting an invoice, you can publish and send an invoice using the send
invoice request. For more information, see Send an Invoice.
Update an Invoice
To update customer information or item details in an already drafted invoice, send
an update invoice request. For more information, see Update an Invoice.
Cancel an Invoice
To cancel a drafted invoice, send the a cancel invoice request. For more
information, see Cancel an Invoice.
Get Invoice Details
To retrieve a drafted invoice's details, send a get invoice details request. For
more information, see Get Invoice Details.
Required Fields for Drafting an Invoice
This section lists the required fields necessary to create these types of
invoices:
In-person draft invoice
Email draft invoice
Itemized email draft invoice
The invoice created using these fields and specified values is not immediately sent
to the customer.
Required Fields for Drafting an In-Person Invoice
invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the
invoice is emailed to the customer when you send a send invoice request:
email
: An invoice email is sent to the customer
when you send the follow-on send invoice request for this
invoice draft. The invoice status updates to
SENT
.
none
: When you process a follow-on send invoice
request to publish the drafted invoice, the invoice is not sent
in an email to the customer. To share the invoice with the
customer, send the customer the redirect URL in the
invoiceInformation.paymentLink
response
field. The invoice updates change to
CREATED
.
invoiceInformation.description
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Drafting an Email Invoice
customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to
email
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Drafting an Invoice with Line Items
customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the
invoice will be emailed to the customer when you send a send invoice request:
email
: An invoice email is sent to the
customer when you send the follow-on send invoice request
for this invoice draft. The invoice status will change to
SENT
.
none
: When you process a follow-on send
invoice request to publish the drafted invoice, the invoice
is not sent in an email to the customer. To share the
invoice with the customer, send the customer the redirect
URL in the
invoiceInformation.paymentLink
response field. The invoice status will change to
CREATED
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productName
orderInformation.lineItems[].productSku
orderInformation.lineItems[].quantity
orderInformation.lineItems[].totalAmount
orderInformation.lineItems[].unitPrice
Optional Fields for Invoice Creation
You can include these optional fields when sending create invoice
requests:
clientReferenceInformation.partner.developerId
Set to your developer ID.
clientReferenceInformation.partner.solutionId
Set to your partner solution ID (PSID).
customerInformation.company.name
customerInformation.email
customerInformation.merchantCustomerId
customerInformation.name
invoiceInformation.allowPartialPayments
Set to one of these possible values:
false
: The invoice must be paid in a single
payment.
true
: The invoice is payable in
installments.
invoiceInformation.deliveryMode
invoiceInformation.description
This field becomes optional when either one of these conditions is met:
The line item fields are present in the request message.
When drafting a deliverable invoice, the
invoiceInformation.deliveryMode
request field
is set to
email
.
invoiceInformation.invoiceNumber
Set to a unique number to create an invoice number.
If you do not include this field and a unique value, the invoicing API
automatically generates an invoice number for the new invoice.
IMPORTANT
You cannot update this invoice number after
sending the API request.
Click this image to access the interactive code example for creating a invoice
draft.
Figure:
Interactive Code
Create a Deliverable Draft Invoice
Drafting an invoice creates an unpublished invoice that is viewable only by you. To draft an
invoice that will be delivered to the customer in an email message when you publish it, set
the
invoiceInformation.deliveryMode
request field to
email
. When you are ready to publish and share the invoice with a customer,
you can send the follow-on
send invoice
request. The customer will then receive an
email with the invoice and the invoice's status will update from
DRAFT
to
SENT
.
Itemized Invoices
An invoice can display a single billed amount or list up to 30 billed
items. To list the billed items in the invoice, include the items in the request using the
line item array fields. An invoice with line items is known as an
request field. The invoice number is
required for follow-on API requests and tracking. You should store the invoice number in your
system so that you can optimally perform the follow-on requests. If you do not include a
unique invoice number when creating an invoice,
Visa Acceptance Solutions
generates a unique
invoice number for you in the
invoiceInformation.invoiceNumber
response
field.
IMPORTANT
You cannot update the invoice number after it is
generated.
Installment Payments
Invoices can be paid in installment payments when these fields and values are included in the
request. If an invoice is payable in installments, multiple customers can make payments
towards the same invoice.
Send an API POST request message to one of these endpoints:
Test:
POST
https://apitest.visaacceptance.com
/invoicing/v2/invoices
Production:
POST
https://api.visaacceptance.com
/invoicing/v2/invoices
Response to a Successful Request
A successfully drafted invoice is indicated by the
DRAFT
status in the
status
response field.
The redirect URL generated in the
invoiceInformation.paymentLink
response field is usable only by you and not the
customer.
Additional invoice details are included in the response message for you to review.
Follow-On API Requests
After successfully drafting an invoice, you can send these follow-on API requests.
Send an Invoice
After drafting an invoice, you can publish and send an invoice using the send
invoice request. For more information, see Send an Invoice.
Update an Invoice
To update customer information or item details in an already drafted invoice, send
an update invoice request. For more information, see Update an Invoice.
Cancel an Invoice
To cancel a drafted invoice, send the a cancel invoice request. For more
information, see Cancel an Invoice.
Get Invoice Details
To retrieve a drafted invoice's details, send a get invoice details request. For
more information, see Get Invoice Details.
Required Fields for Drafting an Invoice
This section lists the required fields necessary to create these types of
invoices:
In-person draft invoice
Email draft invoice
Itemized email draft invoice
The invoice created using these fields and specified values is not immediately sent
to the customer.
Required Fields for Drafting an In-Person Invoice
invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the
invoice is emailed to the customer when you send a send invoice request:
email
: An invoice email is sent to the customer
when you send the follow-on send invoice request for this
invoice draft. The invoice status updates to
SENT
.
none
: When you process a follow-on send invoice
request to publish the drafted invoice, the invoice is not sent
in an email to the customer. To share the invoice with the
customer, send the customer the redirect URL in the
invoiceInformation.paymentLink
response
field. The invoice updates change to
CREATED
.
invoiceInformation.description
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Drafting an Email Invoice
customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to
email
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Drafting an Invoice with Line Items
customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to one of these possible values to determine whether or not the
invoice will be emailed to the customer when you send a send invoice request:
email
: An invoice email is sent to the
customer when you send the follow-on send invoice request
for this invoice draft. The invoice status will change to
SENT
.
none
: When you process a follow-on send
invoice request to publish the drafted invoice, the invoice
is not sent in an email to the customer. To share the
invoice with the customer, send the customer the redirect
URL in the
invoiceInformation.paymentLink
response field. The invoice status will change to
CREATED
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productName
orderInformation.lineItems[].productSku
orderInformation.lineItems[].quantity
orderInformation.lineItems[].totalAmount
orderInformation.lineItems[].unitPrice
Optional Fields for Invoice Creation
You can include these optional fields when sending create invoice
requests:
clientReferenceInformation.partner.developerId
Set to your developer ID.
clientReferenceInformation.partner.solutionId
Set to your partner solution ID (PSID).
customerInformation.company.name
customerInformation.email
customerInformation.merchantCustomerId
customerInformation.name
invoiceInformation.allowPartialPayments
Set to one of these possible values:
false
: The invoice must be paid in a single
payment.
true
: The invoice is payable in
installments.
invoiceInformation.deliveryMode
invoiceInformation.description
This field becomes optional when either one of these conditions is met:
The line item fields are present in the request message.
When drafting a deliverable invoice, the
invoiceInformation.deliveryMode
request field
is set to
email
.
invoiceInformation.invoiceNumber
Set to a unique number to create an invoice number.
If you do not include this field and a unique value, the invoicing API
automatically generates an invoice number for the new invoice.
IMPORTANT
You cannot update this invoice number after
sending the API request.
Click this image to access the interactive code example for creating a invoice
draft.
Figure:
Interactive Code
Create and Send an Invoice Immediately
Creating and sending an invoice publishes a payable invoice that is automatically emailed to
the customer. In addition to the sent email, you can also share the invoice by sending the
customer the redirect URL generated in the
invoiceInformation.paymentLink
response field.
Itemized Invoices
An invoice can display a single billed amount or list up to 30 billed
items. To list the billed items in the invoice, include the items in the request using the
line item array fields. An invoice with line items is known as an
request field. The invoice number is
required for follow-on API requests and tracking. You should store the invoice number in your
system so that you can optimally perform the follow-on requests. If you do not include a
unique invoice number when creating an invoice,
Visa Acceptance Solutions
generates a unique
invoice number for you in the
invoiceInformation.invoiceNumber
response
field.
IMPORTANT
You cannot update the invoice number after it is
generated.
Installment Payments
Invoices can be paid in installment payments when these fields and values are included in the
request. If an invoice is payable in installments, multiple customers can make payments
towards the same invoice.
REST Interactive Example: Create and Send an Invoice
Click this image to access the interactive code example for creating and sending a
new invoice.
Figure:
Interactive Code
Create an Invoice without Sending it
Creating a new invoice publishes a payable invoice. To share the created invoice with a
customer, send the customer the redirect URL generated in the
invoiceInformation.paymentLink
response field.
Itemized Invoices
An invoice can display a single billed amount or list up to 30 billed
items. To list the billed items in the invoice, include the items in the request using the
line item array fields. An invoice with line items is known as an
request field. The invoice number is
required for follow-on API requests and tracking. You should store the invoice number in your
system so that you can optimally perform the follow-on requests. If you do not include a
unique invoice number when creating an invoice,
Visa Acceptance Solutions
generates a unique
invoice number for you in the
invoiceInformation.invoiceNumber
response
field.
IMPORTANT
You cannot update the invoice number after it is
generated.
Installment Payments
Invoices can be paid in installment payments when these fields and values are included in the
request. If an invoice is payable in installments, multiple customers can make payments
towards the same invoice.
Send an API POST request message to one of these endpoints:
Test:
POST
https://apitest.visaacceptance.com
/invoicing/v2/invoices
Production:
POST
https://api.visaacceptance.com
/invoicing/v2/invoices
Successful Response
A successfully created invoice is indicated by the
CREATED
status in the
status
response field. The response message also includes the newly
created invoice's details for the new invoice.
Follow-On API Requests
After creating an invoice, you can send these follow-on API requests.
Send an Invoice
After creating an invoice, you can email the invoice to the customer using a send
invoice request. For more information, see Send an Invoice.
Update an Invoice
To update customer information or item details in an invoice, send an update invoice
request. For more information, see Update an Invoice.
Cancel an Invoice
To cancel an invoice, send a cancel invoice request. For more information, see Cancel an Invoice.
Get Invoice Details
You can retrieve an invoice's details by sending a get invoice details request. For
more information, see Get Invoice Details.
Get List of Invoices
After creating multiple invoices, you might want to search for certain invoices. To
retrieve a filtered list of invoices, send a get list of invoices request. For more
information, see Get a List of Invoices.
Required Fields for Creating an Invoice
This section lists the required fields necessary to create these types of
invoices:
In-person invoice
Email invoice
Itemized email invoice
The invoice created using these fields and specified values is not immediately sent
to the customer.
Required Fields for Creating an In-Person Invoice
invoiceInformation.deliveryMode
Set to
none
.
invoiceInformation.description
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
true
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Creating an Email Invoice
customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode
Set to
none
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately
Set to
true
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
Required Fields for Creating an Itemized Email Invoice
Click this image to access the interactive code example for creating a new
invoice.
Figure:
Interactive Code
Get a List of Invoices
You can retrieve a list of your invoices by sending a get invoice list request. To filter the
list results, you can add an optional string of query parameters to the endpoint. Filtering
list results can help you retrieve specific invoices faster.
You can filter invoices by:
Number of invoices retrieved
Order of invoices
Status
Endpoints
Send your API request to one of these endpoints:
Test:
GET
https://apitest.visaacceptance.com
/invoicing/v2/invoices
Production:
GET
https://api.visaacceptance.com
/invoicing/v2/invoices
Generate an Endpoint with Query Parameters
You can filter your search results by appending an optional string of query parameters to
the endpoint. A query parameter is also known as a
query-string
.
Begin each string with a question mark (
?
) to designate the start of the
query parameters, and include an ampersand (
&
) at the beginning of
each consecutive query parameter.
Use this format for appending a string of query parameters as name-value pairs:
?name1=value&name2=value&nameN=value
These are the query parameters to filter the retrieved list results:
Query Parameters
Query Parameter
Description
offset
The page offset number. This determines the order in which the
invoices are retrieved, beginning with the consecutive number
from the string value. For example, an offset of
3
results in a filtered list that begins
with the fourth listed invoice.
Set to a whole number.
limit
The maximum number of items being retrieved.
Set to a whole number.
status
The status of the invoice.
Set to one of these possible values:
CANCELED
CREATED
DRAFT
PAID
PARTIAL
PENDING
: The customer has initiated a
payment for an invoice that is in the
CREATED
,
SENT
, or
PARTIAL
status. The invoice can no
longer be edited, and the customer can no longer initiate an
payment in order to avoid a double payment. If the invoice
payment requires a fraud review, the invoice will remain in
the
PENDING
status until you approve or
reject it.
SENT
In this example, up to 100 draft invoices are retrieved beginning with the fourth listed
invoice:
Click this image to access the interactive code example for retrieving a list of
invoices.
Figure:
Interactive Code
Get Invoice Details
Retrieve an invoice's details to check its current status and payment history. Retrieving an
invoice's details requires the unique invoice number assigned when the invoice was
created.
If you need more information about the payment history, you can also use
the transaction details API. For more information, see the Transaction Details API section in the
Transaction Search and Details API Developer Guide
.
Endpoints
Send your API request to one of these endpoints:
Test:
GET https://
https://apitest.visaacceptance.com
/invoicing/v2/invoices/
{id}
Production:
GET https://
https://api.visaacceptance.com
/invoicing/v2/invoices/
{id}
The
{id}
is the invoice number from the invoice creation response
message.
Successful Response
A response contains this invoice information:
Response Fields to a Successful Request
Response Field
Description
submitTimeUtc
The date and time that the invoice was sent, in UTC format.
status
The invoice status. Possible values:
CANCELED
: The invoice is cancelled.
CREATED
: The invoice is created.
DRAFT
: The invoice is drafted and not published.
PAID
: The invoice is fully paid. The customer is notified
that the payment is successful.
PARTIAL
: The invoice is partially paid.
PENDING
: Fraud management is reviewing the invoice and you
must accept or reject the payment. The customer is also notified that the
payment is processing. When you accept the payment, the invoice updates to
the
PAID
status. If you reject the payment, the invoice
updates to the
SENT
status.
IMPORTANT
This status is only retrievable for merchants with
fraud management enabled.
SENT
: The invoice is delivered to the customer.
customerInformation
(field object)
The customer's information, such as name and email.
invoiceInformation
(field object)
The
paymentLink
field contains the direct URL to the
invoice.
orderInformation
(field object)
The itemized amount charged for the billed goods and services.
invoiceHistory
(field object)
An array of invoice status changes and the date and time stamp of each
invoice status changed.
Click this image to access the interactive code example for retrieving invoice
details.
Figure:
Interactive Code
Update an Invoice
You can update an invoice if no payment has been made. Include all of the fields that were
contained in the original request message in the update request. If you do not include a field
that was in the original request message, the field information associated with it will be
removed in the updated invoice.
If you update the customer's email in the
customerInformation.email
request field, the generated redirect URL in the
invoiceInformation.paymentLink
response field changes and the previous
URL becomes invalid. You can either share the new redirect URL with the customer, or resend
the updated invoice using the send invoice request. For more information about how to resend
an invoice, see Send an Invoice.
Itemized Invoices
An invoice can display a single billed amount or list up to 30 billed
items. To list the billed items in the invoice, include the items in the request using the
line item array fields. An invoice with line items is known as an
Invoices can be paid in installment payments when these fields and values are included in the
request. If an invoice is payable in installments, multiple customers can make payments
towards the same invoice.
Set to the minimum amount allowed for a partial payment.
Partner Information
If your merchant account is associated with a
Visa Acceptance Solutions
partner, you
can include your partner solution ID (PSID) in the request message for tracking and
reporting purposes. To include your PSID, use the
clientReferenceInformation.partner.solutionId
request field and set its field
value to your PSID.
Endpoints
Send your API request message to one of these endpoints:
Test:
PUT
https://apitest.visaacceptance.com
/invoicing/v2/invoices/
{id}
Production:
PUT
https://api.visaacceptance.com
/invoicing/v2/invoices/
{id}
The
{id}
is the invoice number from the response to the create
invoice request.
Required Fields for Updating an Invoice
Include these fields and any additional fields contained in the original request to
create the invoice.
invoiceInformation.description
This field becomes optional if the line item fields are present in the
request message.
invoiceInformation.dueDate
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productSku
Optional Fields for Updating an Invoice
Include all of the fields contained in the original request. If you do not include a
field that was in the original request, the field information associated with it is removed
in the updated invoice.
clientReferenceInformation.partner.solutionId
Set to your partner solution ID (PSID).
clientReferenceInformation.partner.developerId
Set to your developer ID.
customerInformation.company.name
customerInformation.email
customerInformation.merchantCustomerId
customerInformation.name
invoiceInformation.allowPartialPayments
invoiceInformation.deliveryMode
invoiceInformation.description
This field is optional when either of these conditions is met:
The
invoiceInformation.deliveryMode
request
field is set to
email
.
The line item fields are present in the request message.
invoiceInformation.invoiceNumber
Set to a unique number to create an invoice number.
If you do not include this field and a unique value, the invoicing API
automatically generates an invoice number for the new invoice.
IMPORTANT
You cannot update this invoice number after
sending the API request.
Click this image to access the interactive code example for updating an invoice.
Figure:
Interactive Code
Send an Invoice
You can send a published or drafted invoice that was not sent when it was initially created.
You can also resend an unpaid invoice or a partially paid invoice. Fully paid or canceled
invoices cannot be resent.
Endpoints
Send your API request message to one of these endpoints.
Test:
POST
https://apitest.visaacceptance.com
/invoicing/v2/invoices/
{id}
/delivery
Production:
POST
https://api.visaacceptance.com
/invoicing/v2/invoices/
{id}
/delivery
The
{id}
is the invoice number from the response to the create
invoice request.
Successful Response
A successful request is indicated by an updated submit time in the
submitTimeUtc
response field.
The invoice status in the
status
response field might update to a new
status depending on the field value that was set in the
invoiceInformation.deliveryMode
request field when the invoice was
initially created.
Use this table to determine how an invoice's status will change when you send or resend it.
The Initial Status column indicates the invoice's initial status, which was in the
status
response field. The Delivery Method column indicates whether or
not the customer was immediately emailed when the invoice was created, which was determined
by the
invoiceInformation.deliveryMode
field value. The Notification
Description column explains what happens to an invoice when you submit a send invoice
request, which is the result of the invoice's initial status and whether or not it was
emailed to the customer. The New Status column indicates the new status of the invoice after
you submit a send invoice request, which can be found in the
status
response field.
New Invoice Statuses
Initial Status
Delivery Method
Notification Description
New Status
DRAFT
email
An invoice email is sent to the customer.
SENT
DRAFT
none
The customer is
not
sent an invoice email. To share the newly created
invoice with the customer, send the customer the redirect URL generated in the
The Invoice Settings API enables you to customize your invoice checkout experience, add a
custom message to your email communications, and enable payer authentication. You can also
retrieve the invoice settings for your payment page.
Send your API request message to one of these endpoints:
Production:
PUT
https://api.visaacceptance.com
/invoicing/v2/invoiceSettings
Test:
PUT
https://apitest.visaacceptance.com
/invoicing/v2/invoiceSettings
Fields for Updating Invoice Settings
The update invoice settings request does not require a specific set of fields.
Instead, you can choose the fields to include in your request based on aspects of
your checkout experience, email communications, and payer authentication enablement.
Update Checkout Page Settings
Name
API Request Field
Description
Business Name
invoiceSettingsInformation.merchantDisplayName
The business name displayed on the invoice.
Currency
invoiceSettingsInformation.defaultCurrencyCode
The currency of the billed amount.
The currency code default value is set to
USD
when this field is not specified.
Only three-character ISO Standard Currency Codes are accepted.
Click this image to access the interactive code example for updating invoice settings.
Figure:
Update Invoice Settings in the Developer Center Sandbox
Add Payer Authentication to Invoicing
You can enable Payer Authentication in your invoices.
Payer Authentication, also known as 3-D Secure, helps to minimize costly fraudulent
transactions by adding an extra layer of protection to the payment process. The solution
enables issuers to authenticate the cardholder using various available methods, such as
one-time passwords and biometrics.
Invoicing supports these Payer Authentication services:
American Express SafeKey
JCB J/Secure
Mastercard Identity Check
Visa Secure
Card Types
Payer Authentication supports these card types:
American Express
Discover
JCB
Mastercard
Visa
Prerequisites for Payer Authentication
To sign-up and enable Payer Authentication, you must complete these tasks.
Follow these steps to install and set up the Visa Invoicing Add-In for Microsoft
Outlook if you already have a production
Visa Acceptance Solutions
account.
Go to the Microsoft AppSource.
Use the AppSource search field to find the
Visa Invoicing
add-in.
Click
Get it now
to download and install it.
If you are not already signed in to your Microsoft account, enter your account
credentials on the Sign in to Microsoft AppSource window, then click
Sign
in
.
Confirm or edit your details, and click
Get it now
.
A window opens asking if you would like to install Visa invoicing. Click
Continue
.
The Visa Invoicing Add-in installs on your Outlook desktop
application.
Open your Outlook desktop application and click the
Visa Invoicing
add-in.
On the Welcome page, click
Get started
.
On the next page, choose the
Production
or
Test
environment,
whichever your account is configured for, and then click
Sign in to Visa
Invoicing
.
On the sign-in page, enter your
Business Center
organization ID,
username, and password. Click
Sign in
.
Review the permissions disclosure, and click
Allow
to grant Microsoft
Outlook access to your
Business Center
account for invoicing
purposes.
When you log in to the Visa Invoicing add-in, the Dashboard opens. You can
choose from several tasks such as creating and managing invoices, managing
permissions, and signing out. Any invoices you already have are listed.
Set Up Add-In with New Account
Follow these steps to install and set up the Visa Invoicing Add-In for Microsoft
Outlook if you do not already have a
Visa Acceptance Solutions
account.
Go to the Microsoft AppSource.
Use the AppSource search field to find the
Visa Invoicing
add-in.
Click
Get it now
to download and install it.
If you are not already signed in to your Microsoft account, enter your account
credentials on the Sign in to Microsoft AppSource window, then click
Sign
in
.
Confirm or edit your details, and click
Get it now
.
A window opens asking if you would like to install Visa invoicing. Click
Continue
.
The Visa Invoicing Add-in installs on your Outlook desktop
application.
Open your Outlook desktop application and click the
Visa Invoicing
add-in.
On the Welcome page, click
Get started
.
Click
Create an account at Visa Invoicing
.
You are redirected to the Sign up for an account page.
On the Sign up for an account page, enter the information requested, check the
Terms and conditions
check box, and then click
Create
Account
.
Check your email account for a
Visa Acceptance Solutions
Account Creation
confirmation email message. The email will contain your account ID and your
organization ID. In the email, click
Set up your username and password
now
.
You are redirected to the account creation page.
On the New User Sign Up page, enter your Organization ID and Contact Email, and
then click
Submit
.
On the Create User Name page, enter your first name, last name, and username,
and then click
Next step
.
On the Create Password page, enter a password that conforms to the password
requirements, and then click
Create user
.
The Successfully Created User page opens, confirming that your account is
successfully created.
Open your Outlook desktop application and click the
Visa Invoicing
add-in.
On the Welcome page, click
Get started
.
Select
Test
environment and then click
Sign in to Visa
Invoicing
.
On the sign-in page, enter your
Business Center
organization ID,
username, and password. Click
Sign in
.
Review the permissions disclosure, and click
Allow
to grant Microsoft
Outlook access to your
Business Center
account for invoicing
purposes.
When you log in to the Visa Invoicing add-in, the Dashboard opens. You can
choose from several tasks such as creating and managing invoices, managing
permissions, and signing out. Any invoices you already have are listed.
When you are ready to activate your account for the production environment,
click
Go live
.
You are redirected to the
Visa Acceptance Solutions
Support Center.
Click
Sign in
.
You are redirected to the
Business Center
login page.
Enter your organization ID, username, and password. When done, click
Log
in
.
You are redirected to the
Visa Acceptance Solutions
Support Center
page.
At the top of the page, choose
Support Cases > MID Configuration
Request
.
On the MID configuration request page, click the
MID activation
button
to the right. Repeat for all other options that apply to you. When done, click
Submit
.
You have successfully submitted a request to create a production
account.
Create a Simple Invoice
A simple invoice is an invoice that displays a single amount for which your customer
is being billed. To send an itemized invoice instead, see Create an Itemized Invoice.
Follow these steps to create and send a simple invoice.
Open the Visa Invoicing add-in in your Microsoft Outlook desktop
application.
Click the
Create simple invoice
tab.
Enter the following field information:
Invoice Fields
Field
Description
Customer name
The customer's name or business name.
Customer email
The customer's email address or business email
address.
Invoice number
A unique number for identifying an invoice. This number
cannot change. It is also known as an
invoice
ID
.
Description
A description of the billed goods or service for the
invoice.
Amount
The amount billed to the customer in the invoice.
Invoice due date
The date by which the invoice must be paid.
Click
Insert invoice link
.
An invoice payment link is inserted into the email message body. If you are
using a
Business Center
test account, an additional test link is
inserted for you to test paying the invoice in the test environment.
Send the email message with the invoice link included in the message
body.
Create an Itemized Invoice
An itemized invoice lists each good and service for which your customer is being
billed. This helps your customer to know the cost of individual goods and services.
To send a simple invoice instead, see Create a Simple Invoice.
Follow these steps to create and send an itemized invoice.
Open the Visa Invoicing add-in in your Microsoft Outlook desktop
application.
Click the
Create list invoice
tab.
Enter the following field information:
Invoice Fields
Field
Description
Customer name*
The customer's name or business name.
Customer email*
The customer's email address or business email
address.
Invoice number*
A unique number for identifying an invoice. This number
cannot change. It is also known as an
invoice
ID
.
Description*
A description of the billed goods or service for the
invoice.
Invoice due date*
The date by which the invoice must be paid.
Item name*
The name of the listed good or service the customer is
being billed for.
Amount*
The billed amount for the listed good or service.
Quantity*
The number of goods or services listed in the
invoice.
Discount
The deducted amount from an itemized good or service
amount. Choose a
fixed amount or a
percentage amount for the
deducted amount.
Tax
The tax percentage amount to be added to the billed
amount.
Shipping
The fee amount for shipping the invoiced goods or
services.
Shipping Tax
The tax percentage amount to be added to the shipping
fee.
The asterisk (*) denotes that
the field information is required.
To add listed items, click
Add another item
and enter the field information.
When you are done entering all of the listed item information, click
Insert
invoice link
.
An invoice payment link is inserted into the email message body. If you are
using a
Business Center
test account, an additional test link is
inserted for you to test paying the invoice in the test environment.
Send the email message with the invoice link included in the message
body.
Manage Invoices
Follow these steps to view, track, and resend an invoice.
Open the Visa Invoicing add-in in your Microsoft Outlook desktop
application.
Click the
Dashboard
tab.
Use the
(sort) button to organize the list by invoice number, due date, or status.
Dashboard
Tracking and Billing Information
Description
Invoice no.
The unique invoice number used to identify and track and
an individual invoice.
Amount
The billed amount in the invoice.
Due date
The date by which the billed amount is owed.
Status
Indicates whether the invoice has been paid.
Possible values:
OVERDUE: The invoice is not paid, and the due
date is passed.
PAID: The invoice is paid.
UNPAID: The invoice has not been paid.
Click the invoice number of the invoice you want to view.
The Invoice page opens.
If the invoice is unpaid or overdue, you can resend it. Click
Insert invoice
link
.
An invoice payment link is inserted into the email message body.
Send the email message with the invoice link included in the message
body.
Revoke and Reconnect Outlook Permissions
Follow these steps to revoke Outlook's permission to access your
If it any time you want to grant Outlook permission to access your
invoicing information again, follow the above steps and click
Reconnect
instead of
Revoke
.
Sign Out
Follow these steps to sign out of the Visa Invoicing add-in.
Open the Visa Invoicing add-in in your Microsoft Outlook desktop
application.
Click
Tap
Tap
.
Click
Sign out
.
The Sign out window opens.
Click
OK
.
The Visa Invoicing add-in sign-in page displays.
Webhook Notifications for Invoicing
Webhooks are automated notifications generated by system events that occur in your
organization. You can create a webhook subscription for invoicing events to receive a
notification when an invoice is:
Cancelled
Five-day early reminder
Fully paid
Overdue reminder
Partially paid
Sent
You must have a URL for the webhook notifications to be sent to.
Notifications that contain sensitive, personally identifiable information (PII), such as
account numbers, are sent using message-level encryption. Transport Layer Security is
required in order to ensure data integrity.
There are additional requirements for implementing webhooks that are not
discussed in this guide. To create to webhook subscription to receive invoicing related
notifications, see the
field to one or more of the values listed
in the Event Type Field Value column in the table below. If you include multiple
event types in your request, separate each event type field value with the comma
character (
,
).
Invoicing Webhook Product ID and Event Types
Product ID
Event Type Field Value
Description
customerInvoicing
invoicing.customer.invoice.cancel
Merchants can subscribe to this event type to automate how
their system is informed when an invoice is cancelled.
invoicing.customer.invoice.overdue-reminder
Notifies you 1 day after the invoice payment is due.
This
event is triggered if you have invoice reminders enabled in
your invoice settings.
invoicing.customer.invoice.paid
Merchants can subscribe to this event type to automate how
their system is informed when an invoice is fully paid.
invoicing.customer.invoice.partial-payment
Merchants can subscribe to this event type to automate how
their system is informed when an invoice is partially
paid.
invoicing.customer.invoice.reminder
Notifies you 5 days before the invoice payment is due.
This event is triggered if you have invoice reminders
enabled in your invoice settings.
invoicing.customer.invoice.send
Merchants can subscribe to this event type to automate how
their system is informed when an invoice is sent to the
customer.
Example: Creating an Invoice Webhook Subscription
IMPORTANT
There are additional requirements for implementing webhooks that are not
discussed in this guide. To create to webhook subscription to receive invoicing related
notifications, see the
on the left navigation panel to access the Invoicing menu.
Enabling 3-D Secure for Invoices
3-D Secure helps to minimize costly fraudulent transactions by adding an extra layer
of protection to the payment process.
Follow these steps to enable 3-D Secure for your invoice transactions. You must have
Payer Authentication already enabled for your account. If you do not, or you do not
know, contact your
Enter the relevant information for these sections and their corresponding
fields:
ADDITIONAL INFORMATION
Profile Definition
Queue Selection
Fraud Score Threshold Rule Generator
In the Rules section, select only Accept and Reject rules, and enter any
relevant information into the
Priority
and
Execution Timing
fields.
When done, click
APPLY
. You can click
SAVE
instead if you do not
want the new profile to be immediately active.
The Profiles page appears.
In the Profile Selectors section, click
ADD SELECTOR RULE
.
The Rule Definition page appears.
In the Rule Definition section, enter this field information:
Rule Definition Fields and Values
Field
Definition
Name
The name of the profile selector rule.
Description
The description that explains the profile selector rule.
Profile
Choose the profile you created on the Profile Editor
page.
In the Rule Conditions section, choose these options:
Select
All conditions below are true
. By default, it should
already be selected.
Set Order Elements to
Connection Method
.
Set Comparison Operator to
is equal to
.
Set Comparison Values to
Custom Value
.
In the Custom Value(s) field, enter
Invoicing
.
When done, click
APPLY
. You can click
SAVE
instead if you do not
want the new profile selector to be immediately active.
RESULT
The new profile selector now appears as an active selector.
Approving Payment Flagged for Fraud
This section describes how to approve an invoice payment that is flagged for fraud.
When the customer completes an invoice payment, this message may display to them:
"Success. Your transaction is being processed. We will notify you when it is
completed."
This message indicates that the payment is flagged for fraud. The
customer must now wait until you accept or reject the payment using Decision Manager
in the
Business Center
. Until you accept or reject the payment, the customer
can no longer make the payment. If the customer reloads the payment screen, this
message displays: "Information: A payment is pending completion."
Follow these steps to approve a payment flagged for fraud:
In the Payment Processing section, use the Description drop-down menu
to choose
Enable with Settlement Selected
. This option enables
payments that you accept to automatically settle.
Rejecting Payment Flagged for Fraud
This section describes how to reject an invoice payment that is flagged for
fraud.
When the customer completes an invoice payment, this message may display to them:
"Success. Your transaction is being processed. We will notify you when it is
completed."
This message indicates that the payment is flagged for fraud. The
customer must now wait until you accept or reject the payment using Decision Manager
in the
Business Center
. Until you accept or reject the payment, the customer
can no longer make the payment. If the customer reloads the payment screen, this
message displays: "Information: A payment is pending completion."
Follow these steps to reject a payment flagged for fraud:
Click the order number of the pending invoice
payment.
A decision window appears.
To reject the flagged invoice payment, click
(reject).
After reviewing the comments and reason codes, click
Select
.
The successful rejection message displays.
(Optional) You can enable automatic settlement and reversals for accepted and
rejected payments. This expedites the review process, making a seamless review
experience.
The Search Results table displays only your invoice transactions.
(Optional) To verify that the transactions listed in the Search Results table
are invoicing transactions, click
Edit columns
.
The Edit Table Layout section appears.
Click
Add item
.
The Add Table Column page appears.
In the
Select Table Column
field, enter
Client
Application
or choose
Client Application
from the drop-down
menu, and then click
Save
.
The Edit Table Layout section appears.
Click
Save
.
The Search Results table appears with your filtered transactions and the
new Client Application column. Each entry in the Client Application column
should contain the Invoicing value, indicating that the transaction is an
invoice.
Generating a Report with Invoice Data
This task describes how to use the Reports feature in the
Business Center
to
generate a report that contains only your invoicing data.
Reports > Downloadable Reports > Available Reports
.
The Available Reports page appears.
Click the
Create custom report
.
The Create Report Subscription page appears.
In the Advanced Report Features section, click the Connection Method drop-down
menu and choose
Invoicing
.
There is additional required information you must enter before you can
generate a report.
When done, click
Create
.
The Report Subscription Management page appears.
Click the
Custom Report Subscriptions
tab to view your new custom
report that includes invoicing data.
Create a Custom Text Field for an Invoice
You can create a custom text field to display to your customers or merchants on your
invoice checkout page. This text field enables users to enter information in the
text field, or read a custom message. For example, you can give your customers the
option to enter any specifications for their order in the text field. Follow these
steps to create a custom text field.
The minimum number of characters the customer or merchant
must enter in the text field.
Max character limit
The maximum number of characters the customer or merchant
must enter in the text field.
Default text
The text that displays by default in the text
field.
Check the
Customer visible
box to make the text field viewable by the
customer.
You can check the
Customer Read Only
box to prevent the customer
from entering text in the text field. Choose this option if you want to display
a message to the customer.
Click
Add Field
when done.
RESULT
The new custom text field is listed under the Custom Fields tab, and its
corresponding drop-down menu appears in the invoice preview.
Creating New Custom Report Subscriptions
A recurring report subscription is a template that describes the attributes of a report, including how often it runs and the period of time it spans. After your recurring report is generated, it is available for download on the
page. You can maintain up to 20 report subscriptions at any time.
Name
: a unique name for the report. The name cannot be changed after a report is created.
Report type
: a set of reports that can be customized. The report type cannot be changed after a report is created.
Format
: the format of a generated report (XML or CSV).
Frequency
: the frequency at which a report runs: daily, weekly, or monthly.
Start time
: the time of day at which a report runs.
The process for creating a report subscription is the same as for creating a one-time report. The steps listed below focus on creating recurring subscriptions.
To create a report subscription:
On the left navigation pane, click the
Reports
icon.
Under Downloadable Reports, click
Report Subscription Management
. The
Report Subscription Management
page appears.
Click the
Custom Report Subscriptions
tab. The Custom Reports Subscriptions List appears.
Click
Create Subscription
. The Create Report Subscription page appears.
Under Account Setup, select whether to base the report on data from a specific merchant, or a group of merchants, and then choose an available value in the Merchants or Groups list.
ADDITIONAL INFORMATION
This option is only available for partners and account level users. To create a report that includes all merchants or groups, use the default value.
Under Basic Report Setup, enter the following:
In the
Report Name
field, enter the name for your report that best reflects the data you want to capture. Each report must have a unique name containing up to 250 characters.
In the
Report Type
field, select the type of
report that most closely represents the data or process you want to
include. The
Business Center
automatically includes the most
commonly used fields in your report based on this selection. See the
next step for more information on how to customize these values.
In the
File Format
field, choose whether the
Business Center
creates the report in XLS or XML
format.
In the
Frequency
field, choose
Recurring subscription
to automatically generates daily, weekly, or monthly reports. You can also create a One-time report.
To change any of the default fields included in your report, click the
Arrow
icon to expand the Advanced Report Features section, and then perform one or more of the following actions (available actions are based on the services you use):
In this field or tab
Do this
Credit Amounts
Check the box if you want credits to appear as negative amounts (for example: -1390.00)
Naming Convention
Select how you want the field names to appear in the report:
SOAPI
displays most field names in camel case (for example: FirstName)
SCMP
displays most field names with underscores (for example: first_name)
Application
Select one or more types of applications you want to include in the report.
Leave blank to include all types.
Connection Method
Select one or more connection methods used to perform the transaction that you want to include in the report.
Leave blank to include all types.
Available only for reports that include the Source field.
Payment Channel
Select one or more payment channels to include in the report. After
you make a selection, an information alert lists the payment report
field(s) associated with the selected payment
channels.
Leave blank to include all types.
Field Selection
One or more of the following:
Enter text matching a field name you want to find in the
Search
field.
Check the box for one or more fields or field types to include or remove from the report; check the
Select All
box to add or remove all fields.
Click the
^
in a section to expand or collapse it.
In the Selected column, click the
X
to remove a field or field type from the report
Field Ordering
To change the field order, click the up and down arrows or select a number in the
Order drop-down menu. You can add or remove fields by clicking the
plus and minus buttons.
This option is only available for CSV output.
When you are done, click
Create
. The Manage Report Subscription page appears, and the new subscription appears in the Custom Reports Subscriptions List.
Downloading Available Reports
The following types of downloadable reports are available in the
Business Center
,
depending on your reporting history and usage:
Standard Reports
: contains reports based on pre-defined report subscriptions.
Custom Reports
: contains reports that the user has created or customized using a pre-defined report.
Classic Reports
: contains new reports that have been configured for you based on your legacy subscriptions.
Third-Party Reports
: contains any files from a third-party, typically your payment processor.
Legacy Reports
: contains an archive of your legacy reports.
A tab may be empty if there are no reports in that category to display.
To download available reports:
Generating Custom Reports
The
Business Center
enables you to create your own reports based on the type of
data you want to track (for example, transaction requests or invoice summaries). When
you create a report subscription, the
Business Center
provides a set of fields
for you to choose from; you can also add and remove additional fields based on your
needs, and choose the order in which they appear and how they display in the report. You
can also set how often you want to generate the report (or if you want to just run it
once). Successfully generated reports appear in the
To create a custom report subscription, create a brand new
subscription, or save
an existing standard or custom report as a new report.
Saving Existing Reports as New Subscriptions
You can choose to save any existing custom report as a new one; this enables you
to copy over all the existing values, and change as much as you need to create a new
report with a new name.
To create a new report or subscription based on an
existing report:
On the left navigation pane, click the
Reports
icon.
Under Downloadable Reports, click
Report Subscription Management
. The
Report Subscription Management
page
appears.
Click the
Custom Report Subscriptions
tab. The Custom
Reports Subscriptions List appears.
Next to the report you want to copy, click the
Save As
(
) icon. The Save New
Subscription page appears.
Under Account Setup, select whether to base the report on data from a specific
merchant, or a group of merchants, and then choose an available value in the
Merchants or Groups list.
ADDITIONAL INFORMATION
To create a report that includes all merchants or groups, use
the default value.
Under Basic Report Setup, enter a unique name for the report.
You need a particular type of information only one time, so a recurring
subscription is unnecessary.
When you need past information that spans more than 31 days, you can create
multiple one-time reports. In order to protect system performance, each user is able
to generate up to three one-time reports concurrently. Additional one-time reports
can be scheduled after the first three reports complete.
After your one-time report is generated, it is available for download on the
page. Depending on the size of the report, it might take longer than 6
hours to generate.
The process for creating a report subscription is the same as for creating a one-time
report. The steps listed below focus on creating a one-time report; to follow steps
specifically for creating custom subscriptions, see Creating New Custom Report
Subscriptions
To generate a one-time report:
On the left navigation pane, click the
Reports
icon.
Under Downloadable Reports, click
Available Reports
. The
Available Reports
page appears.
On the Custom Reports tab, click
Create Report
. The Create Report Subscription page appears.
Under Account Setup, select whether to base the report on data from a specific merchant, or a group of merchants, and then choose an available value in the Merchants or Groups list.
ADDITIONAL INFORMATION
This option is only available for partners and account level users. To create a report that includes all merchants or groups, use the default value.
Under Basic Report Setup, enter the following:
In the
Report Name
field, enter the name for your report that best reflects the data you want to capture. Each report must have a unique name containing up to 250 characters.
In the
Report Type
field, select the type of
report that most closely represents the data or process you want to
include. The
Business Center
automatically includes the most
commonly used fields in your report based on this selection. See the
next step for more information on how to customize these values
In the
File Format
field, choose whether the
Business Center
creates the report in XLS or XML
format.
In the
Frequency
field, choose
One-time report
to create a single report
covering the date range (and time zone) you choose. You can also select
a Recurring subscription. For
information about supported time zones, see Supported Time Zones.
To change any of the default fields included in your report, click the
Arrow
icon to expand the Advanced Report Features section, and then perform one or more of the following actions (available actions are based on the services you use):
In this field or tab
Do this
Credit Amounts
Check the box if you want credits to appear as negative amounts (for example: -1390.00)
Naming Convention
Select how you want the field names to appear in the report:
SOAPI
displays most field names in camel case (for example: FirstName)
SCMP
displays most field names with underscores (for example: first_name)
Application
Select one or more types of applications you want to include in the report.
Leave blank to include all types.
Field Selection
One or more of the following:
Enter text matching a field name you want to find in the
Search
field
Check the box for one or more fields or field types to include or remove from the report; check the
Select All
box to add or remove all fields.
Click the
^
in a section to expand or collapse it.
In the Selected column, click the
X
to remove a field or field type from the report
Field Ordering
Click and hold the
Handle
icon to rearrange fields (in the
Selected
column on the Field Selection tab) into the order in which you want them to appear in the report.
This option is only available for CSV output.
When you are done, click
Create
. The Available Reports page appears, and the new report appears in the Custom Reports List.
Payment Method Fields
Fields in this group prepend the field name with “PaymentMethod:”
Field Name
Description
AccountSuffix
Last four digits of the customer’s payment account
number.
PaymentMethod. BankAccountName
Bank's account name.
PaymentMethod.BankCode
Bank's code. Used for some countries when you are not using the
IBAN. Contact
Visa Acceptance Solutions
customer support for required
country-specific bank account information.
BoletoBarCodeNumber
Numeric representation of the boleto barcode.
BoletoNumber
Boleto Bancário payment number.
CardCategory
Type of card used.
CardCategoryCode
Code for card type used.
CardType
Type of card to authorize.
CheckNumber
Check number.
ExpirationMonth
Two-digit month in which the credit card expires.
ExpirationYear
Four-digit year in which the credit card expires.
IssueNumber
Number of times a Maestro (UK Domestic) card has been issued to
the account holder.
MandateId
Identification reference for the direct debit
mandate.
MandateType
Type of mandate.
SignatureDate
Date of signature.
StartMonth
Month of the start of the Maestro (UK Domestic) card validity
period.
StartYear
Year of the start of the Maestro (UK Domestic) card validity
period.
WalletType
Type of wallet.
Supported Time Zones
This table lists the supported values for specifying a time zone. When using the
Business Center
, select the applicable time zone from the values listed in the
Business Center
column. When sending an API request, set the field to a
value listed in the API column.
Time Zones
Business Center
API
Africa/Cairo - (GMT+02:00) Eastern European Time
Africa/Cairo
Africa/Johannesburg - (GMT+02:00) South Africa Standard
Time
Africa/Johannesburg
Africa/Tripoli - (GMT+02:00) Eastern European Time
Africa/Tripoli
Africa/Tunis - (GMT+01:00) Central European Time
Africa/Tunis
America/Anchorage - (GMT-09:00) Alaska Standard Time
America/Anchorage
America/Bogota - (GMT-05:00) Colombia Time
America/Bogota
America/Buenos_Aires - (GMT-03:00) Argentine Time
America/Buenos_Aires
America/Chicago - (GMT-06:00) Central Standard Time
America/Chicago
America/Denver - (GMT-07:00) Mountain Standard Time
America/Denver
America/Edmonton - (GMT-07:00) Mountain Standard Time
America/Edmonton
America/Godthab - (GMT-03:00) Western Greenland Time
America/Godthab
America/Halifax - (GMT-04:00) Atlantic Standard Time
America/Halifax
America/Indianapolis - (GMT-05:00) Eastern Standard Time
America/Indianapolis
America/La_Paz - (GMT-04:00) Bolivia Time
America/La_Paz
America/Los_Angeles - (GMT-08:00) Pacific Standard Time
America/Los_Angeles
America/Mexico_City - (GMT-06:00) Central Standard Time
America/Mexico_City
America/New_York - (GMT-05:00) Eastern Standard Time
America/New_York
America/Noronha - (GMT-02:00) Fernando de Noronha Time
America/Noronha
America/Phoenix - (GMT-07:00) Mountain Standard Time
America/Phoenix
America/Sao_Paulo - (GMT-03:00) Brasilia Time
America/Sao_Paulo
America/St_Johns - (GMT-03:30) Newfoundland Standard Time
America/St_Johns
America/Vancouver - (GMT-08:00) Pacific Standard Time
America/Vancouver
America/Winnipeg - (GMT-06:00) Central Standard Time
America/Winnipeg
Asia/Baku - (GMT+04:00) Azerbaijan Time
Asia/Baku
Asia/Bangkok - (GMT+07:00) Indochina Time
Asia/Bangkok
Asia/Calcutta - (GMT+05:30) India Standard Time
Asia/Calcutta
Asia/Dacca - (GMT+06:00) Bangladesh Time
Asia/Dacca
Asia/Dubai - (GMT+04:00) Gulf Standard Time
Asia/Dubai
Asia/Hong_Kong - (GMT+08:00) Hong Kong Time
Asia/Hong_Kong
Asia/Jakarta - (GMT+07:00) West Indonesia Time
Asia/Jakarta
Asia/Jerusalem - (GMT+02:00) Israel Standard Time
Asia/Jerusalem
Asia/Katmandu - (GMT+05:45) Nepal Time
Asia/Katmandu
Asia/Kuala_Lumpur - (GMT+08:00) Malaysia Time
Asia/Kuala_Lumpur
Asia/Macao - (GMT+08:00) China Standard Time
Asia/Macao
Asia/Magadan - (GMT+11:00) Magadan Time
Asia/Magadan
Asia/Manila - (GMT+08:00) Philippines Time
Asia/Manila
Asia/Rangoon - (GMT +06:30) Myanmar Standard Time
Asia/Rangoon
Asia/Riyadh - (GMT+03:00) Arabia Standard Time
Asia/Riyadh
Asia/Saigon - (GMT+07:00) Indochina Time
Asia/Saigon
Asia/Seoul - (GMT+09:00) Korea Standard Time
Asia/Seoul
Asia/Shanghai - (GMT+08:00) China Standard Time
Asia/Shanghai
Asia/Singapore - (GMT+08:00) Singapore Time
Asia/Singapore
Asia/Taipei - (GMT+08:00) China Standard Time
Asia/Taipei
Asia/Tbilisi - (GMT+04:00) Georgia Time
Asia/Tbilisi
Asia/Tokyo - (GMT+09:00) Japan Standard Time
Asia/Tokyo
Asia/Yakutsk - (GMT+09:00) Yakutsk Time
Asia/Yakutsk
Atlantic/Cape_Verde - (GMT-01:00) Cape Verde Time
Atlantic/Cape_Verde
Australia/Adelaide - (GMT+09:30) Australian Central Standard
Time
Australia/Adelaide
Australia/Brisbane - (GMT+10:00) Australian Eastern Standard
Time
Australia/Brisbane
Australia/Broken_Hill - (GMT+09:30) Australian Central Standard
Time
Australia/Broken_Hill
Australia/Darwin - (GMT+09:30) Australian Central Standard
Time
Australia/Darwin
Australia/Eucla - (GMT+08:45) Australian Western Standard
Time
Australia/Eucla
Australia/Hobart - (GMT+10:00) Australian Eastern Standard
Time
Australia/Hobart
Australia/Lindeman - (GMT+10:00) Australian Eastern Standard
Time
Australia/Lindeman
Australia/Lord_Howe - (GMT+10:30) Lord Howe Standard Time
Australia/Lord_Howe
Australia/Melbourne - (GMT+10:00) Australian Eastern Standard
Time
Australia/Melbourne
Australia/Perth - (GMT+08:00) Australian Western Standard
Time
Australia/Perth
Australia/Sydney - (GMT+10:00) Australian Eastern Standard
Time
Australia/Sydney
Europe/Amsterdam - (GMT+01:00) Central European Time
Europe/Amsterdam
Europe/Athens - (GMT+02:00) Eastern European Time
Europe/Athens
Europe/Belgrade - (GMT+01:00) Central European Time
Europe/Belgrade
Europe/Berlin - (GMT+01:00) Central European Time
Europe/Berlin
Europe/Brussels - (GMT+01:00) Central European Time
Europe/Brussels
Europe/Bucharest - (GMT+02:00) Eastern European Time
Europe/Bucharest
Europe/Budapest - (GMT+01:00) Central European Time
Europe/Budapest
Europe/Copenhagen - (GMT+01:00) Central European Time
Europe/Copenhagen
Europe/Dublin - (GMT+00:00) Greenwich Mean Time
Europe/Dublin
Europe/Helsinki - (GMT+02:00) Eastern European Time
Europe/Helsinki
Europe/Istanbul - (GMT+02:00) Eastern European Time
Europe/Istanbul
Europe/Lisbon - (GMT+00:00) Western European Time
Europe/Lisbon
Europe/London - (GMT+00:00) Greenwich Mean Time
Europe/London
Europe/Madrid - (GMT+01:00) Central European Time
Europe/Madrid
Europe/Malta - (GMT+01:00) Central European Time
Europe/Malta
Europe/Minsk - (GMT+03:00) Moscow Standard Time
Europe/Minsk
Europe/Monaco - (GMT+01:00) Central European Time
Europe/Monaco
Europe/Moscow - (GMT+03:00) Moscow Standard Time
Europe/Moscow
Europe/Oslo - (GMT+01:00) Central European Time
Europe/Oslo
Europe/Paris - (GMT+01:00) Central European Time
Europe/Paris
Europe/Prague - (GMT+01:00) Central European Time
Europe/Prague
Europe/Riga - (GMT+02:00) Eastern European Time
Europe/Riga
Europe/Rome - (GMT+01:00) Central European Time
Europe/Rome
Europe/Stockholm - (GMT+01:00) Central European Time
Europe/Stockholm
Europe/Vienna - (GMT+01:00) Central European Time
Europe/Vienna
Europe/Warsaw - (GMT+01:00) Central European Time
Europe/Warsaw
Europe/Zurich - (GMT+01:00) Central European Time
Europe/Zurich
GMT - (GMT+00:00) Greenwich Mean Time
GMT
Pacific/Auckland - (GMT+12:00) New Zealand Standard Time
Pacific/Auckland
Pacific/Honolulu - (GMT-10:00) Hawaii Standard Time
Pacific/Honolulu
Pacific/Norfolk - (GMT+11:00) Norfolk Time
Pacific/Norfolk
Pacific/Pago_Pago - (GMT-11:00) Samoa Standard Time
Pacific/Pago_Pag
Creating New Custom Report Subscriptions
A recurring report subscription is a template that describes the attributes of a
report, including how often it runs and the period of time it spans. After your
recurring report is generated, it is available for download on the
page. You can maintain up to 20 report subscriptions
at any time.
Name
: a unique name for the report. The name cannot be changed after a
report is created.
Report type
: a set of reports that can be customized. The report type
cannot be changed after a report is created.
Format
: the format of a generated report (XML or CSV).
Frequency
: the frequency at which a report runs: daily, weekly, or
monthly.
Start time
: the time of day at which a report runs.
The process for creating a report subscription is the same as for creating a one-time
report. The steps listed below focus on creating recurring subscriptions.
To create a report subscription:
On the left navigation pane, click the
Reports
icon.
Under Downloadable Reports, click
Report Subscription Management
. The
Report Subscription Management
page
appears.
Click the
Custom Report Subscriptions
tab. The Custom
Reports Subscriptions List appears.
Click
Create Subscription
. The Create Report
Subscription page appears.
Under Account Setup, select whether to base the report on data from a specific
merchant, or a group of merchants, and then choose an available value in the
Merchants or Groups list.
ADDITIONAL INFORMATION
This option is only available for partners and account level users. To
create a report that includes all merchants or groups, use the default
value.
Under Basic Report Setup, enter the following:
In the
Report Name
field, enter the name for
your report that best reflects the data you want to capture. Each report
must have a unique name containing up to 250 characters.
In the
Report Type
field, select the type of
report that most closely represents the data or process you want to
include. The
Business Center
automatically includes the most
commonly used fields in your report based on this selection. See the
next step for more information on how to customize these values.
In the
File Format
field, choose whether the
Business Center
creates the report in XLS or XML
format.
In the
Frequency
field, choose
Recurring subscription
to automatically
generates daily, weekly, or monthly reports. You can also create a One-time report.
To change any of the default fields included in your report, click the Arrow
(
) icon to expand the
Advanced Report Features section, and then perform one or more of the following
actions (available actions are based on the services you use):
In the
Credit Amounts
field, check the box if
you want credits to appear as negative amounts (for example:
-1390.00)
In the
Naming Convention
field, select how you
want the field names to appear in the report:
SOAPI
displays most
field names in camel case (for example: FirstName);
SCMP
displays
most field names with underscores (for example: first_name).
In the
Field Selection
field, enter text
matching a field name you want to find in the
Search
field, check the box for one or more
fields or field types to include or remove from the report; check the
Select All
box to add or remove all fields.
(Click the
^
in a section to expand or collapse it.); and/or in
the
Selected
column, click the
X
to remove
a field or field type from the report
In the
Field Ordering
field, click and hold the
Handle
icon to rearrange fields (in the
Selected
column on the Field Selection tab)
into the order in which you want them to appear in the report
When you are done, click
Create
. The Manage Report
Subscription page appears, and the new subscription appears in the Custom
Reports Subscriptions List.
Invoicing > Manage Invoices.
Settings.
The Visa Invoicing Add-in installs on your Outlook desktop application.
When you log in to the Visa Invoicing add-in, the Dashboard opens. You can choose from several tasks such as creating and managing invoices, managing permissions, and signing out. Any invoices you already have are listed.
You are redirected to the account creation page.
The Successfully Created User page opens, confirming that your account is successfully created.
You are redirected to theVisa Acceptance SolutionsSupport Center.
You are redirected to theBusiness Centerlogin page.
You are redirected to theVisa Acceptance SolutionsSupport Center page.
You have successfully submitted a request to create a production account.
An invoice payment link is inserted into the email message body. If you are using aBusiness Centertest account, an additional test link is inserted for you to test paying the invoice in the test environment.
fixed amount or a
percentage amount for the
deducted amount.TaxThe tax percentage amount to be added to the billed amount.ShippingThe fee amount for shipping the invoiced goods or services.Shipping TaxThe tax percentage amount to be added to the shipping fee.The asterisk (*) denotes that the field information is required.
Add another itemand enter the field information.
An invoice payment link is inserted into the email message body. If you are using aBusiness Centertest account, an additional test link is inserted for you to test paying the invoice in the test environment.
(sort) button to organize the list by invoice number, due date, or status.
DashboardTracking and Billing InformationDescriptionInvoice no.
An invoice payment link is inserted into the email message body.
Tap
Tap.
.Decision Manager> Configuration > ProfilesThe Profiles page appears.
(approve).
(reject).
Transaction Management>Transactions.The Transaction page appears.
Reports > Downloadable Reports > Available Reports.The Available Reports page appears.
) icon. The Save New
Subscription page appears.
) icon to expand the
Advanced Report Features section, and then perform one or more of the following
actions (available actions are based on the services you use):