On This Page

Create an Amount Only Invoice

Create an amount only invoice to send to a customer without listing each line item. An amount only invoice includes the total amount for the invoice as well as branding, checkout, email, security, and custom label settings. An existing invoice cannot be changed into an amount only invoice, but you can cancel the invoice and create a new one.

Invoice Numbers: You can assign a unique invoice number in the
invoiceInformation.invoiceNumber
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, Barclays generates a unique invoice number for you in the
invoiceInformation.invoiceNumber
response field.
IMPORTANT

You cannot update the invoice number after it is generated.
Partner Information: If your merchant account is associated with a Barclays 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.

Endpoint

Send an API POST request message to one of these endpoints:

Test:

POST https://api.smartpayfuse-test.barclaycard/invoicing/v2/invoices

Production:

POST https://api.smartpayfuse.barclaycard/invoicing/v2/invoices

Response to a Successful Request

A successfully drafted invoice is indicated by the 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 Amount Only Invoice

This section lists the required fields necessary to create an amount only invoice.

The invoice created using these fields and specified values is not immediately sent to the customer.

Required Fields for Drafting an Email Invoice

customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode: Set to
email
when drafting a deliverable invoice.
invoiceInformation.description: This field becomes optional when line item fields are present in the request message.
invoiceInformation.dueDate
invoiceInformation.sendImmediately: Set to
false
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

Optional Fields for Amount Only Invoice Creation

You can include these optional fields when sending amount only invoice requests:

clientReferenceInformation.partner.developerId: Set to your developer ID.
clientReferenceInformation.partner.solutionId: Set to your partner solution ID (PSID).
customerInformation.company.name
customerInformation.merchantCustomerId
customerInformation.name
invoiceInformation.deliveryMode
invoiceInformation.expirationDate: Set to the expiration date. Format:
DD-MM-YYYY
.; The invoice expires on this date at 00:00 GMT.
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.
merchantDefinedFieldValues.definition.id[].value
orderInformation.amountDetails.subAmount

Example: Drafting an Amount Only Invoice

Request

{ 
  "clientReferenceInformation": { 
    "partner": { 
      "developerId": "3435", 
      "solutionId": "83745" 
    } 
  }, 
  "customerInformation": { 
    "name": "Tanya Lee", 
    "email": "tanya.lee@my-email.world" 
  }, 
  "processingInformation": { 
    "requestPhone": false, 
    "requestShipping": false 
  }, 
  "invoiceInformation": { 
    "description": "This is a test invoice", 
    "dueDate": "2019-07-11", 
    "expirationDate": "2028-08-11", 
    "sendImmediately": true, 
    "deliveryMode": "email" 
  }, 
  "orderInformation": { 
    "amountDetails": { 
      "totalAmount": "2623.64", 
      "currency": "USD", 
      "subAmount": "2749.72" 
    } 
  } 
}

Response to a Successful Request

{ 
  "_links": { 
    "self": { 
      "href": "/v2/invoices/15", 
      "method": "GET" 
    }, 
    "update": { 
      "href": "/v2/invoices/15", 
      "method": "PUT" 
    }, 
    "deliver": { 
      "href": "/v2/invoices/15/delivery", 
      "method": "POST" 
    }, 
    "cancel": { 
      "href": "/v2/invoices/15/cancelation", 
      "method": "POST" 
    } 
  }, 
  "id": "15", 
  "submitTimeUtc": "2026-04-02T13:11:12.109758358Z", 
  "status": "SENT", 
  "customerInformation": { 
    "name": "Tanya Lee", 
    "email": "tanya.lee@my-email.world" 
  }, 
  "processingInformation": { 
    "requestPhone": false, 
    "requestShipping": false 
  }, 
  "invoiceInformation": { 
    "invoiceNumber": "15", 
    "description": "This is a test invoice", 
    "dueDate": "2019-07-11", 
    "expirationDate": "2028-08-11", 
    "paymentLink": "https://ebc2test.cybersource.com/ebc2/invoicing/payInvoice/1vkESfV2lLy8M2qkDFH0aUYZUOTasbrkOZvXf9ShjW3VJKVxvkLw2OUzMp1bihov?version=v2.1", 
    "deliveryMode": "Email", 
    "customLabels": [ 
      { 
        "key": "billTo", 
        "value": "Payee name" 
      } 
    ] 
  }, 
  "orderInformation": { 
    "amountDetails": { 
      "totalAmount": 2623.64, 
      "currency": "USD", 
      "balanceAmount": 2623.64, 
      "subAmount": 2749.72 
    } 
  } 
}