3.1. /api/v2/auth-cash

Introduction

Auth-cash is initiated through HTTPS POST request by using URLs and the parameters specified below. Use SHA-1 for authentication. See Statuses.

API URLs

IntegrationProduction
https://sandbox.billblend.com/checkout/api/v2/auth-cash/ENDPOINTIDhttps://pay.billblend.com/checkout/api/v2/auth-cash/ENDPOINTID

Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded.

Parameter NameDescriptionValue
client_orderidUnique order identifier assigned by Connecting Party.Necessity: RequiredType: StringLength: 128
order_descBrief order description.Necessity: RequiredType: StringLength: 64k
amountAmount to be charged. The amount has to be specified in the highest units with . delimiter. For instance, 10.5 for USD means 10 US Dollars and 50 Cents.Necessity: RequiredType: NumericLength: 10
currencyCurrency the transaction is charged in (See: Currency codes). Sample values are: USD for US Dollar EUR for European Euro.Necessity: RequiredType: StringLength: 3
address1Payer’s address line 1.Necessity: RequiredType: StringLength: 50
cityPayer’s city.Necessity: RequiredType: StringLength: 50
zip_codePayer’s ZIP code.Necessity: RequiredType: StringLength: 10
countryPayer’s country. Please see Country codes for a list of valid country codes.Necessity: RequiredType: StringLength: 2
phonePayer’s full international phone number, including country code.Necessity: RequiredType: StringLength: 15
emailPayer’s e-mail address.Necessity: RequiredType: StringLength: 50
ipaddressPayer’s IP address, included for fraud screening purposes.Necessity: RequiredType: StringLength: 45
controlChecksum generated by SHA-1. Control string is represented as concatenation of the following parameters:1. <ENDPOINTID | ENDPOINTGROUPID> (See: Request URL).2. Request parameter: client_orderid.3. Request parameter: amount (in minor units).4. Request parameter: email.5. merchant_control (Control key assigned to Connecting Party account in the Billblend gateway system).Necessity: RequiredType: StringLength: 40
first_namePayer’s first name.Necessity: RequiredType: StringLength: 50
last_namePayer’s last name.Necessity: RequiredType: StringLength: 50
statePayer’s state. (two-letter state code). Please see Mandatory State codes for a list of valid state codes. Required for USA, Canada and Australia.Necessity: ConditionalType: StringLength: 2
redirect_urlURL, where the Payer is redirected to upon completion of the transaction. Please note that redirection is performed in any case, no matter whether transaction is approveddeclined or in any other final status.Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Pass https://doc.billblend.com/ if you have no need to return payer anywhere. Use either redirect_url or combination of redirect_success_url and redirect_fail_url, not both.Necessity: OptionalType: StringLength: 1024
redirect_success_urlURL, where the Payer is redirected to when transaction status is approved (See status list).Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Otherwise put https://doc.billblend.com/ if there is no need to redirect Payer anywhere. Use either combination of redirect_success_url and redirect_fail_url or redirect_url, not both.Necessity: OptionalType: StringLength: 1024
redirect_fail_urlURL, where the Payer is redirected to when transaction status is not approved (See status list).Connecting Party must not use the parameters come along with the redirect HTTP Request to treat the status of the transaction. Instead Connecting Party can utilize server_callback_url or status API command. Pass https://doc2.codetime.net if there is no need to redirect Payer anywhere. Use either combination of redirect_fail_url and redirect_success_url or redirect_url, not both.Necessity: OptionalType: StringLength: 1024
ssnLast four digits of the Payer’s social security number.Necessity: OptionalType: NumericLength: 32
birthdayPayer’s date of birth, in the format YYYYMMDD.Necessity: OptionalType: NumericLength: 8
cell_phonePayer’s full international cell phone number, including country code.Necessity: OptionalType: StringLength: 15
site_urlThe URL of the E-commerce entity, where the payment is originated from.Necessity: OptionalType: StringLength: 128
server_callback_urlURL, where the transaction status is sent to.Connecting Party may use server callback URL for custom processing of the transaction completion, e.g. to collect payment data in the Connecting Party’s information system. For the list of parameters which come along with server callback to server_callback_url refer to Connecting Party callback parameters.Necessity: OptionalType: StringLength: 1024
preferred_languagePayer’s two-letter language code for multi-language invoices.Necessity: OptionalType: StringLength: 2

Response Parameters

Note

Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.

