Banks of Australia

Interaction diagram

Payment processing by using the Banks of Australia payment method requires the merchant web service, one of the Monetix interfaces, and the Monetix payment platform, as well as the bank's technical facilities.

Operations support

	Interfaces			Amounts, AUD		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Payouts				50.00	5000.00	20 minutes	7 days

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section and click the Payment methods tab.

Processing scenarios

In the Banks of Australia method, to initiate a payout, you need to notify the customer via the merchant web service.

The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.

Supported banks

Payments through the Banks of Australia method are carried out through the banks that support the method. To initiate a payout by using Gate, you use bank identifiers.

The tables below provide information about supported banks.

General information

To perform a payout with the Banks of Australia method, the merchant's web service sends a request with all the required parameters and signature to the Monetix URL, and receives a callback with the payment result.

The complete sequence of the payout process is provided below.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Banks of Australia payment method and provide the information on the format of callbacks with payout results. For the general information on how to use the Gate API, see API Description.

Request format

There are several things you need to consider when dealing with payout requests in the Banks of Australia method:

1. You initiate a payout by sending a payout request to the /v2/payment/banks/australia/payout endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for online banking: /v2/payment/banks/{payment_method}/payout.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—IP address of the customer's device
     • email—customer email
     • account_id — PayID of the customer (alternative to bank account number);
   • account—object with customer account information:
     • number—customer account number
     • customer_name—customer full name
     • bank_id—ID of the bank
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency have no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of the payout currency in the ISO-4217 alpha-3 format
3. If required, you can also add any other additional parameters Gate supports.

Here is an example of the data from a payout request in the Banks of Australia method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "email": "johndoe@example.com",
        "account_id": "123456"
    },
    "account": {
        "number": "1234567890123456",
        "customer_name": "John Doe",
        "bank_id": "12345"
    },
    "payment": {
        "amount": 100000,
        "currency": "AUD"
    }
}

Callback format

The Banks of Australia method uses the standard format for callbacks to deliver payout results. For more information about callbacks, see Callbacks in Gate.

The following is the example of a callback with information about a successful 1000.00 AUD payout.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "method": "Australian banks",
        "sum": {
            "amount": 100000,
            "currency": "AUD"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "success",
        "date": "2022-03-25T11:08:45+0000",
        "created_date": "2022-03-25T11:08:05+0000",
        "request_id": "9e32835fb27907e0b08569d7d150e387a16a80e336c5117242b5cf60a4e17839",
        "sum_initial": {
            "amount": 100000,
            "currency": "AUD"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "AUD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4Xr4DSX2UuHp99rHrtaxkUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is the example of a callback for a declined payout.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_48",
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "method": "Australian banks",
        "sum": {
            "amount": 100000,
            "currency": "AUD"
        },
        "description": ""
    },
    "operation": {
        "id": 29,
        "type": "payout",
        "status": "decline",
        "date": "2022-03-25T11:20:30+0000",
        "created_date": "2022-03-25T11:19:53+0000",
        "request_id": "fff3d5f8d5d31bc460b68b57dc63f4b482e906eb",
        "sum_initial": {
            "amount": 100000,
            "currency": "AUD"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "AUD"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "J7W15rkqrLzTCD4HkoM4qoEnlVlf155QSlXJKR4m8C4z2iFYv58P4VnHANu445/jmY+g=="
}

Related topics

The following topics might be useful when implementing payments through Gate:

• Synchronous and asynchronous message processing
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

• single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
• as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.