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.

Features

Azupay PayTo supports the following features:
  • Direct capture - Payments are captured immediately at the time of authorization
  • Partial refunds - Refund a portion of the captured amount
  • Refunds - Refund transactions in full
  • Payment method tokenization - Store payment methods for future use

Supported countries

Azupay PayTo supports transactions from buyers in AU.

Supported currencies

Azupay PayTo supports processing payments in AUD.

Limitations

The following features are not supported by this connector:
  • Delayed capture - Authorizing a payment and capturing it later is not supported
  • Void - Canceling an authorized transaction before capture is not supported
  • Partial capture - Capturing a portion of the authorized amount is not supported
  • Over capture - Capturing more than the authorized amount is not supported
  • Partial authorization - Accepting a partial amount is not supported
  • Zero auth - Zero-dollar verification transactions are not supported
  • Transaction sync - Automatic transaction status synchronization is not supported
  • Settlement reporting - Automatic settlement reporting is not supported
Additional 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.CreateCheckoutSessionWithUrlPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "payto",
          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.