Introduction

Audience

This document is intended to be used by the merchant’s technical staff. For any information not explained in this user guide, contact Client Services.

Payment Service

The Payment Service is designed to allow merchants to communicate and process online transactions with the payment gateway’s transaction processing system. The API serves as a bridge between the merchant’s website and various financial institutions in processing real-time payment transactions.

HOST

The Live API Base URL : https://api.paybybankful.com/
The Sandbox API Base URL: https://api-dev1.bankfulportal.com/

Credit Card Payments

Location

The API Endpoint: https://api.paybybankful.com/api/transaction/api

Method

POST

Content-Type: application/x-www-form-urlencoded

Encoding

Payment Service API uses 8-bit Unicode Transformation Format as described in the ISO/ISE 10646. Merchants are required to send Service requests with content-type, application/x-www-form-urlencoded; and charset, iso-8859-1,*, utf-8 using HTTP Post method.

Charge a Credit Card

For Sales Transaction, use this code:

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "1.12",
  "bill_addr" => "Apt#135, Shemwood St",
  "bill_addr_city" => "Denver",
  "bill_addr_country" => "US",
  "bill_addr_state" => "CO",
  "bill_addr_zip" => "201005",
  "cust_email" => "[email protected]",
  "cust_fname" => "Test James",
  "cust_lname" => "Bond",
  "cust_phone" => "9999333321",
  "pmt_expiry" => "12/2022",
  "pmt_key" => "111",
  "pmt_numb" => "4111111111111111",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "request_currency" => "USD",
  "transaction_type" => "CAPTURE",
  "xtl_order_id" => "000011112222",
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
  'request_currency': 'USD',
  'bill_addr': 'Apt#135, Shemwood St',
  'bill_addr_city': 'Denver',
  'bill_addr_country': 'US',
  'bill_addr_state': 'CO',
  'bill_addr_zip': '201005',
  'cust_email': '[email protected]',
  'cust_fname': 'Test James',
  'cust_lname': 'Bond',
  'xtl_order_id': '000011112222',
  'cust_phone': '9999333321',
  'transaction_type': 'CAPTURE',
  'pmt_key': '111',
  'pmt_numb': '4111111111111111',
  'pmt_expiry': '12/2022'
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022"

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password',
    'amount' => '1.12',
    'request_currency' => 'USD',
    'bill_addr' => 'Apt#135, Shemwood St',
    'bill_addr_city' => 'Denver',
    'bill_addr_country' => 'US',
    'bill_addr_state' => 'CO',
    'bill_addr_zip' => '201005',
    'cust_email' => '[email protected]',
    'cust_fname' => 'Test James',
    'cust_lname' => 'Bond',
    'xtl_order_id' => '000011112222',
    'cust_phone' => '9999333321',
    'transaction_type' => 'CAPTURE',
    'pmt_key' => '111',
    'pmt_numb' => '4111111111111111',
    'pmt_expiry' => '12/2022'
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022'
});

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "CAPTURE",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "1.1200",
  "TRANS_REQUEST_ID": 1272,
  "TRANS_RECORD_ID": 79154,
  "TRANS_ORDER_ID": 0980982121,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

Sales Transaction Parameters

The table below only includes typical parameters sent in a simple Sales transaction request

Sales Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Charge a Credit Card and Save Card on file

