Store a bank account

cURL

curl --request POST \
  --url https://api-sandbox.paychoice.com.au/api/v5/Bank_Token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bank[name]": "<string>",
  "bank[bsb]": "<string>",
  "bank[number]": "<string>",
  "merchant_guid": "<string>",
  "token": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "email": "<string>",
  "country": "<string>",
  "accounttype": "<string>",
  "holdertype": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    'bank[name]': '<string>',
    'bank[bsb]': '<string>',
    'bank[number]': '<string>',
    merchant_guid: '<string>',
    token: '<string>',
    firstname: '<string>',
    lastname: '<string>',
    email: '<string>',
    country: '<string>',
    accounttype: '<string>',
    holdertype: '<string>'
  })
};

fetch('https://api-sandbox.paychoice.com.au/api/v5/Bank_Token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-sandbox.paychoice.com.au/api/v5/Bank_Token"

payload = {
    "bank[name]": "<string>",
    "bank[bsb]": "<string>",
    "bank[number]": "<string>",
    "merchant_guid": "<string>",
    "token": "<string>",
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "country": "<string>",
    "accounttype": "<string>",
    "holdertype": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/Bank_Token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n  \"bank[name]\": \"<string>\",\n  \"bank[bsb]\": \"<string>\",\n  \"bank[number]\": \"<string>\",\n  \"merchant_guid\": \"<string>\",\n  \"token\": \"<string>\",\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"country\": \"<string>\",\n  \"accounttype\": \"<string>\",\n  \"holdertype\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/Bank_Token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bank[name]' => '<string>',
    'bank[bsb]' => '<string>',
    'bank[number]' => '<string>',
    'merchant_guid' => '<string>',
    'token' => '<string>',
    'firstname' => '<string>',
    'lastname' => '<string>',
    'email' => '<string>',
    'country' => '<string>',
    'accounttype' => '<string>',
    'holdertype' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "bank": {
    "bank_token": "9acf4194-3651-4414-8415-6b8eb74ece6d",
    "name": "John Citizen",
    "bsb": "123123",
    "number": "XXXXX3123",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "link": { "href": "/api/v5/bank_token/9acf4194-3651-4414-8415-6b8eb74ece6d", "rel": "self" }
  },
  "object_type": "bank"
}

POST

api

Bank_Token

cURL

curl --request POST \
  --url https://api-sandbox.paychoice.com.au/api/v5/Bank_Token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bank[name]": "<string>",
  "bank[bsb]": "<string>",
  "bank[number]": "<string>",
  "merchant_guid": "<string>",
  "token": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "email": "<string>",
  "country": "<string>",
  "accounttype": "<string>",
  "holdertype": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    'bank[name]': '<string>',
    'bank[bsb]': '<string>',
    'bank[number]': '<string>',
    merchant_guid: '<string>',
    token: '<string>',
    firstname: '<string>',
    lastname: '<string>',
    email: '<string>',
    country: '<string>',
    accounttype: '<string>',
    holdertype: '<string>'
  })
};

fetch('https://api-sandbox.paychoice.com.au/api/v5/Bank_Token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-sandbox.paychoice.com.au/api/v5/Bank_Token"

payload = {
    "bank[name]": "<string>",
    "bank[bsb]": "<string>",
    "bank[number]": "<string>",
    "merchant_guid": "<string>",
    "token": "<string>",
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "country": "<string>",
    "accounttype": "<string>",
    "holdertype": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/Bank_Token");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n  \"bank[name]\": \"<string>\",\n  \"bank[bsb]\": \"<string>\",\n  \"bank[number]\": \"<string>\",\n  \"merchant_guid\": \"<string>\",\n  \"token\": \"<string>\",\n  \"firstname\": \"<string>\",\n  \"lastname\": \"<string>\",\n  \"email\": \"<string>\",\n  \"country\": \"<string>\",\n  \"accounttype\": \"<string>\",\n  \"holdertype\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/Bank_Token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bank[name]' => '<string>',
    'bank[bsb]' => '<string>',
    'bank[number]' => '<string>',
    'merchant_guid' => '<string>',
    'token' => '<string>',
    'firstname' => '<string>',
    'lastname' => '<string>',
    'email' => '<string>',
    'country' => '<string>',
    'accounttype' => '<string>',
    'holdertype' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "bank": {
    "bank_token": "9acf4194-3651-4414-8415-6b8eb74ece6d",
    "name": "John Citizen",
    "bsb": "123123",
    "number": "XXXXX3123",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "link": { "href": "/api/v5/bank_token/9acf4194-3651-4414-8415-6b8eb74ece6d", "rel": "self" }
  },
  "object_type": "bank"
}

Stores bank account details and returns a token to use in place of the account on later charges (pass it as bank_token). Returns HTTP 200 on v4 and 201 Created on v5. bank[bsb] is not required for New Zealand accounts; supply the full 15–16 digit account number instead. This response has no paging fields.

{
  "bank": {
    "bank_token": "9acf4194-3651-4414-8415-6b8eb74ece6d",
    "name": "John Citizen",
    "bsb": "123123",
    "number": "XXXXX3123",
    "merchantguid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
    "link": { "href": "/api/v5/bank_token/9acf4194-3651-4414-8415-6b8eb74ece6d", "rel": "self" }
  },
  "object_type": "bank"
}

Authorizations

Authorization

string

header

required

Basic Authorization header using the Bearer scheme.

Body

bank[name]

string | null

bank[bsb]

string | null

bank[number]

string | null

merchant_guid

string | null

token

string | null

firstname

string | null

lastname

string | null

country

string | null

accounttype

string | null

holdertype

string | null

Response

200

Charges

Webhooks

Tokens

Refunds and pre-authorisations

Store a bank account

Authorizations

Body

Response