Response ParametersDescription
typeThe type of response. May be async-responsevalidation-errorerror. If type equals validation-error or errorerror-message and error-code parameters contain error details.
paynet-order-idOrder id assigned to the order by Billblend.
merchant-order-idConnecting Party order id.
serial-numberUnique number assigned by Billblend server to particular request from the Connecting Party.
end-point-idEndpoint id used for the transaction.
error-messageIf status is error this parameter contains the reason for decline or error details.
error-codeThe error code is case of error status.

Request Example

POST /checkout/api/v2/auth-cash/46760 HTTP/1.1
Host: sandbox.billblend.com
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 592
Content-Type: application/x-www-form-urlencoded
Connection: close

client_orderid=inv3982750
&order_desc=Test Order Description
&first_name=John
&last_name=Smith
&ssn=1267
&birthday=19820115
&address1=100 Main st
&city=Seattle&state=WA
&zip_code=98102
&country=US
&phone=+12063582043
&cell_phone=+19023384543
&amount=55
&email=john.smith@gmail.com
&currency=USD
&ipaddress=65.153.12.232
&site_url=https://doc2.codetime.net
&purpose=user_account1
&redirect_url=http://sandbox.billblend.com/doc/dummy.htm
&server_callback_url=https://httpstat.us/200
&merchant_data=VIP customer
&control=ce2dcc2b307c123242b9867cb0ce15617b8ee7f9
&preferred_language=en

Success Response Example

HTTP/1.1 200
Server: server
Date: Wed, 14 Jun 2023 08:43:52 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 146

type=async-response
&serial-number=00000000-0000-0000-0000-000002eb1adf
&merchant-order-id=inv3982750
&paynet-order-id=7174243
&end-point-id=46760

Fail Response Example

HTTP/1.1 200
Server: server
Date: Wed, 14 Jun 2023 08:43:52 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 146

type=validation-error
&serial-number=00000000-0000-0000-0000-000002ddb0d4
&error-message=Project+with+currency+RUB+does+not+apply+request+with+currency+USD
&error-code=16

Postman Collection

Postman Collection is available at this link – https://doc.billblend.com/integration/API_commands/api_v2_auth-cash.html#postman-collection

Request Builder

Request Builder is available at this link – https://doc.billblend.com/integration/API_commands/api_v2_auth-cash.html#request-builder

endpointidinput ENDPOINTID
client_orderidmake it  or use internal invoice ID
order_desc
first_name
last_name
ssn
birthday
address1
city
state
zip_code
country
phone
cell_phone
amount
email
currency
ipaddress
site_url
purpose
merchant_controlinput Control Key
redirect_url
redirect_success_url
redirect_fail_url
server_callback_url
preferred_language
String to sign
Signature
curl --data "client_orderid=902B4FF5&order_desc=Test Order Description&first_name=John&last_name=Smith&ssn=1267&birthday=19820115&address1=100 Main st&city=Seattle&state=WA&zip_code=98102&country=US&phone=+12063582043&cell_phone=+19023384543&amount=10.42&email=john.smith@gmail.com&currency=USD&ipaddress=65.153.12.232&site_url=https://doc.billblend.com/&purpose=user_account1&redirect_url=https://doc.billblend.com//doc/dummy.htm&server_callback_url=https://httpstat.us/200&preferred_language=en&control=768eb8162fc361a3e14150ec46e9a6dd8fbfa483" https://sandbox.billblend.com/checkout/api/v2/auth-cash/1
<?php

/**
 * Executes request
 *
 * @param       string      $url                Url for payment method
 * @param       array       $requestFields      Request data fields
 *
 * @return      array                           Host response fields
 *
 * @throws      RuntimeException                Error while executing request
 */
function sendRequest($url, array $requestFields)
{
    $curl = curl_init($url);

    curl_setopt_array($curl, array
    (
        CURLOPT_HEADER         => 0,
        CURLOPT_USERAGENT      => 'Billblend-Client/1.0',
        CURLOPT_SSL_VERIFYHOST => 0,
        CURLOPT_SSL_VERIFYPEER => 0,
        CURLOPT_POST           => 1,
        CURLOPT_RETURNTRANSFER => 1
    ));

    curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($requestFields));

    $response = curl_exec($curl);

    if(curl_errno($curl))
    {
        $error_message  = 'Error occurred: ' . curl_error($curl);
        $error_code     = curl_errno($curl);
    }
    elseif(curl_getinfo($curl, CURLINFO_HTTP_CODE) != 200)
    {
        $error_code     = curl_getinfo($curl, CURLINFO_HTTP_CODE);
        $error_message  = "Error occurred. HTTP code: '{$error_code}'";
    }

    curl_close($curl);

    if (!empty($error_message))
    {
        throw new RuntimeException($error_message, $error_code);
    }

    if(empty($response))
    {
        throw new RuntimeException('Host response is empty');
    }

    $responseFields = array();

    parse_str($response, $responseFields);

    return $responseFields;
}

