Organization API: Customer Portal: Payment methods

Part of Customer Portal.

GET /api/v1/orgs/{org_slug}/portal/payment-methods

List customer's saved payment methods.

POST /api/v1/orgs/{org_slug}/portal/payment-methods/confirm

Confirm payment method setup after customer approves on gateway side. Stores the tokenized method for future charges.

The answer always has a status. succeeded: the method is saved, and the answer holds it (id, method_type, display_label, is_default and the rest). A method the customer already saves answers the method it already is, and a bank account Stripe made from an iDEAL or Bancontact setup is saved as a SEPA Direct Debit method. processing: the bank is still confirming the method, as it does for a US bank account after micro-deposits, which can take days. Nothing is saved yet, the answer holds a message for the customer, and we save the method when the bank confirms. requires_action: the customer has a step to finish first. The answer holds a message, the client_secret to finish it in the page and, when the step is a page of the bank's, its next_action_url. We answer 400 with a plain message for a setup that failed, was canceled, or was not started from this customer.

For Square send gateway_name, session_id square and the JSON body {source_id, verification_token?, cardholder_name?, billing?}, where source_id is the token the card form made. We answer 400 with a plain message when Square refuses the card, and when saved cards are not switched on for the account. A card the customer already saves answers the method it already is.

application/json

Type: Callback Data.

POST /api/v1/orgs/{org_slug}/portal/payment-methods/setup

Initiate payment method tokenization on a regional gateway account.

Without gateway_name we pick the account that saves cards for the currency among the card_adapters you can draw (Stripe when you name none). For Stripe the answer holds a client_secret or a redirect_url. The form offers the payment methods the account has switched on for saving: cards, Link, SEPA Direct Debit, US bank accounts and the other reusable methods. iDEAL and Bancontact are saved as a SEPA Direct Debit method. Finish with POST .../payment-methods/confirm, which answers whether the method is saved.

For Square (adapter and session_id square, requires_redirect false) draw Square's card form with public_config.application_id and public_config.location_id (the location of your store's brand), tokenize the card, and send the token to POST .../payment-methods/confirm as the JSON body {"source_id": ...}. A Square account offers this only once saved cards are switched on for it: until then we answer 400 and create nothing. Send return_url and cancel_url as for Stripe. Square does not use them.

DELETE /api/v1/orgs/{org_slug}/portal/payment-methods/{method_id}

Remove (deactivate) a saved payment method.

PUT /api/v1/orgs/{org_slug}/portal/payment-methods/{method_id}/default

Set a payment method as the default for this customer.