For Sales Transaction, use this code:

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "1.12",
  "bill_addr" => "Apt#135, Shemwood St",
  "bill_addr_city" => "Denver",
  "bill_addr_country" => "US",
  "bill_addr_state" => "CO",
  "bill_addr_zip" => "201005",
  "cust_email" => "[email protected]",
  "cust_fname" => "Test James",
  "cust_lname" => "Bond",
  "cust_phone" => "9999333321",
  "pmt_expiry" => "12/2022",
  "pmt_key" => "111",
  "pmt_numb" => "4111111111111111",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "request_currency" => "USD",
  "transaction_type" => "CAPTURE",
  "xtl_order_id" => "000011112222",
  "save_card_on_file" => "Y"
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
  'request_currency': 'USD',
  'bill_addr': 'Apt#135, Shemwood St',
  'bill_addr_city': 'Denver',
  'bill_addr_country': 'US',
  'bill_addr_state': 'CO',
  'bill_addr_zip': '201005',
  'cust_email': '[email protected]',
  'cust_fname': 'Test James',
  'cust_lname': 'Bond',
  'xtl_order_id': '000011112222',
  'cust_phone': '9999333321',
  'transaction_type': 'CAPTURE',
  'pmt_key': '111',
  'pmt_numb': '4111111111111111',
  'pmt_expiry': '12/2022',
  "save_card_on_file": "Y"
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022&save_card_on_file=Y"

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022&save_card_on_file=Y");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password',
    'amount' => '1.12',
    'request_currency' => 'USD',
    'bill_addr' => 'Apt#135, Shemwood St',
    'bill_addr_city' => 'Denver',
    'bill_addr_country' => 'US',
    'bill_addr_state' => 'CO',
    'bill_addr_zip' => '201005',
    'cust_email' => '[email protected]',
    'cust_fname' => 'Test James',
    'cust_lname' => 'Bond',
    'xtl_order_id' => '000011112222',
    'cust_phone' => '9999333321',
    'transaction_type' => 'CAPTURE',
    'pmt_key' => '111',
    'pmt_numb' => '4111111111111111',
    'pmt_expiry' => '12/2022',
    'save_card_on_file' => 'Y'
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022&save_card_on_file=Y'
});

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2022&save_card_on_file=Y`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "CAPTURE",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "1.1200",
  "TRANS_REQUEST_ID": 1272,
  "TRANS_RECORD_ID": 79154,
  "TRANS_ORDER_ID": 0980982121,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD",
  "CUSTOMER_VAULT_ID": 12345
}

Make sure to replace req_username with your API key.

Sales Transaction Parameters

The table below only includes typical parameters sent in a simple Sales transaction request

Sales Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Charge a Credit Card By saved card

For Sales Transaction, use this code:

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "1.12",
  "bill_addr" => "Apt#135, Shemwood St",
  "bill_addr_city" => "Denver",
  "bill_addr_country" => "US",
  "bill_addr_state" => "CO",
  "bill_addr_zip" => "201005",
  "cust_email" => "[email protected]",
  "cust_fname" => "Test James",
  "cust_lname" => "Bond",
  "cust_phone" => "9999333321",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "request_currency" => "USD",
  "transaction_type" => "CAPTURE",
  "xtl_order_id" => "000011112222",
  "customer_vault_id" => 123455
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
  'request_currency': 'USD',
  'bill_addr': 'Apt#135, Shemwood St',
  'bill_addr_city': 'Denver',
  'bill_addr_country': 'US',
  'bill_addr_state': 'CO',
  'bill_addr_zip': '201005',
  'cust_email': '[email protected]',
  'cust_fname': 'Test James',
  'cust_lname': 'Bond',
  'xtl_order_id': '000011112222',
  'cust_phone': '9999333321',
  'transaction_type': 'CAPTURE',
  "customer_vault_id": 123455
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&customer_vault_id=123455"

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&customer_vault_id=123455");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password',
    'amount' => '1.12',
    'request_currency' => 'USD',
    'bill_addr' => 'Apt#135, Shemwood St',
    'bill_addr_city' => 'Denver',
    'bill_addr_country' => 'US',
    'bill_addr_state' => 'CO',
    'bill_addr_zip' => '201005',
    'cust_email' => '[email protected]',
    'cust_fname' => 'Test James',
    'cust_lname' => 'Bond',
    'xtl_order_id' => '000011112222',
    'cust_phone' => '9999333321',
    'transaction_type' => 'CAPTURE',
    'customer_vault_id' => 123455
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&customer_vault_id=123455'
});

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAPTURE&customer_vault_id=123455`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "CAPTURE",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "1.1200",
  "TRANS_REQUEST_ID": 1272,
  "TRANS_RECORD_ID": 79154,
  "TRANS_ORDER_ID": 0980982121,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

Sales Transaction Parameters

The table below only includes typical parameters sent in a simple Sales transaction request

