id

string
readonly

String value that uniquely identifies this invoice.

name

string

Name of the invoice (often an internal ID code from the merchant’s systems).
Maximum 80 characters long

amount

string

Amount to be paid.

currency

string

Currency for payment of the invoice, in ISO 4217 format (for example, USD).
Must be a valid ISO 4217 currency code with 3 characters

initiation_type

string

Represent the initiation type of the transaction which can be Customer Initiated Transaction (cit) or Merchant Initiated Transaction (mit).
Allowed values are:cit or mit

payment_intent

string

For Merchant Initiated Transactions: the type of payment flow that generated the transaction.
Allowed values are:one-off, recurring, recurring-standing-order, recurring-subscription, installment, unscheduled, unscheduled-delayed-charge, unscheduled-resubmission, unscheduled-no-show or unscheduled-reauthorization.

metadata

object

Metadata related to the invoice, in the form of key-value pairs (string - string).

sca_exemption_reason

string

Optional reason for requesting SCA exemption (Note: This must also be supported by the PSP. Please contact us for more information.)
Allowed values are:low-value, trusted-beneficiary or transaction-risk-analysis

challenge_indicator

string

Optional challenge indicator field when requesting 3DS2 (Note: This must also be supported by the PSP. Please contact us for more information.)
Allowed values are:no-preference, no-challenge-requested, challenge-requested, challenge-requested-mandate, no-challenge-requested-tra-performed, no-challenge-requested-data-share-only, no-challenge-requested-sca-performed, no-challenge-requested-whitelist-exemption, challenge-requested-whitelist-prompt or cb-scoring

payment_type

string

Optional information about the payment type
Allowed values aremoto or ecommerce

sandbox

boolean
readonly

Denotes whether or not this invoice was created in the sandbox testing environment.

statement_descriptor

string

Item that will be listed for this purchase on the customer’s bank statement.
Maximum 22 characters long, should only contain letters, numbers, spaces, dots and forward slashes

statement_descriptor_phone

string

Support phone number for this purchase on the customer’s bank statement.

statement_descriptor_city

string

City shown for this purchase on the customer’s bank statement.

statement_descriptor_company

string

Your company name to show on the customer’s bank statement.

statement_descriptor_url

string

Support URL for this purchase on the customer’s bank statement.

project_id (Expandable)

string
readonly

Project that the invoice belongs to.

customer_id (Expandable)

string

Customer linked to the invoice (generally the one making the purchase).
See Customers object

transaction_id (Expandable)

string
readonly

Transaction generated when the invoice is authorized or captured.
See Transaction object

token_id (Expandable)

string

Token that was used, or will be used, to capture the payment. If the invoice is linked to a customer (via the customer field) then this token must belong to them.
See Tokens object

details

[]object

Details of the items or products that are being purchased.
See Details object

risk

object

Risk assessment for the invoice.
See Risk object

device

object

Information about the device (web, mobile, other) that was used to start the purchase.
See Device object

external_fraud_tools

object

Information to forward to external fraud tools.
See ExternalFraudTools object

shipping

object

Shipping information for the invoice.
See Shipping object

return_url

string

For APMs, this is the URL to return to the app after payment is accepted.
Must be a valid URL

cancel_url

string

For APMs, this is the URL to return to the app after payment is canceled.
Must be a valid URL

webhook_url

string

Custom webhook URL for this purchase.
Must be a valid URL

incremental

string
readonly

Denotes whether or not you can apply incremental authorizations to this invoice.

tax

object

Tax information for the invoice.
See tax object

unsupported_feature_bypass

object

Bypass payment provider unsupported features set in the transaction

created_at

datetime
readonly

Date and time of when the invoice was created.

expires_at

datetime

Date and time of when the invoice will expire, when it will not be possible to initiate a new transaction on it.

payment_methods

[]object

Payment methods for Dynamic Checkout. Requires the expand=payment_methods query string parameter.
See Payment method object

id

string
readonly

String value that uniquely identifies this invoice detail.

name

string

Name of the item or product, which represents an item on a receipt.
Maximum 80 characters long

amount

