A reference for payment on the Multicaixa network. You can retrieve the details of a reference and cancel it, check its payment and change history, check whether a reference number already exists, and list all your references. References are identified by a unique, random ID.
List references
Lists the references you have created. References are returned sorted, with the most recent references first.
query Parameters
pagePage number to return
pageSizeNumber of items to return per page
estadoReference status (válida = valid, cancelada = cancelled, paga = paid, expirada = expired)
referenciaReference number
List references › Responses
OK
Create a reference
Creates a reference for payment on the Multicaixa network.
Create a reference › Request Body
numero^[0-9]$Reference number. If null, the system generates a number for the reference.
validadeExpiry date of the reference.
montanteAmount to pay.
required for dynamic references.
Example: 99 999,99
clienteCustomer details used for notifications.
metadadosKey/value object used to store additional information about the request. Both keys and values must be strings.
Create a reference › Responses
Created
Get a reference
Retrieves the details of a reference you created earlier. Provide the unique reference ID returned when the reference was created and IZI Pay returns the information for the matching reference. This is the same information returned when the reference is created.
path Parameters
idUnique reference ID
Get a reference › Responses
OK
Check a reference number
Checks whether a reference number already exists on your Multicaixa network. Look up a reference by its 9-digit number (not its ID): if it exists, IZI Pay returns the reference details in result; if it does not, result is an empty object.
path Parameters
numeroReference number (9 digits)
Check a reference number › Responses
OK