APappdirect
PaymentInstrument

Retrieve a payment instrument

Changed on
get/billing/v1/paymentInstruments/{paymentInstrumentId}

Request

Path parameters

paymentInstrumentIdstring required

Payment Instrument Id

Response

OK

accountDisplaystring

Account display text.

createdOnnumber

Payment instrument creation date.

idstring

ID

isDefaultboolean

True if this payment instrument is the default.

paymentMethod'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS'

The supported payment methods

vatIdstring

VAT ID.

Example response

{
  "accountDisplay": "...",
  "billingAddress": {
    "city": "...",
    "companyName": "...",
    "country": "...",
    "fax": "...",
    "faxExtension": "...",
    "firstName": "...",
    "lastName": "...",
    "phone": "...",
    "phoneExtension": "...",
    "poBox": "...",
    "salutation": "...",
    "state": "...",
    "street1": "...",
    "street2": "...",
    "zip": "..."
  },
  "company": {
    "href": "...",
    "id": "..."
  },
  "createdOn": 12345,
  "creditCard": {
    "expirationMonth": 12345,
    "expirationYear": 12345,
    "name": "...",
    "number": "...",
    "securityCode": "...",
    "type": "AMEX"
  },
  "id": "...",
  "isDefault": true,
  "paymentMethod": "MANO_TEO_BILL",
  "user": {
    "href": "...",
    "id": "..."
  },
  "vatId": "..."
}

Changes