string

Amount charged for this item or product.

tax_amount

string

Amount of taxes charged for this item or product.

type

string

Item or product type. Set this to anything suitable.
Maximum 30 characters long

quantity

integer

Quantity of the item or product. Default value is 1.

unit

string

Unit of measure used for product quantity.

category

string

Category of the item or product.
Can be food, entertainment, home, appliance, bidding, gift, technology, media, communication, health, sport, tickets, personal-service, professional-service, clothing, travel, transport or other.

reference

string

Reference of the item or product.
Maximum 255 characters long

description

string

Description of the item or product.
Maximum 255 characters long

brand

string

Brand of the item or product.
Maximum 80 characters long

model

string

Model of the item or product.
Maximum 80 characters long

discount_amount

string

Discount amount (when the discount is listed as a separate item on a receipt).

condition

string

Condition of the product.
Can be new, refurbished, used or other.

marketplace_merchant

string

Marketplace merchant ID of the item or product.

marketplace_merchant_is_business

boolean

Denotes whether or not the marketplace merchant is a business.

marketplace_merchant_created_at

datetime

Date and time when the merchant was created.

visa_commodity_code

string

Visa specific commodity code used for the item. Please refer to Visa for list of codes.

score

string

Scoring of the invoice. No validation done on this field because it is used to forward risk information to compatible payment providers.
Maximum 12 characters long

is_legit

boolean

Denotes whether or not the invoice is legitimate.

skip_gateway_rules

boolean

Flag to skip payment gateway fraud engine rules. (This is only available on certain compatible gateways. Contact us for more information.)

id

string

ID of the device. This can be anything but would usually be a UUID generated by a third-party anti-fraud solution.

channel

string

Channel used by the device.
Can be web, ios, android or other.

ip_address

string

IP address of the device.
Must be a valid IP address

amount

string

Amount charged for shipping.

duty_amount

string

Amount charged for import/export duties related to shipping.

method

string

Delivery method.
Can be web, collect-at-shop, relay, travel-station, home, shipping, locker or other.

provider

string

Delivery provider.
Maximum 32 characters long

delay

string

Shipment delay.
Can be express, priority, standard or other.

address1

string

First line of the delivery address.
Maximum 255 characters long

address2

string

Second line of the delivery address.
Maximum 255 characters long

state

string

State or county of the delivery address.
Maximum 80 characters long

city

string

City of the delivery address.
Maximum 80 characters long

country_code

string

Country code (US, FR…) of the delivery address.
Must be a valid ISO 3166 country code with 2 characters

zip

string

ZIP code of the delivery address.
Maximum 16 characters long

from_zip

string

ZIP code of the address from which delivery is shipped.
Maximum 16 characters long

phone

object

Phone number of the shipment recipient.

expects_shipping_at

datetime

Expected date of delivery.

relay_store_name

string

Name of the store that the order must be collected from.
Maximum 100 characters long

number

string

Phone number without the dialing code.
Maximum 14 characters long

dialing_code

string

International dialing code (Note: “+” will be treated as “00”)

merchant_id

string

Merchant identifier

country_code

string

Merchant country code
Must be a valid ISO 3166 country code with 2 characters

supported_networks

[]string

Card networks supported. e.g. american express. These values need to be mapped to the corresponding Apple Pay values

merchant_capabilities

[]string

Payment processing capabilities. Can be supports3DS, supportsCredit, supportsDebit and supportsEMV. These values need to be mapped to the corresponding Apple Pay values

allowed_auth_methods

[]string

Card transaction authentication methods. Can be PAN_ONLYand/or CRYPTOGRAM_3DS

allowed_card_networks

[]string

Card networks supported

allow_prepaid_cards

boolean

Whether prepaid cards are supported

allow_credit_cards

boolean

Whether credit card are supported

gateway

string

Gateway identifier issued by Google. Always processout

gateway_merchant_id

string

Gateway account identifier. Always the ProcessOut project identifier

country_code

string

Country where the transaction is processed. Required for transactions in European Economic Area (EEA).
Must be a valid ISO 3166 country code with 2 characters