Skip to main content
Azupay PayTo is a bank payment method that allows buyers in Australia to pay directly from their bank account using a PayTo agreement. Azupay uses a redirect flow where the buyer approves the payment on the Azupay hosted page.

​
Setup

Azupay provides a self-service sign-up for a sandbox account. To sign up for an account, visit the sign-up page and follow the instructions.

​
Credentials

When setting up PayTo in the dashboard, configure the following credentials:
  • Client ID - The client ID provided as part of the Azupay account request form once the account is created.
  • Secret key - The secret key generated in the Azupay Dashboard under Settings > API Keys.

​
Capabilities

​
Supported countries

​
Supported currencies

​
Limitations

  • Concurrent refunds - Another refund cannot be initiated while there is an outstanding in-progress refund.

​
Webhooks

Azupay sends webhook events for every payment request status change. Ensure all webhook events are enabled:
  1. Log in to the Azupay Dashboard.
  2. Navigate to Settings > Payment Request webhook events.
  3. Set the webhook URL as defined by the connector.

​
Integration

The default integration for Azupay PayTo uses a redirect to a hosted payments page. Start by creating a new transaction with the following required fields. 
var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "AUD",
    Country = "AU",
    PaymentMethod =
      TransactionCreatePaymentMethod.CreateRedirectPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "payto",
          Country = "AU",
          Currency = "AUD",
          RedirectUrl = "https://example.com/callback",
        }
      ),
  }
);

amount := int64(1299)
currency := "AUD"
country := "AU"
method := components.RedirectPaymentMethodCreateMethodPayto
redirectUrl := "https://example.com/callback"

redirectPaymentMethodCreate := components.RedirectPaymentMethodCreate{
  Method: method,
  Country: country,
  Currency: currency,
  RedirectURL: redirectUrl,
}
paymentMethod := components.CreateTransactionCreatePaymentMethodRedirectPaymentMethodCreate(redirectPaymentMethodCreate)

transactionCreate := components.TransactionCreate{
  Amount:        amount,
  Currency:      currency,
  Country:       &country,
  PaymentMethod: &paymentMethod,
}

transaction, err := client.Transactions.Create(ctx, transactionCreate, nil, nil, nil)

CreateTransactionResponse transactionResponse = gr4vyClient.transactions().create()
  .transactionCreate(TransactionCreate.builder()
    .amount(1299L)
    .currency("AUD")
    .country("AU")
    .paymentMethod(TransactionCreatePaymentMethod.of(RedirectPaymentMethodCreate.builder()
      .method(RedirectPaymentMethodCreateMethod.PAYTO)
      .country("AU")
      .currency("AUD")
      .redirectUrl("https://example.com/callback")
      .build()))
    .build())
  .call();

Transaction transaction = transactionResponse.transaction().orElse(null);

$transactionCreate = new TransactionCreate(
  amount: 1299,
  currency: 'AUD',
  country: 'AU',
  paymentMethod: new RedirectPaymentMethodCreate(
    method: 'payto',
    country: 'AU',
    currency: 'AUD',
    redirectUrl: 'https://example.com/callback'
  )
);
$response = $client->transactions->create($transactionCreate);
$transaction = $response->transaction;

transaction: models.Transaction = client.transactions.create(
  amount=1299,
  currency="AUD",
  country="AU",
  payment_method={
    "method": "payto",
    "country": "AU",
    "currency": "AUD",
    "redirect_url": "https://example.com/callback",
  }
)

const transaction = await client.transactions.create({
  amount: 1299,
  currency: "AUD",
  country: "AU",
  paymentMethod: {
    method: "payto",
    country: "AU",
    currency: "AUD",
    redirectUrl: "https://example.com/callback"
  }
})
After the transaction is created, the API response includes a payment_method.approval_url and the status is set to buyer_approval_pending. The approval URL expires after 30 minutes. 
{
  "type": "transaction",
  "id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
  "payment_method": {
    "type": "payment-method",
    "approval_url": "https://cdn.gr4vy.com/connectors/..."
  },
  "method": "payto"
}
Redirect the buyer to the approval_url (open in a browser or Webview), where they can complete the payment. Once the buyer approves, the transaction progresses to a capture_succeeded state.