PayTo Pay by Bank

offers PayTo Pay by Bank, a payment method that enables your e-commerce customers to pay directly from their bank accounts. When using PayTo, your customers do not need to enter their card information. After you integrate PayTo into your checkout experience, your customers select the Pay by Bank option. This checkout option enables your customers to choose their bank from a list of trusted partner banks to authorize the payment. After payment approval, the funds transfer from your customer's account to your merchant account. This payment method is an account-to-account (A2A) transfer.

Benefits of Using PayTo Pay by Bank

PayTo provides these benefits for e-commerce payments:

• Enables fund transfers from the customer's account to your merchant bank account.
• Reduces customer data storage requirements.
• Uses a customer's bank authentication network to securely process payments.
• Avoids card processing fees.
• Supports mandates.

Supported Country and Currency

PayTo is available in Australia and supports payments using the Australian dollar (AUD).

Supported Services

Sale, refund, check status, and mandate services are available with PayTo Pay by Bank. For more information, see these sections:

• Sale
• Sale by Customer ID
• Refund
• Check Status
• Mandates

You can also subscribe to webhook notifications. With webhook subscriptions, automatically notifies you when a sale or a refund is complete. See Webhook Subscriptions.

Getting Started with REST

To process payments through , set up your payment processing system to be REST compliant. uses the REST architecture for developing web services. REST enables communication between a client and server using HTTP protocols.

If you have not set up secure communications between your client and server using either a JSON Web Token or HTTP signature, see Getting Started.

Transaction Processing

This section describes how to process transactions using the REST API.

Process a Payment Using a Redirect URL Workflow

This workflow illustrates a successful payment using PayTo Pay by Bank using the redirect URL method.

1. The customer begins to check out on your website and chooses the PayTo Pay by Bank payment option. This option enables the customer to choose their bank from a list of available partner banks.
2. You send a sale request to . For more information, see Sale.
3. responds with a PENDING status, sale request ID, and the PayTo redirect URL.
4. You redirect the customer to the PayTo URL.
5. The customer uses their bank account or PayID to approve the payment and is redirected to your website.
6. sends you an automatic SETTLED or FUNDED webhook notification when the sale is complete. For more information, see Webhook Subscriptions.
7. If you do not receive a webhook notification or have not enabled webhook notifications, you send periodic check status requests with the sale request ID to until you receive an updated status. For more information, see Check Status.
8. responds to your check status request with a SETTLED or FUNDED status. This status confirms that the payment is complete.
9. You confirm the payment.

Process a Payment Using a Customer ID Workflow

This workflow illustrates a successful payment using PayTo Pay by Bank using the customer ID method.

1. The customer begins to check out on your website and chooses the PayTo Pay by Bank payment option. The user enters their PayTo Alias ID on merchant checkout page. This option enables the customer to choose their bank from a list of available partner banks.
2. You send a sale request to . For more information, see Sale by Customer ID.
3. responds with a PENDING status and sale request ID.
4. sends you an automatic SETTLED or FUNDED webhook notification when the sale is complete. For more information, see Webhook Subscriptions.
5. If you do not receive a webhook notification or have not enabled webhook notifications, you send periodic check status requests with the sale request ID to until you receive an updated status. For more information, see Check Status.
6. responds to your check status request with a SETTLED or FUNDED status. This status confirms that the payment is complete.
7. You confirm the payment.

Refund Workflow

This workflow describes the sequence of events that comprises a successful PayTo Pay by Bank refund.

1. The customer returns the purchase to the merchant.
2. The merchant sends a refund API request to with the request ID from the successful capture. For more information, see Refund.
3. responds to the merchant with the PENDING status and a refund request ID.
4. The merchant sends periodic check status API requests to until the status updates. For more information, see Check Status.
5. responds to the merchant with the REFUNDED status when the refund is processed.
6. The merchant displays a refund confirmation to the customer.

Check Transaction Status Workflow

This workflow describes the sequence of possible statuses you can receive when processing a PayTo Pay by Bank transaction.

The merchant sends a check status API request to to verify the status of the sale and receives one of these statuses:

• FAILED: the sale request failed. A failed request can be due to either Pay by Bank rejecting the transaction or due to a technical error.
• FUNDED: the sale request is funded for the requested amount.
• PENDING: the sale request is accepted but is not complete. Request the check status service to retrieve status updates.
• SETTLED: the sale request is settled for the requested amount.

The merchant sends a check status API request to to verify the refund status and receives one of these statuses:

• FAILED: the refund request failed. A failed request can be due to PayTo Pay by Bank rejecting the transaction or due to a technical error.
• PENDING: the refund request is accepted but is not complete. Request the check status service to retrieve status updates.
• REFUNDED: the settled amount is refunded.

Mandates

This section describes how to manage mandates using the REST API.

A mandate is a series of recurring payments that you bill to a customer for a fixed amount at regular intervals. The series of mandates is the result of an agreement between you and the customer for the purchase of goods or services that are provided at regular intervals. Mandates are also known as subscriptions.

Create a Mandate Workflow

This workflow illustrates the successful creation of a mandate using PayTo Pay by Bank.

1. The customer begins to set up the subscription on your website and chooses the PayTo Pay by Bank payment option. This option enables the customer to choose their bank from a list of available partner banks.
2. You send a mandate API request to to create the subscription. For more information, see Mandates.
3. responds with a PENDING status, request ID, and the PayTo redirect URL if necessary.
4. The customer uses their bank account or PayID to approve the mandate and is redirected to your website.
5. sends you an automatic SETTLED or FUNDED webhook notification when the mandate creation is complete. For more information, see Webhook Subscriptions.
6. If you do not receive a webhook notification or have not enabled webhook notifications, you send periodic check status requests with the sale request ID to until you receive an updated status. For more information, see Mandates.
7. responds to your check status request with a SETTLED or FUNDED status.
8. You confirm the mandate.

Cancel a Mandate Workflow

This workflow describes the sequence of events that comprises the successful cancellation of a PayTo Pay by Bank mandate.

1. The customer requests to cancel their subscription.
2. The merchant sends a cancel mandate API request to with the request ID retrieved when creating the recurring payment. For more information, see Mandates.
3. responds to the merchant with the PENDING status and a cancellation request ID.
4. The merchant sends periodic check status API requests to until the status updates. For more information, see Mandates.
5. responds to the merchant with the CANCELLED status when the request is processed.
6. The merchant displays a cancellation confirmation to the customer.