{"title":"PayTo","category":"payment_method","creationDate":1784905308,"content":"
\n

\"payto-logo\"  Read more<\/strong><\/p>

Learn more about PayTo on payto.com.au<\/a>.<\/p><\/div><\/div>\n\n

PayTo is a real-time, account-to-account payment method built on Australia's New Payments Platform (NPP)<\/a>. It enables merchants to accept both one-off and recurring payments directly from shoppers' bank accounts with real-time authorization through banking apps, lower processing costs, and flexible mandate management.<\/p>\n\n \n \n \n \n
\n Payment type\n <\/th>\n \n Payment flow\n <\/th>\n \n Countries\n <\/th>\n \n Currencies\n <\/th>\n \n Recurring<\/a>\n <\/th>\n \n Refunds<\/a>\n <\/th>\n \n Partial refunds<\/a>\n <\/th>\n \n Multiple partial refunds<\/a>\n <\/th>\n \n Separate captures<\/a>\n <\/th>\n \n Partial captures<\/a>\n <\/th>\n \n Multiple partial captures<\/a>\n <\/th>\n \n Chargebacks<\/a>\n <\/th>\n <\/tr>\n <\/thead>\n
\n Real-time payments\n <\/td>\n \n Direct\n <\/td>\n \n AU\n <\/td>\n \n AUD\n <\/td>\n \n \"checkmark\"<\/br>\n <\/td>\n \n \"checkmark\"<\/br>\n <\/td>\n \n \"checkmark\"<\/br>\n <\/td>\n \n \"checkmark\"<\/br>\n <\/td>\n \n \"x\"<\/br>\n <\/td>\n \n \"x\"<\/br>\n <\/td>\n \n \"x\"<\/br>\n <\/td>\n \n \"x\"<\/br>\n <\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n\n

Add PayTo as a payment method<\/h2>\n

Enable PayTo for your merchant account using the Management API<\/a>.<\/p>\n

Management API<\/h3>\n

Make a POST \/paymentMethodSettings<\/a> request and include:<\/p>\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
type<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nMust be payto<\/strong><\/span>.<\/td>\npayto<\/strong><\/span><\/td>\n<\/tr>\n
payto.merchantName<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nBusiness name displayed in shopper's banking app.<\/td>\nACME Subscriptions Pty Ltd<\/strong><\/span><\/td>\n<\/tr>\n
payto.payToPurpose<\/a><\/td>\n\"-white_check_mark-\"<\/td>\nDefault purpose code (see valid values below).<\/td>\nretail<\/strong><\/span><\/td>\n<\/tr>\n
businessLineId<\/a><\/td>\n\"Conditionally<\/span><\/td>\nConditional: Your business line identifier. Optional, unless you are using the platform model.<\/td>\nSE12345678912345ABCDEFG<\/strong><\/span><\/td>\n<\/tr>\n
storeIds<\/a><\/td>\n\"Conditionally<\/span><\/td>\nConditional: Only required when configuring the payment method for a specific store.<\/td>\n[\"ST123...\"]<\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n

PayTo setup is asynchronous. To confirm PayTo was added:<\/p>\n

    \n
  1. Configure a payment method webhook via Customer Area or Management API.<\/li>\n
  2. Listen for the paymentMethod.created<\/code> event.<\/li>\n<\/ol>\n

    Example webhook confirmation:<\/p>\n

    \n <\/code-sample>\n<\/div>\n

    If the status<\/code> is success<\/strong>, PayTo is ready for use.<\/p>\n

    For webhook configuration, see Configure and manage webhooks<\/a>.<\/p>\n

    \n

    Adding PayTo on the Customer Area is currently not available.<\/p>\n<\/div>\n

    Payments flow<\/h2>\n

    A typical payment flow includes:<\/p>\n

    First payment<\/strong><\/p>\n

      \n
    1. Call \/paymentMethods<\/a> to confirm which payment methods are available for the payment, showing PayTo if included in the response.<\/li>\n
    2. Collect customer details and submit a \/payments<\/a> request with the appropriate details. Adyen creates an agreement with the customer's bank.<\/li>\n
    3. \n

      The customer will be shown a pending screen while they confirm the payment in their banking app. Successful payment is confirmed via webhook notification from Adyen.<\/p>\n

      First payment and mandate creation<\/strong><\/p>\n

      CnNlcXVlbmNlRGlhZ3JhbQphdXRvbnVtYmVyCnBhcnRpY2lwYW50IFNob3BwZXIKcGFydGljaXBhbnQgTWVyY2hhbnQKcGFydGljaXBhbnQgQWR5ZW4KcGFydGljaXBhbnQgTlBQCnBhcnRpY2lwYW50IEJhbmsKCiAgICAlJSBTdGVwIDE6IENoZWNrIFBheW1lbnQgTWV0aG9kcwogICAgTWVyY2hhbnQtPj5BZHllbjogUE9TVCAvcGF5bWVudE1ldGhvZHMgKGNvdW50cnlDb2RlOiBBVSwgc2hvcHBlclJlZmVyZW5jZSkKICAgIEFkeWVuLS0+Pk1lcmNoYW50OiBQYXlUbyBpbmNsdWRlZCBpbiByZXNwb25zZQogICAgTWVyY2hhbnQtPj5TaG9wcGVyOiBEaXNwbGF5IFBheVRvIG9wdGlvbgoKICAgICUlIFN0ZXAgMjogSW5pdGlhdGUgUGF5bWVudCAmIE1hbmRhdGUKICAgIFNob3BwZXItPj5NZXJjaGFudDogUHJvdmlkZXMgUGF5SUQgb3IgQlNCLCBpbml0aWF0ZXMgcGF5bWVudAogICAgTWVyY2hhbnQtPj5BZHllbjogUE9TVCAvcGF5bWVudHMgKHNob3BwZXJBY2NvdW50SWRlbnRpZmllciwgbWFuZGF0ZSwgc3RvcmVQYXltZW50TWV0aG9kOiB0cnVlKQogICAgQWR5ZW4tLT4+TWVyY2hhbnQ6IHJlc3VsdENvZGU6IFBlbmRpbmcgKyBhY3Rpb24gKGF3YWl0KQogICAgTWVyY2hhbnQtPj5TaG9wcGVyOiBTaG93IHBlbmRpbmcgc2NyZWVuCgogICAgJSUgU3RlcCAzOiBNYW5kYXRlIEFwcHJvdmFsIHZpYSBOUFAgJiBCYW5rCiAgICBBZHllbi0+Pk5QUDogQ3JlYXRlIG1hbmRhdGUgcmVxdWVzdAogICAgTlBQLT4+QmFuazogUHVzaCBub3RpZmljYXRpb24KICAgIEJhbmstPj5TaG9wcGVyOiBNYW5kYXRlIGFwcHJvdmFsIHJlcXVlc3QgKGJhbmtpbmcgYXBwKQogICAgU2hvcHBlci0+PkJhbms6IENvbmZpcm1zIG1hbmRhdGUKICAgIEJhbmstPj5OUFA6IE1hbmRhdGUgY29uZmlybWVkCiAgICBOUFAtLT4+QWR5ZW46IENvbmZpcm1hdGlvbgoKICAgICUlIFN0ZXAgNDogRmlyc3QgUGF5bWVudCBFeGVjdXRpb24gJiBXZWJob29rcwogICAgQWR5ZW4tPj5OUFA6IEV4ZWN1dGUgZmlyc3QgcGF5bWVudAogICAgTlBQLT4+QmFuazogRGViaXQgYWNjb3VudAogICAgQmFuay0tPj5OUFA6IFN1Y2Nlc3MKICAgIE5QUC0tPj5BZHllbjogUGF5bWVudCBzdWNjZXNzZnVsCiAgICBBZHllbi0tPj5NZXJjaGFudDogQVVUSE9SSVNBVElPTiB3ZWJob29rIChwYXltZW50IG91dGNvbWUgKyByZWN1cnJpbmdEZXRhaWxSZWZlcmVuY2UpCiAgICBBZHllbi0tPj5NZXJjaGFudDogUkVDVVJSSU5HX0NPTlRSQUNUIHdlYmhvb2sgKHRva2VuIC8gcHNwUmVmZXJlbmNlIGZvciBmdXR1cmUgcGF5bWVudHMpCiA=<\/div><\/div>\n

      One-time payment<\/strong><\/p>\n

      CnNlcXVlbmNlRGlhZ3JhbQphdXRvbnVtYmVyCnBhcnRpY2lwYW50IFNob3BwZXIKcGFydGljaXBhbnQgTWVyY2hhbnQKcGFydGljaXBhbnQgQWR5ZW4KcGFydGljaXBhbnQgTlBQCnBhcnRpY2lwYW50IEJhbmsKCiAgICAlJSBTdGVwIDE6IEluaXRpYWwgQ2hlY2sKICAgIE1lcmNoYW50LT4+QWR5ZW46IFBPU1QgL3BheW1lbnRNZXRob2RzIChjb3VudHJ5Q29kZTogQVUpCiAgICBBZHllbi0tPj5NZXJjaGFudDogUGF5VG8gaW5jbHVkZWQgaW4gcmVzcG9uc2UKICAgIE1lcmNoYW50LT4+U2hvcHBlcjogRGlzcGxheSBQYXlUbyBvcHRpb24KCiAgICAlJSBTdGVwIDI6IFBheW1lbnQgSW5pdGlhdGlvbiAmIE5vdGUKICAgIFNob3BwZXItPj5NZXJjaGFudDogUHJvdmlkZXMgUGF5SUQgb3IgQlNCCiAgICBNZXJjaGFudC0+PkFkeWVuOiBQT1NUIC9wYXltZW50cyAoc2hvcHBlckFjY291bnRJZGVudGlmaWVyLCBzaG9wcGVyU3RhdGVtZW50LCBubyBtYW5kYXRlKQogICAgTm90ZSBvdmVyIEFkeWVuOiBBdXRvLWdlbmVyYXRlcyBtYW5kYXRlIChhZGhvYywgZW5kRGF0ZTogRGF5KzEsIGFtb3VudFJ1bGU6IGV4YWN0LCBjb3VudDogMSkKICAgIEFkeWVuLS0+Pk1lcmNoYW50OiByZXN1bHRDb2RlOiBQZW5kaW5nICsgYWN0aW9uIHdpdGggYXV0by1nZW5lcmF0ZWQgbWFuZGF0ZQogICAgTWVyY2hhbnQtPj5TaG9wcGVyOiBTaG93IHBlbmRpbmcgc2NyZWVuCgogICAgJSUgU3RlcCAzOiBBdXRob3JpemF0aW9uICYgU2luZ2xlLVVzZSBNYW5kYXRlIENyZWF0aW9uCiAgICBBZHllbi0+Pk5QUDogQ3JlYXRlIHNpbmdsZS11c2UgbWFuZGF0ZQogICAgTlBQLT4+QmFuazogUHVzaCBub3RpZmljYXRpb24KICAgIEJhbmstPj5TaG9wcGVyOiBBcHByb3ZhbCByZXF1ZXN0IChiYW5raW5nIGFwcCkKICAgIFNob3BwZXItPj5CYW5rOiBDb25maXJtcwogICAgQmFuay0+Pk5QUDogQ29uZmlybWVkCiAgICBOUFAtLT4+QWR5ZW46IENvbmZpcm1hdGlvbgoKICAgICUlIFN0ZXAgNDogRXhlY3V0aW9uICYgRmluYWwgV2ViaG9vawogICAgQWR5ZW4tPj5OUFA6IEV4ZWN1dGUgcGF5bWVudAogICAgTlBQLT4+QmFuazogRGViaXQgYWNjb3VudAogICAgQmFuay0tPj5OUFA6IFN1Y2Nlc3MKICAgIE5QUC0tPj5BZHllbjogUGF5bWVudCBzdWNjZXNzZnVsCiAgICBBZHllbi0tPj5NZXJjaGFudDogQVVUSE9SSVNBVElPTiB3ZWJob29rCiA=<\/div><\/div>\n<\/li>\n<\/ol>\n

      Subsequent payments<\/strong><\/p>\n

        \n
      1. Call \/paymentMethods<\/a> providing the shopperReference<\/code> to retrieve your customer's stored payment methods.<\/li>\n
      2. Present the payment methods for which the available supportedRecurringProcessingModels<\/code> contains CardOnFile<\/strong><\/span> to your customer.<\/li>\n
      3. Submit a \/payments<\/a> request with the appropriate details including the stored payment token. Adyen will automatically process the payment.<\/li>\n
      4. The customer will be able to see the transaction in real-time in their banking app. Successful payment is confirmed via webhook notification from Adyen.<\/li>\n<\/ol>\n

        When retrieving payment methods with a shopperReference<\/code>, filter which PayTo tokens to show:<\/p>\n