function signString($s, $merchantControl)
{
    return sha1($s . $merchantControl);
}

/**
 * Signs payment (sale/auth/transfer) request
 *
 * @param 	array		$requestFields		request array
 * @param	string		$endpointOrGroupId	endpoint or endpoint group ID
 * @param	string		$merchantControl	merchant control key
 */
function signPaymentRequest($requestFields, $endpointOrGroupId, $merchantControl)
{
    $base = '';
    $base .= $endpointOrGroupId;
    $base .= $requestFields['client_orderid'];
    $base .= $requestFields['amount'] * 100;
    $base .= $requestFields['email'];

    return signString($base, $merchantControl);
}

/**
 * Signs status request
 *
 * @param 	array		$requestFields		request array
 * @param	string		$login			merchant login
 * @param	string		$merchantControl	merchant control key
 */
function signStatusRequest($requestFields, $login, $merchantControl)
{
    $base = '';
    $base .= $login;
    $base .= $requestFields['client_orderid'];
    $base .= $requestFields['orderid'];

    return signString($base, $merchantControl);
}


function signAccountVerificationRequest($requestFields, $endpointOrGroupId, $merchantControl)
{
    $base = '';
    $base .= $endpointOrGroupId;
    $base .= $requestFields['client_orderid'];
    $base .= $requestFields['email'];
    return signString($base, $merchantControl);
}

$endpointId = 1;
$merchantControl = 'B17F59B4-A7DC-41B4-8FF9-37D986B43D20';


$requestFields = array(
    'client_orderid' => '902B4FF5', 
    'order_desc' => 'Test Order Description', 
    'first_name' => 'John', 
    'last_name' => 'Smith', 
    'ssn' => '1267', 
    'birthday' => '19820115', 
    'address1' => '100 Main st', 
    'city' => 'Seattle', 
    'state' => 'WA', 
    'zip_code' => '98102', 
    'country' => 'US', 
    'phone' => '+12063582043', 
    'cell_phone' => '+19023384543', 
    'amount' => '10.42', 
    'email' => 'john.smith@gmail.com', 
    'currency' => 'USD', 
    'ipaddress' => '65.153.12.232', 
    'site_url' => 'https://doc.billblend.com/', 
    'purpose' => 'user_account1', 
    'redirect_url' => 'https://doc.billblend.com//doc/dummy.htm', 
    'server_callback_url' => 'https://httpstat.us/200', 
    'preferred_language' => 'en', 

);

$requestFields['control'] = signPaymentRequest($requestFields, $endpointId, $merchantControl);

$responseFields = sendRequest('https://sandbox.billblend.com/checkout/api/v2/auth-cash/1', $requestFields);

print_r($responseFields);

?>
require 'net/http'
require 'uri'
require 'cgi'
require 'digest/sha1'

##
# Executes request
#
# @param    url               [String]    Url for payment method
# @param    request_fields    [Hash]      Request data fields
#
# @return   [Hash]    Host response fields
def send_request(url, request_fields)
  begin
    uri = URI url

    response = Net::HTTP.start uri.hostname, uri.port, :use_ssl => uri.scheme == 'https' do |http|
      post = Net::HTTP::Post.new uri.request_uri
      post.set_form_data request_fields
      http.request post
    end
  rescue Exception => e
    raise RuntimeError, "Error occurred. #{e.message}"
  end

  unless Net::HTTPOK === response
    raise RuntimeError, "Error occurred. HTTP code: '#{response.code}'. Server message: '#{response.message}'"
  end

  unless response.body
    raise RuntimeError, 'Host response is empty'
  end

  # Change hash format from {'key' => ['value']} to {'key' => 'value'} in map block
  Hash[CGI.parse(response.body).map {|key, value| [key, value.first]}]
end

def sign_string(str, merchant_control)
  Digest::SHA1.hexdigest(str + merchant_control)
end

def sign_payment_request(request_fields, endpoint_or_group_id, merchant_control)
  base = ''
  base += endpoint_or_group_id
  base += request_fields['client_orderid']
  base += (request_fields['amount'].to_f * 100).to_i
  base += request_fields['email']
  sign_string(base, merchant_control)