Sales Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Refund a Transaction

For REFUND transaction, use this code:

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "0.1",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "transaction_type" => "REFUND",
  "request_ref_po_id" => "186434737",
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'request_ref_po_id': '186434737',
  'transaction_type': 'REFUND',
  'amount': '0.1',
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password'
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST \
"https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "request_ref_po_id=186434737&transaction_type=REFUND&amount=0.1&req_username=sandbox_username&req_password=sandbox_password"

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'request_ref_po_id' => '186434737',
    'transaction_type' => 'REFUND',
    'amount' => '0.1',
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password'
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'request_ref_po_id=186434737&transaction_type=REFUND&amount=0.1&req_username=sandbox_username&req_password=sandbox_password'
});

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("request_ref_po_id=186434737&transaction_type=REFUND&amount=0.1&req_username=sandbox_username&req_password=sandbox_password");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`request_ref_po_id=186434737&transaction_type=REFUND&amount=0.1&req_username=sandbox_username&req_password=sandbox_password`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "REFUND",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "0.1000",
  "TRANS_REQUEST_ID": 80282,
  "TRANS_RECORD_ID": 78443,
  "TRANS_ORDER_ID": 186434737,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

Merchants may request to refund the original sales transaction by sending REFUND in the transaction_type parameter.

Refund Transaction Parameters

The table below only includes typical parameters sent in a simple Authorization transaction request

Refund Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Authorize a Credit Card

