| Name | Type | Description | Notes |
|---|---|---|---|
| type | String | ||
| account_id | String | {"description":"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.","verbs":["POST"]} | [optional] |
| gateway | String | {"description":"The gateway with which your funding instrument has been vaulted.","verbs":["POST"]} | [optional] |
| company_name | String | {"description":"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.","verbs":["POST"]} | [optional] |
| String | {"description":"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.","verbs":["POST"]} | [optional] | |
| first_name | String | {"description":"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.","verbs":["POST"]} | [optional] |
| last_name | String | {"description":"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.","verbs":["POST"]} | [optional] |
| mobile | String | {"description":"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.","verbs":["POST"]} | [optional] |
| default_payment_method | BOOLEAN | {"default":false,"description":"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).","verbs":["POST"]} | [optional] [default to false] |
| organization_id | String | {"description":"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]} | [optional] |
| stripe_token | String | {"description":"Single-use token <a href=\"https://stripe.com/docs/stripe.js\\\">provided by Stripe's client-side card capture SDK</a>, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault — precursory to linking a BillForward PaymentMethod to that tokenized card.","verbs":["POST"]} | |
| card_id | String | {"description":"ID of the captured Card in Stripe. This can be provided as well as — or instead of — the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.","verbs":["POST"]} | [optional] |
| customer_id | String | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.