Developer Area

Context

In the case of an automatic payment failure when paying an invoice, since we no longer have the means to handle the collection, it is up to you to resolve the situation.
Payment for outstanding invoices can be made by the customer independently from the “Invoices” section of the customer portal. You can retrieve a payment link to send to your customers to prompt them to pay the invoice.

Procedure

You need to retrieve the payment link for an invoice called “Hosted-Charge” and then send it to your customer. This link will redirect your customer to the specific invoice payment process.

1/ Retrieve a payment link via API

To do this through API, you need to use the following request:
Request:

GET https://api-{IdBusiness}.proabono.com/v1/Invoice/{IdInvoice}

Response:

{
	"Id": 1811186,
	"IdSegment": 1441,
	"IdCustomer": 877571,
	"ReferenceSegment": "1bis",
	"ReferenceCustomer": "8de918ae-4244-4405-8ece-828ddc36957d",
	"FullNumber": "S-1441.00000175",
	"StateInvoice": "PaymentDue",
	"DateIssue": "2022-02-01T06:03:53.36Z",
	"DatePaymentLimit": "2022-03-03T00:00:00.00Z",
	"TypePayment": "ExternalBank",
	"AmountSubtotal": 18400,
	"AmountTotal": 22080,
	"Currency": "EUR",
	"DateUpdate": "2022-02-01T06:03:53.34Z",
	"Links": [
		{
			"rel": "hosted-related-invoice",
			"href": "https://sandbox-eur.proabono.com/portal-inv-pdf/{Unique-Encrypted-URL1}"
		},
		{
			"rel": "hosted-charge",
			"href": "https://sandbox-eur.proabono.com/inv-charge/{Unique-Encrypted-URL2}"
		},
		{
			"rel": "hosted-collection-invoice",
			"href": "https://sandbox-eur.proabono.com/portal-inv-list/{Unique-Encrypted-URL3}"
		}
	]
}