Example request:

curl --request POST \
    "http://localhost/paywho-api-system/public/api/reauthenticate_token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": null,
    \"password\": null
}"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/reauthenticate_token"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": null,
    "password": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://localhost/paywho-api-system/public/api/reauthenticate_token',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'username' => null,
            'password' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/reauthenticate_token'
payload = {
    "username": null,
    "password": null
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved Token Successfully",
    "data": {
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiN2JjNmVkNDUxZTYyNmY0MzRjMDgyMTE2NGE2MmM5MDQzYWNkYzQ1ODlkMWQ4M2JiYTc4NzU5MjYxMTY2MzYxZDQyY2EzZjUxMjYwMmVhOWYiLCJpYXQiOjE2ODY4MDMzMDkuNjkzMTY1MDYzODU4MDMyMjI2NTYyNSwibmJmIjoxNjg2ODAzMzA5LjY5MzE2Njk3MTIwNjY2NTAzOTA2MjUsImV4cCI6MTY4NzQwODEwOS42ODY2NTI4OTg3ODg0NTIxNDg0Mzc1LCJzdWIiOiIyMyIsInNjb3BlcyI6W119.iPiu4dt7-nbXNSyJn5NGjfmVWFJXV-nYm-xWMEvjGiAyPkLgjocSbV9wE0E2Ji1Lq8Xch6BI8-FLsOQItlEBgr8dOvvbRNGn5tx5WTru7TSxqWQpmOppFfUmICvZUpC8w-UJ5tgRpDAMEIU44iGMl9PWfIpQXQRGW0Z5Qd9g-vLFaIIsO-7q-UjpOqnIckrBdTczjAu3MANVHnDxbot7J6bW0YdbfnYrJV5lspAciOcdvAmOGvoYWEsGot0qM_unoBPAl9Ewsr66LtRsj9b_-doObQhwK4DpkYyASeEQvZNwgqn_pDwxKs0__fLRWlUSMhIuXNWjQBdWR3lXorkh6mWmXZkk1evYg9yWMyiINhA01WUKuyy27yK0OTS_xMl4CZdTi50FIJuLXKpRHu00jdktWqjTnnadVT40zFgFxLKaiSzdRifuHIIy-nlvWk74baLNcDYl9hgZa7dFS_771gawKfdDl2HcqyoLe4ZGTP-IdIpfy1ZpsmTvB2jPnQL1iuGCtahSpx40Er1dUkmwbQjNst3WJ6lFwcM_w9RDEj9RF3YHLZp-DuXjZwp5RlNxiAfJF0uKJfbwhv_nR4BUnMJ0Kmj0Jbrs-EoW1Avlrg4GaLXnK8FUhzoM_rWe5xRi7TG8qeeaEunxcj6OaH96ukxatFTGLKKYA4FGQILLZzM"
    }
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to get authorized token",
    "error_messages": "Incorrect User Credentials",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost/paywho-api-system/public/api/rfi-file/upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "customer_type=sender/receiver" \
    --form "field_name=IC" \
    --form "transaction_reference=CHN_C2C_ROUTING_NEW_08" \
    --form "file=@/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpp9gY9O" 

const url = new URL(
    "http://localhost/paywho-api-system/public/api/rfi-file/upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('customer_type', 'sender/receiver');
body.append('field_name', 'IC');
body.append('transaction_reference', 'CHN_C2C_ROUTING_NEW_08');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://localhost/paywho-api-system/public/api/rfi-file/upload',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'customer_type',
                'contents' => 'sender/receiver'
            ],
            [
                'name' => 'field_name',
                'contents' => 'IC'
            ],
            [
                'name' => 'transaction_reference',
                'contents' => 'CHN_C2C_ROUTING_NEW_08'
            ],
            [
                'name' => 'file',
                'contents' => fopen('/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpp9gY9O', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/rfi-file/upload'
files = {
  'file': open('/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpp9gY9O', 'rb')
}
payload = {
    "customer_type": "sender\/receiver",
    "field_name": "IC",
    "transaction_reference": "CHN_C2C_ROUTING_NEW_08"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files, data=payload)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Uploaded RFI file successfully",
    "data": ""
}
 

Example response (400):

{
    "status": "failed",
    "error": "Error occurred when validating user request",
    "error_messages": {
        "transaction_reference": [
            "The transaction_reference is required."
        ]
    },
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_transaction_status?transactionReference=" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_transaction_status"
);

const params = {
    "transactionReference": "",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_transaction_status',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'transactionReference' => '',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_transaction_status'
params = {
  'transactionReference': '',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved transaction status successfully",
    "data": {
        "transactionReference": "B2B_BANK_TRSF_SGPTESTING323",
        "sender_full_name": "JANG JANG CORPORATE",
        "beneficiary_full_name": "EMPTY OBJECT CORPORATE",
        "payout_amount": "10 SGD",
        "fx_rate": "0.997000",
        "fees": "1 SGD",
        "collected_amount": "0.00 SGD",
        "status": "Processing",
        "compliance_status": "Compliance Pending",
        "error": null,
        "error_code": null
    }
}
 

Example response (200):

{
    "status": "success",
    "message": "Retrieved transaction status successfully",
    "data": {
        "transactionReference": "B2B_BANK_TRSF_SGPTESTING323",
        "sender_full_name": "JANG JANG CORPORATE",
        "beneficiary_full_name": "EMPTY OBJECT CORPORATE",
        "payout_amount": "10 SGD",
        "fx_rate": "0.997000",
        "fees": "1 SGD",
        "collected_amount": "0.00 SGD",
        "status": "Rejected",
        "compliance_status": "Compliance Rejected",
        "error": "The account number is wrong.",
        "error_code": "99-01"
    }
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to retrieve transaction status",
    "error_messages": "Failed to retrieve transactions",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_available_countries" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_available_countries"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_available_countries',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_available_countries'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved available countries successfully",
    "data": [
        {
            "country": "CHN",
            "payoutMethod": {
                "id": 2,
                "description": "Unionpay Transfer"
            },
            "transferType": {
                "id": 3,
                "description": "C2C"
            }
        }
    ]
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to retrieve available countries",
    "error_messages": "Error",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/check_wallet_balance" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/check_wallet_balance"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/check_wallet_balance',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/check_wallet_balance'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved wallet balance successfully",
    "data": [
        {
            "balance": 9933.5426279,
            "currency": "SGD",
            "active": "1"
        }
    ]
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to retrieve wallet balance",
    "error_messages": "Error",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_all_transactions?startDate=1728630588&endDate=1728634836&itemsPerPage=20&page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_all_transactions"
);

const params = {
    "startDate": "1728630588",
    "endDate": "1728634836",
    "itemsPerPage": "20",
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_all_transactions',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'startDate' => '1728630588',
            'endDate' => '1728634836',
            'itemsPerPage' => '20',
            'page' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_all_transactions'
params = {
  'startDate': '1728630588',
  'endDate': '1728634836',
  'itemsPerPage': '20',
  'page': '1',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved all transactions successfully",
    "data": [
        {
            "transactionReference": "C2B_BANK_TRSF_SGPTESTING03",
            "system_id": "PW1767846425297692",
            "data": "{\"senderFirstName\":\"JANG\",\"senderLastName\":\"HYUK\",\"senderCountry\":\"GBR\",\"senderAddress\":\"SOMEWHERE IN JANG STREET 103\",\"senderCity\":\"SOMEWHERE IN JANG STREET 103\",\"senderZipCode\":\"123222\",\"senderCorporateCity\":\"JANG CITY\",\"senderCorporateZipCode\":12345,\"senderDateOfBirth\":\"2000-01-01\",\"senderNationality\":\"GBR\",\"senderIdType\":\"1\",\"senderIdNumber\":\"A12345\",\"senderIdIssueCountry\":\"GBR\",\"senderOccupation\":\"4\",\"receiverCorporateName\":\"EMPTY OBJECT CORPORATE\",\"receiverCorporateBankAccountNumber\":\"8976789\",\"receiverCorporateId\":\"EO123\",\"receiverCorporateBankId\":\"SG_ANZ\",\"receiverCorporateBankBranchCode\":\"014\",\"receiverCorporateZipCode\":\"12345\",\"receiverCorporateAddress\":\"GASOLINE ASIA ST 84\",\"receiverCorporateCity\":\"GAS GAS\",\"receiverCorporateMobile\":\"34567890\",\"receiverCorporateType\":4,\"receiverCorporateStructure\":2,\"receiverFirstName\":\"MR PLANK\",\"transferAmount\":100,\"transactionReference\":\"C2B_BANK_TRSF_SGPTESTING03\",\"senderSourceOfFund\":2,\"purposeOfRemittance\":1,\"transferType\":3,\"payoutMethod\":1,\"payoutCurrency\":\"SGD\",\"corridor_access\":27}",
            "status": "Processing"
        }
    ]
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to retrieve all transactions",
    "error_messages": "Error",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/refresh_token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/refresh_token"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/refresh_token',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/refresh_token'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Refreshed token successfully",
    "data": {
        "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiNGUyOTA2MjkzMTRiMGYzNWVjZTY2YjdkY2JmZWVhMTlhMGViODI0ZDRmZTdlOGE2MTg4NmI0NWNjODE4ZjBiOTcwMWM3OTk5NGMwY2EzNGYiLCJpYXQiOjE2ODY4MDQxMjUuMDQ1Mzk2MDg5NTUzODMzMDA3ODEyNSwibmJmIjoxNjg2ODA0MTI1LjA0NTM5ODk1MDU3Njc4MjIyNjU2MjUsImV4cCI6MTY4NzQwODkyNS4wNDE1ODA5MTU0NTEwNDk4MDQ2ODc1LCJzdWIiOiIyMyIsInNjb3BlcyI6W119.DNKPKqrOLN7FQADGICLI4MsWMTMo_7eyw8r9__NcORhZ7RixTDgk0Q9Euu_KQ7FIWhd80FDDSlrRWnbdV6IoW8zlwxpP4DVLDX67YM-lWaiU7GEqaD7-vsX6n6OstFfh7qC5HCA8nly2VAvwJLcTB1NDE3amZifFZUhSc6z-zjHFJ7BycovWEFRY2wDIt4uDltCeSHYVEnoB6jf7T0vX7g9n_udiilkI9Wj-x2WdOI11sKTrIVzBzUunLPY01WKyjnIVIqNPsWjU-KwqVkmq6KG5zB1HwSN5yJVYVv77fVpXc-cen9vpXCafs--E1QVLvtHVihorX4nbbf6txcjSUfPaotdOZvLbyg6cxt70YE1s9v2szLF4LoaRCylxduEDoNxoIaJp1Brc1ns_HU9Fogy3pnUcm23oFcCLewKbBWLP9vM4P0rK0PSN8jMTHMDM0bkE_P4l-Qd5b_xSJcBmjJh6k7SGVsfY18hjFZwa0z82iOWgbFyzrpKUNkc8xOXldfvBKuuXfvj-1l2nTPkxrK9s-BBft2WKgAcEm1J0236IYKUEaFzpzPyziqbQoM50CJOvnzkVPX0r6m9vNBajXW5PSXX8JS0c7Ez5e-DAtJLAmGLIR0hXjRXJCLwxMhJgpd1kBFl3UrTU8pzyhb4RCs6ongt0f9NnG_y6yX9HfqE"
    }
}
 

Example response (400):

{
    "status": "failed",
    "error": "System Error while refreshing token",
    "error_messages": "Error",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_fields_for_country?transferType=3&payoutMethod=1&payoutCurrency=SGD" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_fields_for_country"
);

const params = {
    "transferType": "3",
    "payoutMethod": "1",
    "payoutCurrency": "SGD",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_fields_for_country',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'transferType' => '3',
            'payoutMethod' => '1',
            'payoutCurrency' => 'SGD',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_fields_for_country'
params = {
  'transferType': '3',
  'payoutMethod': '1',
  'payoutCurrency': 'SGD',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
 "status": "success",
 "message": "Retrieved all fields successfully",
 "data": [
    {
        "field_name": "senderAddress",
        "field_type": "input",
        "fixed_field_value": null,
        "field_validation": "required|regex:/^[A-Za-z0-9 .,-]+$/",
        "field_description": "Provide sender's personal or residential details as applicable"
    },
    {
        "field_name": "senderCity",
        "field_type": "input",
        "fixed_field_value": null,
        "field_validation": "required|regex:/^[A-Za-z0-9 .,-]+$/",
        "field_description": "Provide sender's personal or residential details as applicable"
    },
 ]
}
 

Example response (400):

{
    "status": "failed",
    "error": "Error occurred when validating user request",
    "error_messages": "Failed to retrieve list of country details",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_exchange_rate?transferType=3&payoutMethod=1&payoutCurrency=SGD" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_exchange_rate"
);

const params = {
    "transferType": "3",
    "payoutMethod": "1",
    "payoutCurrency": "SGD",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_exchange_rate',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'transferType' => '3',
            'payoutMethod' => '1',
            'payoutCurrency' => 'SGD',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_exchange_rate'
params = {
  'transferType': '3',
  'payoutMethod': '1',
  'payoutCurrency': 'SGD',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved exchange rate successfully",
    "data": {
        "rate": "5.238141",
        "currency_pair": "SGD:CNY"
    }
}
 

Example response (400):

{
    "status": "failed",
    "error": "Error occurred when validating user request",
    "error_messages": {
        "transferType": [
            "The selected transfer type is invalid."
        ]
    },
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost/paywho-api-system/public/api/send_transaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"senderFirstName\": \"Harry\",
    \"senderLastName\": \"Maguire\",
    \"senderCountry\": \"GBR\",
    \"senderAddress\": \"Oxford Street\",
    \"senderCity\": \"London\",
    \"senderZipCode\": \"W1D 1BS\",
    \"senderCorporateCity\": \"London\",
    \"senderCorporateZipCode\": \"34512\",
    \"senderDateOfBirth\": \"2000-01-01\",
    \"senderNationality\": \"GBR\",
    \"senderIdType\": \"1\",
    \"senderIdNumber\": \"234543\",
    \"senderIdIssueCountry\": \"GBR\",
    \"senderOccupation\": \"4\",
    \"receiverCorporateName\": \"Nestle Pvt Ltd\",
    \"receiverCorporateBankAccountNumber\": \"8976789\",
    \"receiverCorporateId\": \"EO123\",
    \"receiverCorporateBankId\": \"SG_ANZ\",
    \"receiverCorporateBankBranchCode\": \"014\",
    \"receiverCorporateZipCode\": \"23881\",
    \"receiverCorporateAddress\": \"437 Orchard Road,\",
    \"receiverCorporateCity\": \"singapore\",
    \"receiverCorporateMobile\": \"34567890\",
    \"receiverCorporateType\": \"4\",
    \"receiverCorporateStructure\": \"2\",
    \"receiverFirstName\": \"MR Chang\",
    \"receiverLastName\": \"Hung\",
    \"transferAmount\": \"99.00\",
    \"transactionReference\": \"C2B_BANK_TRSF_SGP_TESTING_0121\",
    \"senderSourceOfFund\": \"2\",
    \"purposeOfRemittance\": \"1\",
    \"transferType\": \"3\",
    \"payoutMethod\": \"1\",
    \"payoutCurrency\": \"SGD\"
}"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/send_transaction"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "senderFirstName": "Harry",
    "senderLastName": "Maguire",
    "senderCountry": "GBR",
    "senderAddress": "Oxford Street",
    "senderCity": "London",
    "senderZipCode": "W1D 1BS",
    "senderCorporateCity": "London",
    "senderCorporateZipCode": "34512",
    "senderDateOfBirth": "2000-01-01",
    "senderNationality": "GBR",
    "senderIdType": "1",
    "senderIdNumber": "234543",
    "senderIdIssueCountry": "GBR",
    "senderOccupation": "4",
    "receiverCorporateName": "Nestle Pvt Ltd",
    "receiverCorporateBankAccountNumber": "8976789",
    "receiverCorporateId": "EO123",
    "receiverCorporateBankId": "SG_ANZ",
    "receiverCorporateBankBranchCode": "014",
    "receiverCorporateZipCode": "23881",
    "receiverCorporateAddress": "437 Orchard Road,",
    "receiverCorporateCity": "singapore",
    "receiverCorporateMobile": "34567890",
    "receiverCorporateType": "4",
    "receiverCorporateStructure": "2",
    "receiverFirstName": "MR Chang",
    "receiverLastName": "Hung",
    "transferAmount": "99.00",
    "transactionReference": "C2B_BANK_TRSF_SGP_TESTING_0121",
    "senderSourceOfFund": "2",
    "purposeOfRemittance": "1",
    "transferType": "3",
    "payoutMethod": "1",
    "payoutCurrency": "SGD"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://localhost/paywho-api-system/public/api/send_transaction',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'senderFirstName' => 'Harry',
            'senderLastName' => 'Maguire',
            'senderCountry' => 'GBR',
            'senderAddress' => 'Oxford Street',
            'senderCity' => 'London',
            'senderZipCode' => 'W1D 1BS',
            'senderCorporateCity' => 'London',
            'senderCorporateZipCode' => '34512',
            'senderDateOfBirth' => '2000-01-01',
            'senderNationality' => 'GBR',
            'senderIdType' => '1',
            'senderIdNumber' => '234543',
            'senderIdIssueCountry' => 'GBR',
            'senderOccupation' => '4',
            'receiverCorporateName' => 'Nestle Pvt Ltd',
            'receiverCorporateBankAccountNumber' => '8976789',
            'receiverCorporateId' => 'EO123',
            'receiverCorporateBankId' => 'SG_ANZ',
            'receiverCorporateBankBranchCode' => '014',
            'receiverCorporateZipCode' => '23881',
            'receiverCorporateAddress' => '437 Orchard Road,',
            'receiverCorporateCity' => 'singapore',
            'receiverCorporateMobile' => '34567890',
            'receiverCorporateType' => '4',
            'receiverCorporateStructure' => '2',
            'receiverFirstName' => 'MR Chang',
            'receiverLastName' => 'Hung',
            'transferAmount' => '99.00',
            'transactionReference' => 'C2B_BANK_TRSF_SGP_TESTING_0121',
            'senderSourceOfFund' => '2',
            'purposeOfRemittance' => '1',
            'transferType' => '3',
            'payoutMethod' => '1',
            'payoutCurrency' => 'SGD',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/send_transaction'
payload = {
    "senderFirstName": "Harry",
    "senderLastName": "Maguire",
    "senderCountry": "GBR",
    "senderAddress": "Oxford Street",
    "senderCity": "London",
    "senderZipCode": "W1D 1BS",
    "senderCorporateCity": "London",
    "senderCorporateZipCode": "34512",
    "senderDateOfBirth": "2000-01-01",
    "senderNationality": "GBR",
    "senderIdType": "1",
    "senderIdNumber": "234543",
    "senderIdIssueCountry": "GBR",
    "senderOccupation": "4",
    "receiverCorporateName": "Nestle Pvt Ltd",
    "receiverCorporateBankAccountNumber": "8976789",
    "receiverCorporateId": "EO123",
    "receiverCorporateBankId": "SG_ANZ",
    "receiverCorporateBankBranchCode": "014",
    "receiverCorporateZipCode": "23881",
    "receiverCorporateAddress": "437 Orchard Road,",
    "receiverCorporateCity": "singapore",
    "receiverCorporateMobile": "34567890",
    "receiverCorporateType": "4",
    "receiverCorporateStructure": "2",
    "receiverFirstName": "MR Chang",
    "receiverLastName": "Hung",
    "transferAmount": "99.00",
    "transactionReference": "C2B_BANK_TRSF_SGP_TESTING_0121",
    "senderSourceOfFund": "2",
    "purposeOfRemittance": "1",
    "transferType": "3",
    "payoutMethod": "1",
    "payoutCurrency": "SGD"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Transaction sent successfully",
    "data": {
        "message": "Processing Transaction. ",
        "transactionReference": "C2B_BANK_TRSF_SdssdsGP_TESTING_0121",
        "system_id": "PW1768660907084700",
        "approximate_fees": {
            "SGD_payout_amount": "10.00 SGD",
            "SGD:SGD": "0.997000",
            "SGD_collected_amount": "10.03 SGD",
            "SGD_collected_fees": "1.00 SGD",
            "SGD_total_collected_amount": "11.03 SGD"
        },
        "before_balance": "9977.66 SGD",
        "after_balance": "9966.63 SGD"
    }
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to send transaction",
    "error_messages": "Duplicate transaction reference exists. Please use a different reference ID.",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/get_list_of_banks?transferType=3&payoutMethod=1&payoutCurrency=SGD" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/get_list_of_banks"
);

const params = {
    "transferType": "3",
    "payoutMethod": "1",
    "payoutCurrency": "SGD",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/get_list_of_banks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'transferType' => '3',
            'payoutMethod' => '1',
            'payoutCurrency' => 'SGD',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/get_list_of_banks'
params = {
  'transferType': '3',
  'payoutMethod': '1',
  'payoutCurrency': 'SGD',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved bank list for country successfully",
    "data": []
}
 

Example response (400):

{
    "status": "failed",
    "error": "Error occurred when validating user request",
    "error_messages": "Failed to retrieve list of country details",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "http://localhost/paywho-api-system/public/api/fx-rates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/paywho-api-system/public/api/fx-rates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'http://localhost/paywho-api-system/public/api/fx-rates',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/fx-rates'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Retrieved exchange rate successfully",
    "data": [
        {
            "country_alpha_3_code": "IND",
            "currency_pair": "SGD:INR",
            "fx_rate": "60.55925656",
            "payout_method": "Bank Transfer",
            "transfer_type": "B2C"
        },
        {
            "country_alpha_3_code": "IND",
            "currency_pair": "SGD:INR",
            "fx_rate": "60.43777360",
            "payout_method": "Bank Transfer",
            "transfer_type": "C2B"
        }
    ]
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to retrieve exchange rate",
    "error_messages": "Failed to retrieve wallet",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://localhost/paywho-api-system/public/api/wallet_topup_request" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "amount=100.00" \
    --form "file=@/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpYOKjaC" 

const url = new URL(
    "http://localhost/paywho-api-system/public/api/wallet_topup_request"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('amount', '100.00');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'http://localhost/paywho-api-system/public/api/wallet_topup_request',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'amount',
                'contents' => '100.00'
            ],
            [
                'name' => 'file',
                'contents' => fopen('/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpYOKjaC', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'http://localhost/paywho-api-system/public/api/wallet_topup_request'
files = {
  'file': open('/private/var/folders/zs/28y9n8r51j343np891k8phcw0000gn/T/phpYOKjaC', 'rb')
}
payload = {
    "amount": "100.00"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, files=files, data=payload)
response.json()

Example response (200):

{
    "status": "success",
    "message": "Request for funds top up sent successfully.",
    "data": true
}
 

Example response (400):

{
    "status": "failed",
    "error": "Failed to topping up",
    "error_messages": "Error",
    "data": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.