QR Code Metadata

Metadata are fields passed to the Turbo API and returned back. These extra fields can be supplied as additional POST fields to our API.

One scenario where this would be useful, is to supply a customer name and account number to tie the payment to the customer and their corresponding account.

We will return these values in two places:

1) In the API JSON response object in the metadata array.

2) In webhooks when payments are completed. To receive these webhooks from our server, please set a webhook URL under Settings > Payments in the Turbo dashboard.

---

Parameters

To view all parameters, see QR.

  

    

      POST /qr
    
    

      CURL 
      PHP
      Python
      Ruby
        
    
  

curl \
-X POST \
-d api_key=TURBO_API_KEY \
-d amount=1.00 \
-d customer=ABC123 \
-d account_number=XYZ456 \
https://api.tur.bo/qr    
<?php
$api_url ='https://api.tur.bo';
$api_path='/qr';
$api_key ='TURBO_API_KEY';
$amount  =1.00;
$metadata=array( 'customer'=>'ABC123','account_number'=>'XYZ456' );
$fields  =array( 'api_key'=>$api_key,'amount'=>$amount,$metadata );
$opts    =array( 'form_params'=>$fields );

try {
  $client  =new GuzzleHttp\Client( array( 'base_uri'=>$api_url ) );
  $response=$client->post( $api_path,$opts );
  $json    =$response->getBody();
  
  echo $json;
}
catch( Exception $e ) {
  echo 'error = ',$e->getMessage(),"\n";
}
?>    
#!/usr/bin/python
import requests
import json

api_url="https://api.tur.bo/qr"
result=requests.post( api_url,data="api_key=TURBO_API_KEY&amount=1.00&customer=ABC123&account_number=XYZ456" )
print( json.dumps( result.json() ) )    
#!/usr/bin/env ruby
require 'uri'
require 'net/http'

api_url="https://api.tur.bo/qr"
uri    =URI( api_url )
result =Net::HTTP.post_form( uri,'api_key'=>'TURBO_API_KEY','amount'=>'1.00','customer'=>'ABC123','account_number'=>'XYZ456' )
puts result.body    
  

  

    

    Response    
    
  

{
"ach":"no",
"amount":"1.00",
"api_path":"/qr",
"branding":"logo",
"created":1698859189,
"domain":"tur.bo",
"error":false,
"id":"abc123",
"metadata":[{ "customer":"ABC123","account_number":"XYZ456" }]
"msg":"OK",
"name":null,
"qr":"https://api.tur.bo/images/abc123.png",
"reusable":"yes",
"reusable_limit":null,
"show_link":"yes",
"show_name":"yes",
"show_price":"yes",
"status":"created",
"success_url":null,
"url":"https://tur.bo/abc123"
}