HiPay Enterprise – SEPA Credit Transfer (SCT / virtual IBAN)

 How to generate a virtual IBAN

 

Please note:

• The virtual IBAN is only available on the Production account.
• To test, you need to make a bank transfer of at least €1.

 

 

Issued to identify and allocate payments from different customers, virtual IBANs look and function exactly like standard IBANs and greatly facilitate automated reconciliation.

 

1. Requirements

 

2. Request parameters

¹ If both expiry_XXXXX arguments are missing, the expiry date will be set to 28 days after the date of the creation request.

 For instance, if a creation request is made on 01/01/2022, the expiry date will be set to 29/01/2022, inclusive.

Then, every time a virtual IBAN is used, its expiry date is extended by a year.

 ² expiry_XXXXX arguments must be provided together or both missing in the creation request.

An error will be returned if only one is provided.

 

Example of a PHP request

 

3. API response 

Format

- In XML by default

- Optionally in JSON if the “Accept” HTTPHEADER only contains “application/json”

 

Example of a JSON response 

{
  "code":0,
  "message":"success",
  "description":"Virtual iban has been successfully created.",
  "virtual_iban": {
     "iban":"XXXXXXXXXXXXXXXX",
     "bic":"XXXXXXXX",
     "creation_date":"2022-02-02",
     "expiry_date":"2022-04-30",
     "external_reference":"my_ID-00019"
   }
}

 

Display information to the customer

Once you have received the API response, you will need to display the following information to the customer so that he or she can make the bank transfer:

• IBAN
• BIC
  
• External_reference (as the bank label / description)

 

Payment confirmation by server-to-server notifications

Once the customer has made a bank transfer and the funds have reached the virtual IBAN, you will receive three server-to-server notifications at the same time:

• 116 Authorized
• 117 Capture Requested
• 118 Captured

Example of an authorization notification

  

  
   
    
   
    completed
   
   
    
   
   
    
   
    false
   
   
    
   
    00001230789
   
   
    
   
    1
   
   
    
   
    >no+code    
    
     1112223333444555666
    
    
    
    
     2022-03-21T07:03:14+0000
    
    
    
    
     2022-03-21T07:03:14+0000
    
    
    
    
     2022-03-21T07:03:14+0000    
     
      116
     
     
    
     
      Authorized
     
     
    
     
      19.65
     
     
    
     
      0.00
     
     
    
     
      0.00
     
     
    
     
      2
     
     
    
     
      EUR
     
     
    [...]
     
    
     
      sct
     
     
    
     
      
        
      
       DE62xxxx3300
      
      
                   
      
      
        
      
       DxxDEBBXXX
      
      
                   
      
      
        
      
       FR76xxxx7406
      
      
                   
      
      
        
      
       DxxTFRPPXXX
      
      
                   
      
      
         
      
       5105-5517-1477407288
      
      
                    
      
      
         
      
       SEPA+INHOUSE+TRANS
      
      
         
      
       7173255
      
      
         
      
      
         
      
      
         
      
       Sumup+Payments+Limited
      
      
      
     
     
      [...]
     
      
     
      
      
      
       12345909545632695
      
      
      
      
       2022-03-21T07:03:14+0000
      
      
      
      
       1
      
      
      
      
       19.65
      
      
      
      
       0.00
      
      
      
      
       0.00
      
      
      
      
       2
      
      
      
      
       EUR
      
      
      
      
      
      
      
       en_US
      
      
      
      
      
      
     
     
      
     
      FR76xxxx7406
     
     
               
     
     

    
   
  

  

Response status codes

Here is a non-exhaustive list of return codes.