Example: Create a Saved Payment Method for Bank or Alternative Payment Method

Create Saved Payment Methods (SPM) for bank or alternative payment methods in one of two ways:

Salesforce-Supported Types: Use supported types, such as sepa_debit, bancontact, ideal, us_bank_account (ACH), bacs_debit, and au_becs_debit.

Or
Extended Payment Method Types: If the type isn’t supported by Salesforce, set type to extd_apm_type and provide the exact payment method type recognized by your payment gateway in the extendedPaymentMethodType field.

The ExtendedPaymentMethodType field and extended types (extd_apm_type, extd_wallet) are supported only for third-party gateways.

Note

Sample JSON request

1{
2  "merchantAccountId": "8zbSM0000000EkXYAU",
3  "referenceOwnerId": "001SM00000GPtUqYAL",
4  "paymentGatewayId": "0b0SM0000002nsfYAA",
5  "status": "Active",
6  "usageType": "OFFSESSION",
7  "name": "AmazonPay...001",
8  "gatewayReference": "cus_TS4IZLLrrbsYce",
9  "gatewayToken": "pm_1SVA9qIQmmvzCzdJsQb2fogA",
10  "last4": "1234",
11  "type": "extd_apm_type",
12  "checksum": "UNIQUE_GATEWAY_HASH_Wallet_1090901",
13  "extendedPaymentMethodType": "klarna"
14}

Sample JSON response

1{
2  "id": "12qSM000000qKx7YAE",
3  "success": true,
4  "errors": []
5}

Here’s a sample UI showing example records created for extd_apm_type.

In this example, ExtendedPaymentMethodType is set to klarna for testing. You can use any value not supported by Salesforce and customize your implementation as needed.

Note

Example of a saved payment method record for a bank or alternative payment method showing field values and status