Authorization Transaction Parameters

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "1.12",
  "bill_addr" => "Apt#135, Shemwood St",
  "bill_addr_city" => "Denver",
  "bill_addr_country" => "US",
  "bill_addr_state" => "CO",
  "bill_addr_zip" => "201005",
  "cust_email" => "[email protected]",
  "cust_fname" => "Test James",
  "cust_lname" => "Bond",
  "cust_phone" => "9999333321",
  "pmt_expiry" => "12/2025",
  "pmt_key" => "111",
  "pmt_numb" => "4111111111111111",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "request_currency" => "USD",
  "transaction_type" => "AUTH",
  "xtl_order_id" => "000011112222",
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
  'request_currency': 'USD',
  'bill_addr': 'Apt#135, Shemwood St',
  'bill_addr_city': 'Denver',
  'bill_addr_country': 'US',
  'bill_addr_state': 'CO',
  'bill_addr_zip': '201005',
  'cust_email': '[email protected]',
  'cust_fname': 'Test James',
  'cust_lname': 'Bond',
  'xtl_order_id': '000011112222',
  'cust_phone': '9999333321',
  'transaction_type': 'AUTH',
  'pmt_key': '111',
  'pmt_numb': '4111111111111111',
  'pmt_expiry': '12/2025'
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=AUTH&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2025"

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=AUTH&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2025");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password',
    'amount' => '1.12',
    'request_currency' => 'USD',
    'bill_addr' => 'Apt#135, Shemwood St',
    'bill_addr_city' => 'Denver',
    'bill_addr_country' => 'US',
    'bill_addr_state' => 'CO',
    'bill_addr_zip' => '201005',
    'cust_email' => '[email protected]',
    'cust_fname' => 'Test James',
    'cust_lname' => 'Bond',
    'xtl_order_id' => '000011112222',
    'cust_phone' => '9999333321',
    'transaction_type' => 'AUTH',
    'pmt_key' => '111',
    'pmt_numb' => '4111111111111111',
    'pmt_expiry' => '12/2025'
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=AUTH&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2025'
});

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=AUTH&pmt_key=111&pmt_numb=4111111111111111&pmt_expiry=12%2F2025`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "AUTH",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "1.1200",
  "TRANS_REQUEST_ID": 1272,
  "TRANS_RECORD_ID": 79154,
  "TRANS_ORDER_ID": 0980982121,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

The table below only includes typical parameters sent in a simple Sales transaction request

**Required when pmt_numb, pmt_key, pmt_expiry are not present.

Authorization Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Cancel/Void Authorization

For CANCEL transaction, use this code:

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "0.1",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "transaction_type" => "CANCEL",
  "request_ref_po_id" => "0980982121"
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'request_ref_po_id': '0980982121',
  'transaction_type': 'CANCEL',
  'amount': '0.1',
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password'
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST \
"https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "request_ref_po_id=186434737&transaction_type=CANCEL&amount=0.1&req_username=sandbox_username&req_password=sandbox_password"

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'request_ref_po_id' => '0980982121',
    'transaction_type' => 'CANCEL',
    'amount' => '0.1',
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password'
);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'request_ref_po_id=186434737&transaction_type=CANCEL&amount=0.1&req_username=sandbox_username&req_password=sandbox_password'
});

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("request_ref_po_id=186434737&transaction_type=CANCEL&amount=0.1&req_username=sandbox_username&req_password=sandbox_password");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();
)
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

package main

import (
		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream(
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`request_ref_po_id=186434737&transaction_type=CANCEL&amount=0.1&req_username=sandbox_username&req_password=sandbox_password`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "CANCEL",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "0.1000",
  "TRANS_REQUEST_ID": 80282,
  "TRANS_RECORD_ID": 78443,
  "TRANS_ORDER_ID": 186434737,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

Merchants may request to refund the original sales transaction by sending CANCEL in the transaction_type parameter.

Cancel Transaction Parameters

The table below only includes typical parameters sent in a simple Authorization transaction request

Cancel Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Cancel Transaction Failed Response Fields

These are the fields returned to the merchant when a transaction has been declined by the Payment Service.

Capture Previously Authorization

Capture Transaction Parameters

require 'net/http'
require 'uri'

uri = URI.parse("https://api.paybybankful.com/api/transaction/api")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/x-www-form-urlencoded"
request["Cache-Control"] = "no-cache"
request.set_form_data(
  "amount" => "1.12",
  "bill_addr" => "Apt#135, Shemwood St",
  "bill_addr_city" => "Denver",
  "bill_addr_country" => "US",
  "bill_addr_state" => "CO",
  "bill_addr_zip" => "201005",
  "cust_email" => "[email protected]",
  "cust_fname" => "Test James",
  "cust_lname" => "Bond",
  "cust_phone" => "9999333321",
  "request_ref_po_id" => "0980982121",
  "req_password" => "sandbox_password",
  "req_username" => "sandbox_username",
  "request_currency" => "USD",
  "transaction_type" => "CAUTH",
  "xtl_order_id" => "000011112222"
)

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = {
  'req_username': 'sandbox_username',
  'req_password': 'sandbox_password',
  'amount': '1.12',
  'request_currency': 'USD',
  'bill_addr': 'Apt#135, Shemwood St',
  'bill_addr_city': 'Denver',
  'bill_addr_country': 'US',
  'bill_addr_state': 'CO',
  'bill_addr_zip': '201005',
  'cust_email': '[email protected]',
  'cust_fname': 'Test James',
  'cust_lname': 'Bond',
  'xtl_order_id': '000011112222',
  'cust_phone': '9999333321',
  'transaction_type': 'CAUTH',
  'request_ref_po_id': '0980982121'
}

response = requests.post('https://api.paybybankful.com/api/transaction/api', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/transaction/api" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "cache-control: no-cache" \
-d "req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAUTH&request_ref_po_id=0980982121"

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

	public static void main(String[] args) throws IOException {
		URL url = new URL("https://api.paybybankful.com/api/transaction/api");
		HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
		httpConn.setRequestMethod("POST");

		httpConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
		httpConn.setRequestProperty("cache-control", "no-cache");

		httpConn.setDoOutput(true);
		OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
		writer.write("req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAUTH&request_ref_po_id=0980982121");
		writer.flush();
		writer.close();
		httpConn.getOutputStream().close();

		InputStream responseStream = httpConn.getResponseCode() / 100 == 2
				? httpConn.getInputStream()
				: httpConn.getErrorStream();
		Scanner s = new Scanner(responseStream).useDelimiter("\\A");
		String response = s.hasNext() ? s.next() : "";
		System.out.println(response);
	}
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password',
    'amount' => '1.12',
    'request_currency' => 'USD',
    'bill_addr' => 'Apt#135, Shemwood St',
    'bill_addr_city' => 'Denver',
    'bill_addr_country' => 'US',
    'bill_addr_state' => 'CO',
    'bill_addr_zip' => '201005',
    'cust_email' => '[email protected]',
    'cust_fname' => 'Test James',
    'cust_lname' => 'Bond',
    'xtl_order_id' => '000011112222',
    'cust_phone' => '9999333321',
    'transaction_type' => 'CAUTH',
    "request_ref_po_id" => "0980982121"

);
$response = Requests::post('https://api.paybybankful.com/api/transaction/api', $headers, $data);

var fetch = require('node-fetch');

fetch('https://api.paybybankful.com/api/transaction/api', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'cache-control': 'no-cache'
    },
    body: 'req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAUTH&request_ref_po_id=0980982121'
});

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`req_username=sandbox_username&req_password=sandbox_password&amount=1.12&request_currency=USD&bill_addr=Apt%23135%2C%20Shemwood%20St&bill_addr_city=Denver&bill_addr_country=US&bill_addr_state=CO&bill_addr_zip=201005&cust_email=test.jamesbond%40example.com&cust_fname=Test%20James&cust_lname=Bond&xtl_order_id=000011112222&cust_phone=9999333321&transaction_type=CAUTH&request_ref_po_id=0980982121`)
	req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/transaction/api", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
	req.Header.Set("cache-control", "no-cache")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer resp.Body.Close()
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

The above command returns JSON structured like this:

{
  "REQUEST_ACTION": "CAPTURE",
  "TRANS_STATUS_NAME": "APPROVED",
  "TRANS_VALUE": "1.1200",
  "TRANS_REQUEST_ID": 1272,
  "TRANS_RECORD_ID": 79154,
  "TRANS_ORDER_ID": 0980982121,
  "XTL_ORDER_ID": "000011112222",
  "TRANS_CUR": "USD"
}

Make sure to replace req_username with your API key.

The table below only includes typical parameters sent in a simple Sales transaction request

Capture Transaction Success Response Fields

These are the fields returned to the merchant when a transaction has been approved by the Payment Service.

Card Tokenization

Location

The API Endpoint: https://api.paybybankful.com/api/integration/customer/card-tokenization

Method

POST

Create Card Token

For Create Card Token, use this code:

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://api.paybybankful.com/api/integration/customer/card-tokenization")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Cache-Control"] = "no-cache"
request.body = JSON.dump({
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password'
    "customer_details" => {
        "first_name" => "John",
        "last_name" => "Doe",
        "email" => "[email protected]",
        "phone" => "1234567890",
        "address_1" => "315 W 36th St",
        "address_2" => "",
        "city" => "New York",
        "state" => "NY",
        "zip" => "10018",
        "country" => "US",
    },
    "card_details": {
      "card_number": "4111111111111111",
      "card_exp_mm": "07",
      "card_exp_yy": "30",
      "card_cvv": "123"
    }
})

req_options = {
    use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(request)
end

import requests

headers = {
    'Content-Type': 'application/x-www-form-urlencoded',
    'cache-control': 'no-cache',
}

data = '{ "req_username": "sandbox_username", "req_password": "sandbox_password", "customer_details": { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "123456789", "address_1": "315 W 36th St", "address_2": "", "city": "New York", "state": "NY", "zip": "10018", "country": "US" }, "card_details": { "card_number": "4111111111111111", "card_exp_mm": "07", "card_exp_yy": "30", "card_cvv": "476" } }'

response = requests.post('https://api.paybybankful.com/api/integration/customer/card-tokenization', headers=headers, data=data)

curl -X POST "https://api.paybybankful.com/api/integration/customer/card-tokenization" \
-H 'Content-Type: application/json' \
-H "cache-control: no-cache" \
-d '{ "req_username": "sandbox_username", "req_password": "sandbox_password", "customer_details": { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "123456789", "address_1": "315 W 36th St", "address_2": "", "city": "New York", "state": "NY", "zip": "10018", "country": "US" }, "card_details": { "card_number": "4111111111111111", "card_exp_mm": "07", "card_exp_yy": "30", "card_cvv": "476" } }'

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;

class Main {

    public static void main(String[] args) throws IOException {
        URL url = new URL("https://api.paybybankful.com/api/integration/customer/card-tokenization");
        HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
        httpConn.setRequestMethod("POST");

        httpConn.setRequestProperty("Content-Type", "application/json");
        httpConn.setRequestProperty("cache-control", "no-cache");

        httpConn.setDoOutput(true);
        OutputStreamWriter writer = new OutputStreamWriter(httpConn.getOutputStream());
        writer.write("{ \"req_username\": \"sandbox_username\", \"req_password\": \"sandbox_password\", \"customer_details\": { \"first_name\": \"John\", \"last_name\": \"Doe\", \"email\": \"[email protected]\", \"phone\": \"123456789\", \"address_1\": \"315 W 36th St\", \"address_2\": \"\", \"city\": \"New York\", \"state\": \"NY\", \"zip\": \"10018\", \"country\": \"US\" }, \"card_details\": { \"card_number\": \"4111111111111111\", \"card_exp_mm\": \"07\", \"card_exp_yy\": \"30\", \"card_cvv\": \"476\" } }");
        writer.flush();
        writer.close();
        httpConn.getOutputStream().close();

        InputStream responseStream = httpConn.getResponseCode() / 100 == 2
                ? httpConn.getInputStream()
                : httpConn.getErrorStream();
        Scanner s = new Scanner(responseStream).useDelimiter("\\A");
        String response = s.hasNext() ? s.next() : "";
        System.out.println(response);
    }
}

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/json',
    'cache-control' => 'no-cache'
);
$data = array(
    'req_username' => 'sandbox_username',
    'req_password' => 'sandbox_password'
    'customer_details[first_name]' => 'John',
    'customer_details[last_name]' => 'Doe',
    'customer_details[address_1]' => '315 W 36th St',
    'customer_details[address_2]' => '',
    'customer_details[city]' => 'New York',
    'customer_details[state]' => 'NY',
    'customer_details[zip]' => '10018',
    'customer_details[country]' => 'US',
    'customer_details[email]' => '[email protected]',
    'card_details[card_number]' => '4111111111111111',
    'card_details[card_exp_mm]' => '07',
    'card_details[card_exp_yy]' => '30',
    'card_details[card_cvv]' => '123',
    
);
$response = Requests::post('https://api.paybybankful.com/api/integration/customer/card-tokenization', $headers, $data);

var request = require('request');

var headers = {
    'Content-Type': 'application/json',
    'cache-control': 'no-cache'
};

var dataString = '{ "req_username": "sandbox_username", "req_password": "sandbox_password", "customer_details": { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "123456789", "address_1": "315 W 36th St", "address_2": "", "city": "New York", "state": "NY", "zip": "10018", "country": "US" }, "card_details": { "card_number": "4111111111111111", "card_exp_mm": "07", "card_exp_yy": "30", "card_cvv": "476" } }';

var options = {
    url: 'https://api.paybybankful.com/api/integration/customer/card-tokenization',
    method: 'POST',
    headers: headers,
    body: dataString
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);

package main

import (
    "fmt"
    "io/ioutil"
    "log"
    "net/http"
    "strings"
)

func main() {
    client := &http.Client{}
    var data = strings.NewReader(`{ "req_username": "sandbox_username", "req_password": "sandbox_password", "customer_details": { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "123456789", "address_1": "315 W 36th St", "address_2": "", "city": "New York", "state": "NY", "zip": "10018", "country": "US" }, "card_details": { "card_number": "4111111111111111", "card_exp_mm": "07", "card_exp_yy": "30", "card_cvv": "476" } }`)
    req, err := http.NewRequest("POST", "https://api.paybybankful.com/api/integration/customer/card-tokenization", data)
    if err != nil {
        log.Fatal(err)
    }
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("cache-control", "no-cache")
    resp, err := client.Do(req)
    if err != nil {
        log.Fatal(err)
    }
    defer resp.Body.Close()
    bodyText, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%s\n", bodyText)
}