Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75"
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "complete",
"confirm_status": "confirmed",
"card_type": "mastercard",
"card_no": "4111111111111111",
"cvv": "321",
"expiry_month": "04", // MM
"expiry_year": "2027" // YYYY
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"bsb": "012002",
"account_number": "111136"
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}Receiver Notifications
Batch Notifications
{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"iban": "DE89370400440532013000",
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"iban": "DE89370400440532013000",
"bic": "DEUTDEFFXXX",
"bank_country_code": "DE",
"bank_name": "Deutsche Bank"
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"receiver_id": "f85cbb74-6af7-43cb-b0a2-b5e5b9838de6",
"account_id": "ad5ac900-ac63-4e60-894b-1de10f04f876",
"amount": 2000, // cent
"currency": "AUD",
"reference": "ref-16aud",
"note": "Payout for Frank"
}{
"message": "Payout created successfully",
"payload": {
"payout_id": "44389fbd-5931-431a-bcac-cfb73ccc6494"
}
}{
"message": "There was an error while creating a payout",
"error": [
{
"code": "PAYO201",
"message": "Receiver not found"
}
]
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"routing_number": "021000128", // 9 digits and startig with '0'
"account_number": "123456789", // 9 digits
"account_type": "checking" // Can be either "checking" or "savings"
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"event": "receiverCreated",
"receiver_id": "e4908c83-6656-408a-8ba2-61dae8f039a5",
"subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
"status": "active",
"kyc_status": "pending",
"timestamp": 1710091407112
}{
"event": "receiverKycUpdate",
"receiver_id": "e4908c83-6656-408a-8ba2-61dae8f039a5",
"subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
"kyc_status": "completed",
"timestamp": 1710091428000
}{
"event": "batchUpdate",
"amount": 2440,
"currency": "AUD",
"batch_id": "13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
"status": "queue",
"batch_run_time": 1724965200000,
"batch_reference": "BATCH_13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
"process_amount": 0,
"total_failed": 0,
"total_tx": 1,
"subccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"created_at": 1710084228000,
"timestamp": 1710091428000
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"routing_number": "000102959", // 9 digits and startig with '0'
"account_number": "123456789", // 9 digits
"account_type": "checking" // Can be either "checking" or "savings"
}Payout Notifications
{
"message": "Payout found",
"payload": {
"id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
"created_at": "1710144053053",
"provider_reference": "dev-ref-a00020",
"batch_id": "",
"asset": "AUD",
"reference": "dev-ref-a00020",
"merchant": "MERC#9f05dc98-47bd-47f2-a039-8d9889fdfb7a",
"fee_data": {
"fee_value": "200",
"feetemplate_id": "10543412-9de9-4adb-814c-60fd5ea4aba8",
"fixed": 0,
"feegroup_id": "4d8d52ee-47e8-425b-9677-878b127147b9",
"percentage": 10,
"min_amount": 20
},
"note": "devid a00020",
"payout_data": {
"status": "IN PROGRESS",
"transaction_is_duplicated": false,
"receiver_is_invalid": false,
"accepted": true,
"errors": null,
"transaction_id": "20020105",
"sender_is_invalid": false
},
"status": "successful",
"amount": 2000,
"subaccount": {
"id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f"
},
"receiver": {
"id": "e4908c83-6656-408a-8ba2-61dae8f039a5",
"firstname": "Devid-A",
"lastname": "Tesla",
"email": "[email protected]"
},
"receiver_account": {
"id": "6afec8ad-c026-463b-9f09-f60adfae10a0",
"email": "[email protected]",
"bsb": "012002",
"bank_code": "ANZ",
"account_number": "223344556677"
},
"payout_provider": {
"id": "eb68d16a-d395-4acd-a8bf-d01de92f949b"
},
"transactions": [
{
"transaction_id": "6af8c51c-e8d6-4ba5-b3d7-c966b9f14fb9",
"amount": -1800,
"asset": "AUD",
"status": "complete",
"created_at": "1710144077857",
"updated_at": "1710144379146",
"transaction_type": "payout"
},
{
"transaction_id": "4eefc21c-286e-48d9-82a8-788bfbd4175f",
"amount": -200,
"asset": "AUD",
"status": "complete",
"created_at": "1710144077857",
"updated_at": "1710144379226",
"transaction_type": "fee"
}
]
}
}/api/payout/3971f24a-b901-4bdb-b3a5-7690ca350cd3{
"message": "Get payout failed",
"error": [
{
"code": "PAYO101",
"message": "Payout ID not found"
}
]
}/api/payout?subaccount_id=3dc81811-8cdb-49c6-8f9e-9125ea4540b0&from=2024-02-08 09:00&to=2024-03-11 06:21&limit=1{
"message": "Payout found",
"payload": [
{
"id": "ce74a54d-cd7d-475b-8213-b70a7a9c47e0",
"created_at": "1707384569939",
"provider_reference": "ref-22aud",
"batch_id": "",
"asset": "AUD",
"reference": "ref-22aud",
"fee_data": {
"feetemplate_id": "10543412-9de9-4adb-814c-60fd5ea4aba8",
"fixed": 0,
"feegroup_id": "4d8d52ee-47e8-425b-9677-878b127147b9",
"percentage": 10,
"min_amount": 20
},
"note": "22 AUD payout",
"payout_data": {
"status": "PENDING",
"transaction_is_duplicated": false,
"receiver_is_invalid": false,
"accepted": true,
"errors": null,
"transaction_id": "20019915",
"sender_is_invalid": false
},
"status": "pending",
"amount": "2200",
"subaccount": {
"id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f"
},
"receiver": {
"id": "617fc7a4-70e2-47d3-a5b0-84a5bc17a4a0",
"firstname": "Exel",
"lastname": "Receiver",
"email": "[email protected]"
},
"receiver_account": {
"id": "fdf427df-1093-4d77-84a7-b08ac67f453f",
"email": "[email protected]",
"bsb": "012040",
"bank_code": "ANZ",
"account_number": "111111222255"
},
"payout_provider": {
"id": "eb68d16a-d395-4acd-a8bf-d01de92f949b"
}
],
"lastkey": "eyJlbnRpdHkiOiJQQVlPIyIsIlBLIjoiUEFZTyM2ODNlN2UwMS0yOWI2LTQ4ZDMtOTNlZi1kODIyNzU3ZmIxOWUiLCJTSyI6IlJFVlIjMTkwNjgwZTEtZjRjNC00ZTkwLTkyOTgtODA3M2NlZWY5MmVlIiwiY3JlYXRlZF9hdCI6IjE3MTkzNjU5MTEwMzUifQ=="
}{
"event": "payoutUpdate",
"amount": 2000,
"currency": "AUD",
"payout_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
"batch_id": "b4ac0283-354c-4008-9b25-0338198b6fa0",
"batch_run_time": 1710282140000,
"receiver_account_id": "6afec8ad-c026-463b-9f09-f60adfae10a0",
"receiver_id":"e4908c83-6656-408a-8ba2-61dae8f039a5",
"reference": "ref-a00020",
"status": "successful",
"subccount_id": "ccb93d70-00d0-4ec4-a454-32bfc8e8428f",
"timestamp": 1710091428000
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"account_number": "123456-0789123-00"
}{
"message": "Receiver account created successfully",
"payload": {
"receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"status": "pending",
"confirm_status": "unconfirmed"
}
}{
"message": "There was an error while creating a receiver account",
"error": [
{
"code": "REAC211",
"message": "Receiver ID is not valid"
}
]
}{
"receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
"recipient": "[email protected]",
"name": "John Doe Inc."
}{
"message": "Subaccount found",
"payload":
{
"id": "fa9c386d-5dce-4b81-a50d-769386360aff",
"merchant_id": "df28d384-6a44-47aa-887d-5a2560fc697d",
"suba_name": "Sandbox subaccount",
"title": "Mr.",
"first_name": "Sandbox",
"last_name": "Teslastudio",
"email": "[email protected]",
"dob": "1989-10-20",
"kassi_status": "ACCEPTED",
"business_name": "Teslastudio Demo A",
"business_or_individual": "B",
"support_email": "[email protected]",
"mobile_dialcode": "+61",
"mobile": "483908899",
"home_phone_international_dialcode": "+61",
"home_telephone": "434343434",
"address_data": {
"address": "443 Sri Ayudhya Road",
"suburb": "Bangkok",
"state": "Ratchathewi",
"country": "THA",
"postcode": "10400"
},
"has_passed_kyc": "N/A",
"kyc_status": "pending",
"postback_url": "https://eobmbgwd9o1xe0t.m.pipedream.net",
"sms_provider": "cellcast",
"email_provider": "sendgrid",
"created_at": "1707799593596"
}
}/api/subaccount/3dc81811-8cdb-49c6-8f9e-9125ea4540b0{
"message": "Get SubAccount failed",
"error": [
{
"code": "SUBA101",
"message": "SubAccount not found"
}
]
}{
"id": "c111f9ee-5a42-496c-94ad-9645ebd2004b", // payout_id or batch_id
"type": "payout", // payout or batch
"status": "success" // success or fail
}{
"statusCode": 200,
"message": "Test helper: Update payout status is successful"
}{
"receiver_id": "8d6b0a9a-cd88-4bdc-a6d2-986ab94545cf"
}{
"statusCode": 200,
"message": "Receiver deleted successfully"
}{
"statusCode": 400,
"message": "There was an error while processing test helper",
"error": [
{
"code": "TEST003",
"message": "Cannot delete receiver with existing receiver accounts"
}
]
}{
"message": "balance found",
"payload": {
"available": 958638,
"pending": 17526,
"asset": "AUD"
}
}{
"message": "Get balance failed",
"error": [
{
"code": "SUBA304",
"message": "Asset is not valid"
}
]
}/api/subaccount/balance/3dc81811-8cdb-49c6-8f9e-9125ea4540b0?asset=aud{
"bsb": "123456"
}{
"bsb": "123456",
"account_number": "123456789"
} {
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"account_data": {
"bsb": "123456",
"account_number": "123456789"
}
} {
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"account_data": {
"account_number": "123456789",
"routing_number": "021000021",
"account_type": "checking"
}
} {
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"account_data": {
"account_number": "123456119",
"routing_number": "011401533",
"account_type": "savings"
}
} {
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"account_data": {
"iban": "DE89370400440532013000",
"bic": "COBADEFFXXX"
}
} {
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
"account_data": {
"account_number": "12-3456-1234567-00"
}
} {
"exists": true,
"receiver_id": "b367730a-6837-43e9-9b19-af910f4b8000",
"account_id": "cdad7781-4169-4129-940d-c15077a46e86",
"account_data": {
"bsb": "012 ***",
"account_number": "111 ***"
}
}{
"message": "Missing or invalid subaccount_id or account_data"
}const CryptoJS = require("crypto-js");
const axios = require("axios");
const apiDomain = "{{API_DOMAIN}}";
const api_key = "{{API_KEY}}";
const api_secret = "{{API_SECRET}}";
async function sendRequest () {
const apiPath = "/api/payout/single";
const httpMethod = "POST";
let nonce = new Date().getTime();
const signedPayload = `${nonce}.${api_key}`;
const expectedSignature = CryptoJS.HmacSHA256(signedPayload, api_secret).toString();
let sig = nonce + "." + expectedSignature;
try {
const data = {
receiver_id: "a0bb742e-2b17-4698-be2d-3226c64aec03",
account_id: "6dea4c0d-7825-4636-a0b0-c4895d451244",
amount: 2121,
currency: "AUD",
reference: "ref2121",
note: "Payout for Mike 2121"
};
const resp = await axios(`${apiDomain}${apiPath}`, {
method: httpMethod,
headers: {
"x-api-key": api_key,
"signature": sig,
},
data: data
});
console.log("Result: ", resp.data);
} catch (error) {
console.log("error", error.response.data);
}
}
sendRequest();Account Notifications
{
"event": "accountCreated",
"bsb": "***003",
"account_number": "****2179",
"receiver_id": "3971f24a-b901-4bdb-b3a5-7690ca350cd3",
"receiver_account_id": "6afec8ad-c026-463b-9f09-f60adfae10a0",
"status": "completed",
"confirm_status": "unconfirmed",
"timestamp": 1710091428000
}{
"subaccount_id": "3dc81811-8cdb-49c6-8f9e-9b25ea4544b7"
"first_name": "David",
"last_name": "Lahm",
"middle_name": "Robert",
"email":"[email protected]",
"dob": "1990-03-21",
"dialcode": "61",
"phone": "213094857",
"address": "122 Grenfell St",
"gender": "M",
"city": "Adelaide",
"state": "SA",
"postcode": "5000",
"country": "AUS",
"reference": "david8740"
}{
"message": "Receiver created successfully",
"payload": {
"receiver_id": "d81b714c-a082-431a-8935-d0c67ad22c2d",
"first_name": "David",
"last_name": "Lahm",
"email": "[email protected]"
}
}{
"message": "There was an error while creating a receiver",
"error": [
{
"code": "REVR201",
"message": "Email already exist"
}
]
}{
"message": "Receiver Account found",
"payload": {
"id": "6dea4c0d-7825-4636-a0b0-c4895d451244",
"email": "[email protected]",
"asset": "AUD",
"method_name": "direct-entry",
"reference": "4464",
"address_data": {
"address": "111/22222",
"address2": "Paklok Rd",
"city": "Phuket",
"state": "PK",
"country": "THA",
"postcode": "83110"
},
"account_data": {
"account_number": "***** 1136",
"bsb": "*** 002"
}
},
}/api/receiver-account/6dea4c0d-7825-4636-a0b0-c4895d451244{
"message": "Get receiver account failed",
"error": [
{
"code": "REAC104",
"message": "Receiver ID not found"
}
]
}/api/receiver-account/receiver/a6980641-e785-447a-960d-036bd29c5ece{
"message": "Receiver Account found",
"payload": [
{
"id": "6dea4c0d-7825-4636-a0b0-c4895d451244",
"email": "[email protected]",
"asset": "AUD",
"method_name": "direct-entry",
"reference": "4464",
"address_data": {
"address": "111/22222",
"address2": "Paklok Rd",
"city": "Phuket",
"state": "PK",
"country": "THA",
"postcode": "83110"
},
"account_data": {
"account_number": "***** 1136",
"bsb": "*** 002"
}
},
{
"id": "e5b088e1-cf4a-4e91-bb65-3c7e07b9b314",
"email": "[email protected]",
"asset": "AUD",
"method_name": "direct-entry",
"reference": "5589",
"address_data": {
"address": "88/99999",
"address2": "Evergreen Terrace",
"city": "Springfield",
"state": "SP",
"country": "USA",
"postcode": "49007"
},
"account_data": {
"account_number": "***** 4455",
"bsb": "*** 200"
}
}
]
}{
"message": "Get receiver account failed",
"error": [
{
"code": "REAC101",
"message": "Receiver Account ID not found"
}
]
}{
"message": "Receiver found",
"payload": {
"id": "8ae6b25e-d08f-4391-84ae-fa7bd061b9ee",
"first_name": "Xcel",
"last_name": "Tesla",
"middle_name": "",
"email": "[email protected]",
"gender": "M",
"dob": "1973-12-12",
"dialcode": "61",
"phone": "483908899",
"applicant_id": "65f272e2341af77124132294",
"kyc_status": "pending",
"status": "pending",
"created_at": "1710387933592",
"address_data": {
"address": "992A Stanley St E",
"address2": "",
"city": "East Brisbane",
"state": "QLD",
"country": "AUS",
"postcode": "6008"
},
"reference": "ref-xcel"
}
}/api/receiver/8ae6b25e-d08f-4391-84ae-fa7bd061b9ee{
"message": "Get receiver failed",
"error": [
{
"code": "REVR101",
"message": "Receiver ID not found"
}
]
}/api/receiver?subaccount_id=3dc81811-8cdb-49c6-8f9e-9125ea4540b0&status=2&kyc_status=1&limit=2{
"message": "Receiver found",
"payload": [
{
{
"id": "7e4b88bf-9b99-4d3e-8a93-dc5e91b6ce2c",
"first_name": "Marina",
"last_name": "Quartz",
"middle_name": "",
"email": "[email protected]",
"gender": "F",
"dob": "1986-07-24",
"dialcode": "44",
"phone": "7712345678",
"kyc_status": "pending",
"status": "pending",
"created_at": "1710023456789",
"address_data": {
"address": "111/22222",
"address2": "Paklok Rd",
"state": "PK",
"city": "Phuket",
"country": "THA",
"postcode": "83110"
},
"reference": "ref-marina-1"
},
{
"id": "9b3773e1-cb8e-4b9a-bc68-4e5011b8d30f",
"first_name": "Leonardo",
"last_name": "Fibonacci",
"middle_name": "",
"email": "[email protected]",
"gender": "M",
"dob": "1990-03-14",
"dialcode": "39",
"phone": "4881234567",
"kyc_status": "pending",
"status": "pending",
"created_at": "1710112233445",
"address_data": {
"address": "55/66666",
"address2": "Renaissance Road",
"state": "RR",
"city": "Florence",
"country": "ITA",
"postcode": "50125"
},
"reference": "ref-leonardo-1"
}
],
"lastkey": "eyJlbnRpdHkiOiJSRVZSIyIsIlBLIjoiUkVWUiMyZTg1MGY1ZS1iMzQ2LTRlOWEtYjhkNi1hYWVjMzE5YTkwOWQiLCJTSyI6IlNVQkEjM2RjODE4MTEtOGNkYi00OWM2LThmOWUtOTEyNWVhNDU0MGIwIiwiY3JlYXRlZF9hdCI6IjE3MTk5ODAzOTM4MTYifQ=="
}