Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Billing

Add Credit Card

Allows one to add a credit card as a payment method. PayPal must be added as a payment method on a specific Invoice

post/v1/billing/payment_methods

Request body

activeboolean

Use this payment method for all automated payments

card_tokenstring required

Tokenized Credit Card string

descriptionstring

Optional description of the card

address_idinteger required

ID of the billing address used for this payment method

Example request

{
  "active": true,
  "card_token": "seti_1R40rbIpHZfwip1PnqHpSQJy",
  "description": "Citi Platinum Business",
  "address_id": 888000888
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 880088,
    "type": "Credit Card",
    "active": true,
    "description": "Citi Platinum Business",
    "address": {
      "id": 42,
      "first_name": "Rocket",
      "last_name": "Billing-Contact",
      "address_line_1": "17885 SE Federal Hwy",
      "address_line_2": "Suite 100",
      "company_name": "Rocket.net",
      "email": "billing@rocket.net",
      "city": "Jupiter",
      "state": "FL",
      "country": "US",
      "postal_code": "33469",
      "telephone": "877-374-0764"
    },
    "address_id": 888000888,
    "card_last_four": "1234",
    "card_type": "Visa",
    "expiry_date": "04/29",
    "last_updated": "2024-01-01T02:00:00Z",
    "gateway_token": "pm_1Q56yCIpHZfwip1PT4nnaIMi"
  }
}