PaymentResponse
Successful response with one Payment
Always 0 in a successful response
0Always null in a successful response
data objectrequired
Payment of one or more orders, with the data of the payment provider
Name of the payment method, in Italian, for example Carta di credito or Bonifico Bancario
Unique code of the payment: SR followed by letters and digits, to write in the reason of a bank transfer
amount_total objectrequired
Amount in euros, without the VAT details of Amount
Amount, in euros
Currency code: always EUR
amount_payed objectrequired
Amount in euros, without the VAT details of Amount
Amount, in euros
Currency code: always EUR
When the payment was made (the latest paid attempt); null when nothing has been paid
Whether the payment is complete: amount_payed reaches amount_total
prepaid_credit_operations object[]required
Uses of the prepaid credit made by the payment; empty unless the payment is with the prepaid credit
Id of the payment with the credit (REDEMPTION) that the operation cancels, for REDEMPTION_CANCELLATION (GET /api/v3/prepaid-credit/operations/{operation_id}); null for the other types
prepaid_credit_topup objectrequired
Top-up whose credit the operation adds or uses
invoice objectrequired
Deposit invoice of the top-up; null until it is issued
- Invoice
- null
billing objectrequired
Billing profile: the holder the documents are made out to, with its tax and electronic invoicing data
legal_entity objectrequired
Legal form of the holder of a billing profile, with its group
legal_entity_group objectrequired
Group of legal forms, such as private individuals or Italian companies
Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER
Name of the group, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Code of the legal form: ITA_PVT, NOITA_PVT, ITA_INDIVIDUALE, ITA_CAPITALI, ITA_PERSONE, ITA_ASSNOCOMM, ITA_ASSCOMM, ITA_ALTRO, ITA_PA, EU_ALTRO, NOEU_ALTRO, VATICAN_NOPVT, SANMARINO_NOPVT or FORBIDDEN_NOITA_NOPVT
Name of the legal form, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Province: the acronym of the Italian province, for example VI, or EE outside Italy
country objectrequired
ie. IT
ie. ITA
Name of the country in Italian; the local name when there is no translation
Name of the country in its own language, for example Deutschland
International calling code, without +, for example 39
Continent, in English, for example Europe or North America
Area of the country: EU (European Union) or EXTRAEU
Gender of the holder: M or F; null when not given
Date of birth of the holder; null when not given
Place of birth of the holder; null when not given
Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given
VAT number of the holder (partita IVA in Italy); null when it has none
Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code
Tax code of the holder (codice fiscale in Italy)
PEC address (certified email, Posta Elettronica Certificata) to which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices when there is no recipient code; null when not given
Recipient code (Codice Destinatario) with which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices: 7 characters, 6 for the public administration; null when not given
Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given
Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given
Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given
Whether split payment (scissione dei pagamenti) applies: the tax regime is SPLIT_PAYMENT, and the customer pays the VAT of the invoices directly to the Italian State
Type of the invoice: NORMAL, DEPOSIT (top-up of the prepaid credit) or BALANCE (paid with the prepaid credit: some rows deduct the deposit invoices)
sdi_document_status objectrequired
Status of the invoice on SDI, the Italian e-invoicing exchange system; null for the invoices not sent through SDI, issued before electronic invoicing
- SdiDocumentStatus
- null
One of TO_SIGN, TO_SEND, SENT, DELIVERED, NOT_DELIVERED or DISCARDED (rejected by SDI)
Name of the status, in Italian
sdi_document_type objectrequired
Type of the electronic document on SDI; TD01 (invoice) when the invoice has none
- SdiDocumentType
- null
Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)
Description of the type, in Italian
Date of issue of the invoice
Year of the numbering of the invoice
Complete number of the invoice: the year followed by the number on 6 digits, for example 2025000123
Legal note of the tax regime printed on the invoice, in Italian, such as the law under which VAT is not applied; null when the regime has none
Additional reason (Causale) of the electronic invoice; null when there is none
Whether the invoice is paid
Identifier assigned by SDI to the invoice; null when it has not been sent to SDI
Name of the file sent to SDI; null when not sent, and for most invoices issued before November 2024
total_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
amount_no_balance objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
payment_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Ids of the orders of the invoice (GET /api/v3/orders/{order_id})
Number of rows of the invoice (GET /api/v3/invoices/{invoice_id}/rows)
initial_credit objectrequired
Amount in euros, without the VAT details of Amount
Amount, in euros
Currency code: always EUR
current_credit objectrequired
Amount in euros, without the VAT details of Amount
Amount, in euros
Currency code: always EUR
Last day on which the credit left can be refunded; null when there is no limit
Expiry date of the credit of the top-up; null when it does not expire
operation_type objectrequired
Type of an operation on the prepaid credit
One of TOP_UP, REDEMPTION (payment with the credit), REDEMPTION_CANCELLATION, PAYMENT_CANCELLATION, REFUND, CREDIT_CANCELLATION, RESET_CREDIT or RESELLER_SHOP_REFUND
Name of the type, in Italian
creditnote objectrequired
Credit note issued for the operation, for REFUND and CREDIT_CANCELLATION; null for the other types
- Creditnote
- null
Id of the invoice the credit note refers to (GET /api/v3/invoices/{invoice_id}); null when it refers to none
billing objectrequired
Billing profile: the holder the documents are made out to, with its tax and electronic invoicing data
legal_entity objectrequired
Legal form of the holder of a billing profile, with its group
legal_entity_group objectrequired
Group of legal forms, such as private individuals or Italian companies
Code of the group, currently PRIVATE, ITALIAN_INDIVIDUAL_COMPANY, ITALIAN_LIMITED_COMPANY, ITALIAN_COOPERATIVE_COMPANY, ITALIAN_PUBLIC_ADMINISTRATION, FOREIGN_COMPANY or OTHER
Name of the group, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Code of the legal form: ITA_PVT, NOITA_PVT, ITA_INDIVIDUALE, ITA_CAPITALI, ITA_PERSONE, ITA_ASSNOCOMM, ITA_ASSCOMM, ITA_ALTRO, ITA_PA, EU_ALTRO, NOEU_ALTRO, VATICAN_NOPVT, SANMARINO_NOPVT or FORBIDDEN_NOITA_NOPVT
Name of the legal form, in Italian
tax_regime objectrequired
Tax regime: how VAT applies to the documents
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Province: the acronym of the Italian province, for example VI, or EE outside Italy
country objectrequired
ie. IT
ie. ITA
Name of the country in Italian; the local name when there is no translation
Name of the country in its own language, for example Deutschland
International calling code, without +, for example 39
Continent, in English, for example Europe or North America
Area of the country: EU (European Union) or EXTRAEU
Gender of the holder: M or F; null when not given
Date of birth of the holder; null when not given
Place of birth of the holder; null when not given
Phone, usually in the form 0039.0123456789: 00 and the international prefix, a dot, the number; null when not given
VAT number of the holder (partita IVA in Italy); null when it has none
Whether the holder belongs to an Italian VAT group (Gruppo IVA), whose members share the VAT number and have each their own tax code
Tax code of the holder (codice fiscale in Italy)
PEC address (certified email, Posta Elettronica Certificata) to which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices when there is no recipient code; null when not given
Recipient code (Codice Destinatario) with which SDI, the Italian e-invoicing exchange system, delivers the electronic invoices: 7 characters, 6 for the public administration; null when not given
Expiry date of the declaration of intent (dichiarazione d'intento) of a habitual exporter, whose invoices are without VAT; null when not given
Protocol number of the declaration of intent of a habitual exporter, written on the electronic invoices; null when not given
Date of the electronic receipt of the declaration of intent, issued by the Italian Revenue Agency (Agenzia delle Entrate); null when not given
Whether split payment (scissione dei pagamenti) applies: the tax regime is SPLIT_PAYMENT, and the customer pays the VAT of the invoices directly to the Italian State
sdi_document_status objectrequired
Status of the credit note on SDI, the Italian e-invoicing exchange system; null for the credit notes not sent through SDI, issued before electronic invoicing
- SdiDocumentStatus
- null
One of TO_SIGN, TO_SEND, SENT, DELIVERED, NOT_DELIVERED or DISCARDED (rejected by SDI)
Name of the status, in Italian
sdi_document_type objectrequired
Type of an electronic document on SDI, the Italian e-invoicing exchange system (TipoDocumento)
Code of the type, for example TD01 (invoice), TD02 (deposit invoice) or TD04 (credit note)
Description of the type, in Italian
tax_regime objectrequired
Tax regime set on the credit note; null when it uses the one of the billing profile (billing.tax_regime)
- TaxRegime
- null
One of ORDINARY, SPLIT_PAYMENT, EU_VIES, EU_EXPORTER (habitual exporter), EXTRA_EU, VATICAN, SANMARINO or ART_26
Name of the regime, in Italian, for example Ordinario
Nature code of the operation on the electronic invoice (Natura) when VAT is not applied, for example N2.1; null for the regimes with VAT
VAT rate as a fraction, for example 0.22 for 22%
Date of issue of the credit note
Year of the numbering of the credit note
Complete number of the credit note: the year followed by the number on 6 digits, for example 2025000123
Legal note of the tax regime printed on the credit note, in Italian, such as the law under which VAT is not applied; null when the regime has none
Identifier assigned by SDI to the credit note; null when it has not been sent to SDI
Name of the file sent to SDI; null when not sent, and for the credit notes issued before November 2024
total_amount objectrequired
Amount in euros: the taxable amount and, when computed with a tax regime, the VAT rate, the VAT and the total, which are null otherwise
Taxable amount
Currency code: always EUR
VAT rate as a fraction, for example 0.22 for 22%
VAT (tax) amount
Total amount
Number of rows of the credit note (GET /api/v3/credit-notes/{credit_note_id}/rows)
amount objectrequired
Amount in euros, without the VAT details of Amount
Amount, in euros
Currency code: always EUR
provider_data objectrequired
Data of the payment provider, from the paid attempt or the latest one; null when the payment has no attempts
- PaymentProviderData
- null
Whether the attempt was paid
Id of the authorization or of the order at the provider
Authorization code of the transaction at the provider
Status of the attempt at the provider, for example OK or COMPLETED
Result code of the provider, for example 0 or DECLINED; THRESHOLD_EXCEEDED when the attempt was refused for the payment limits
Message of the provider about the result
First name of the payer, as given by the provider
Surname of the payer, as given by the provider
Email address of the payer, as given by the provider
Bank of the payer: the issuer of the card or the bank of the transfer
Number of the card, masked or reduced to the last digits
Brand of the card, for example VISA, MASTERCARD or AMEX
Expiry of the card as YYYY-MM-DD, the last day of its month; for the methods without a card, the expiry set for the authorization
Area of the card or of the payment, for example EUROPE or SEPA
Type of the transaction at the provider, for example NO_3DSECURE, DEBIT or TRF (transfer)
Type of the payment at the provider, for example PAYMENT_METHOD_TOKEN or CARD; Storno for a payment created by the cancellation of another one
When the transaction took place at the provider
Product of the card as given by the provider, for example VISA
Country of the card or of the payer, as an ISO 3166-1 alpha-2 or alpha-3 code depending on the provider
Always null: only the paginated lists have a meta
null{
"error": 0,
"message": "string",
"data": {
"payment_id": 0,
"payment_method": "string",
"payment_code": "string",
"amount_total": {
"amount": 0,
"currency": "string"
},
"amount_payed": {
"amount": 0,
"currency": "string"
},
"date_payment": "2024-07-29T15:51:28.071Z",
"payed": true,
"prepaid_credit_operations": [
{
"operation_id": 0,
"operation_id_related": 0,
"prepaid_credit_topup": {
"topup_id": 0,
"invoice": {
"invoice_id": 0,
"billing": {
"account_billing_id": 0,
"legal_entity": {
"legal_entity_group": {
"group_code": "string",
"group_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"entity_code": "string",
"entity_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"organization": "string",
"name": "string",
"surname": "string",
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": {
"iso_code_2": "string",
"iso_code_3": "string",
"country_name": "string",
"local_name": "string",
"phone_code": "string",
"continent": "string",
"region": "string"
},
"gender": "string",
"birth_date": "2024-07-29",
"birth_place": "string",
"phone": "string",
"vat_number": "string",
"is_vat_group": true,
"fiscal_code": "string",
"edocument_pec": "string",
"edocument_code": "string",
"exporter_expiry": "2024-07-29",
"exporter_number": "string",
"exporter_date": "2024-07-29",
"is_split_payment": true
},
"type": "string",
"sdi_document_status": {
"status_code": "string",
"status_name": "string"
},
"sdi_document_type": {
"type_code": "string",
"type_description": "string"
},
"date_emitted": "2024-07-29",
"invoice_year": 0,
"invoice_number": "string",
"invoice_caption": "string",
"invoice_caption_additional": "string",
"payed": true,
"sdi_identifier": "string",
"sdi_filename": "string",
"total_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"amount_no_balance": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"payment_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"orders": [
0
],
"rows_count": 0,
"date_created": "2024-07-29T15:51:28.071Z"
},
"initial_credit": {
"amount": 0,
"currency": "string"
},
"current_credit": {
"amount": 0,
"currency": "string"
},
"refund_expiry": "2024-07-29",
"credit_expiry": "2024-07-29",
"date_created": "2024-07-29T15:51:28.071Z"
},
"operation_type": {
"type_code": "string",
"type_description": "string"
},
"creditnote": {
"creditnote_id": 0,
"invoice_id": 0,
"billing": {
"account_billing_id": 0,
"legal_entity": {
"legal_entity_group": {
"group_code": "string",
"group_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"entity_code": "string",
"entity_name": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"organization": "string",
"name": "string",
"surname": "string",
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": {
"iso_code_2": "string",
"iso_code_3": "string",
"country_name": "string",
"local_name": "string",
"phone_code": "string",
"continent": "string",
"region": "string"
},
"gender": "string",
"birth_date": "2024-07-29",
"birth_place": "string",
"phone": "string",
"vat_number": "string",
"is_vat_group": true,
"fiscal_code": "string",
"edocument_pec": "string",
"edocument_code": "string",
"exporter_expiry": "2024-07-29",
"exporter_number": "string",
"exporter_date": "2024-07-29",
"is_split_payment": true
},
"sdi_document_status": {
"status_code": "string",
"status_name": "string"
},
"sdi_document_type": {
"type_code": "string",
"type_description": "string"
},
"tax_regime": {
"regime_code": "string",
"regime_name": "string",
"code_edocument": "string",
"tax_rate": 0
},
"date_emitted": "2024-07-29",
"creditnote_year": 0,
"creditnote_number": "string",
"creditnote_caption": "string",
"sdi_identifier": "string",
"sdi_filename": "string",
"total_amount": {
"amount": 0,
"currency": "string",
"tax_rate": 0,
"tax": 0,
"total": 0
},
"rows_count": 0,
"date_created": "2024-07-29T15:51:28.071Z"
},
"amount": {
"amount": 0,
"currency": "string"
},
"date_created": "2024-07-29T15:51:28.071Z"
}
],
"provider_data": {
"payed": true,
"authorization_token": "string",
"authorization_code": "string",
"status": "string",
"status_code": "string",
"message": "string",
"payer_name": "string",
"payer_surname": "string",
"payer_email": "string",
"bank_issuer": "string",
"creditcard_pan": "string",
"creditcard_issuer": "string",
"creditcard_expiration": "string",
"region": "string",
"transaction_type": "string",
"payment_type": "string",
"payment_date": "2024-07-29T15:51:28.071Z",
"product_type": "string",
"nationality": "string"
}
}
}