end

def sign_status_request(request_fields, login, merchant_control)
  base = ''
  base += login
  base += request_fields['client_orderid']
  base += request_fields['orderid'].nil? ? '' : request_fields['orderid']
  sign_string(base, merchant_control)
end

request_fields = {
    'client_orderid' => '902B4FF5', 
    'order_desc' => 'Test Order Description', 
    'first_name' => 'John', 
    'last_name' => 'Smith', 
    'ssn' => '1267', 
    'birthday' => '19820115', 
    'address1' => '100 Main st', 
    'city' => 'Seattle', 
    'state' => 'WA', 
    'zip_code' => '98102', 
    'country' => 'US', 
    'phone' => '+12063582043', 
    'cell_phone' => '+19023384543', 
    'amount' => '10.42', 
    'email' => 'john.smith@gmail.com', 
    'currency' => 'USD', 
    'ipaddress' => '65.153.12.232', 
    'site_url' => 'https://doc.billblend.com/', 
    'purpose' => 'user_account1', 
    'redirect_url' => 'https://doc.billblend.com//doc/dummy.htm', 
    'server_callback_url' => 'https://httpstat.us/200', 
    'preferred_language' => 'en', 

    'control' => '768eb8162fc361a3e14150ec46e9a6dd8fbfa483'
};

response_fields = send_request('https://sandbox.billblend.com/checkout/api/v2/auth-cash/1', request_fields);

require 'pp'
pp response_fields
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Main {
    //Transactions are initiated by using URL in the following format: /checkout/api/v2/TRANSACTION_TYPE/ENDPOINTID or /checkout/api/v2/TRANSACTION_TYPE/ENDPOINTGROUPID (if group is supported)
    //Use "gate" for production purposes or "sandbox" for integration needs
    private static String targetURL = "https://sandbox.billblend.com/checkout/api/v2/auth-cash/1";
    //Request parameters
    private static String urlParameters = "client_orderid=902B4FF5&order_desc=Test Order Description&first_name=John&last_name=Smith&ssn=1267&birthday=19820115&address1=100 Main st&city=Seattle&state=WA&zip_code=98102&country=US&phone=+12063582043&cell_phone=+19023384543&amount=10.42&email=john.smith@gmail.com&currency=USD&ipaddress=65.153.12.232&site_url=https://doc.billblend.com/&purpose=user_account1&redirect_url=https://doc.billblend.com//doc/dummy.htm&server_callback_url=https://httpstat.us/200&preferred_language=en&";
    //String for calculating control code parameter
    private static String controlParameters = "1902B4FF51042john.smith@gmail.comB17F59B4-A7DC-41B4-8FF9-37D986B43D20";

    public static void main(String[] args) throws NoSuchAlgorithmException, UnsupportedEncodingException {
        //Sending POST request to the specified URL with request parameters and SHA1-encrypted control parameter
        System.out.println(executePost(targetURL, urlParameters + "control= " + sha1(controlParameters)));
    }

    static String sha1(String input) throws NoSuchAlgorithmException, UnsupportedEncodingException {
        MessageDigest mDigest = MessageDigest.getInstance("SHA1");
        byte[] result = mDigest.digest(input.getBytes("utf-8"));
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < result.length; i++) {
            sb.append(Integer.toString((result[i] & 0xff) + 0x100, 16).substring(1));
        }

        return sb.toString();
    }

    public static String executePost(String targetURL, String urlParameters)
    {
        URL url;
        HttpURLConnection connection = null;
        try {
            //Create connection
            url = new URL(targetURL);
            connection = (HttpURLConnection)url.openConnection();
            connection.setDoOutput(true);


            //Send request
            DataOutputStream wr = new DataOutputStream (
                    connection.getOutputStream ());
            wr.writeBytes (urlParameters);
            wr.flush ();
            wr.close ();


            //Get Response
            InputStream is = connection.getInputStream();
            BufferedReader rd = new BufferedReader(new InputStreamReader(is));
            String line;
            StringBuffer response = new StringBuffer();
            while((line = rd.readLine()) != null) {
                response.append(line);
                response.append('\n');
            }
            rd.close();
            return response.toString();

        } catch (Exception e) {

            e.printStackTrace();
            return null;

        } finally {

            if(connection != null) {
                connection.disconnect();
            }
        }
    }
}

Contact us

By clicking on the button, you agree to the data protection policy

Complete the quiz

By clicking on the button, you agree to the data protection policy