Settings
API Version
Product Catalog
Library

Payment reference numbers

Using this resource you can create reference numbers for Payment Instructions at the invoice level, allowing for multiple payment information and payment reference numbers to be associated with a single invoice. However, only one PRN is generated for each payment method.

Sample payment reference number [ JSON ]

{ "id": "prn___test__8aszZTexzRqs4A", "invoice_id": "__demo_inv__2", "number": "0000202317", "object": "payment_reference_number", "type": "kid" }

API Index URL

https://{site}.chargebee.com/api/v2/payment_reference_numbers

Model Class

 

      Payment reference number attributes
      
 
id
 

      string, max chars=40
 
The id
of the payment_reference_number
resource is a unique identifier assigned to the PRN to track and reference in systems.
 
 
type
 

      enumerated string
 
This attribute helps type
field in the API, specifies how to reconcile offline payments, and generate payment_reference_number
on invoices based on country-specific rules. Setting the type
field generates payment_reference_number
for the respective country and includes them on the invoice for correct reconciliation.
 
 
Possible values are
 
 
kid
The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
ocr
A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.
frn
The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
fik
Denmark based number calculated using recursive MOD 10 algorithm.
 
 Show all values[+]
number
 

      string, max chars=100
 
A number is generated based on the configuration type of the PRN during the invoice creation process.
 
 
invoice_id
 

      optional, string, max chars=50
 
The invoice_id
of the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.
 
 
  
  
id id
 

          string, max chars=40
 
The id
of the payment_reference_number
resource is a unique identifier assigned to the PRN to track and reference in systems.
 
 
type type
 

          enumerated string
 
This attribute helps type
field in the API, specifies how to reconcile offline payments, and generate payment_reference_number
on invoices based on country-specific rules. Setting the type
field generates payment_reference_number
for the respective country and includes them on the invoice for correct reconciliation.
 
 
Possible values are
 
 
kid
The KID number (kundeidentifikasjon) in Norway is an abbreviation for "Customer identification". It is used to associate payments with the customer and invoice.
ocr
A OCR-based payment, contains an OCR reference, which is used to identify the vendor and the purchase document in connection with a payment. Swedish reference number can contain customer ID and/or invoice number to identify customer and invoice.
frn
The reference number printed on invoices in Finland is utilized by buyers for payment via bank transfer, facilitating the association of payments with invoices.
fik
Denmark based number calculated using recursive MOD 10 algorithm.
 
 Show all values[+]
number number
 

          string, max chars=100
 
A number is generated based on the configuration type of the PRN during the invoice creation process.
 
 
invoice_id invoice_id
 

          optional, string, max chars=50
 
The invoice_id
of the payment reference number (PRN) resource is the unique identifier assigned to the invoice that the PRN is associated with.
 
 
 
 
Consent Fields for Payment reference number
 
 
Custom Fields for Payment reference number