Skip to main content
POST
/
v2
/
payment_methods
/
apply
Apply for a new payment method
curl --request POST \
  --url https://dev.sbx.imprint.co/v2/payment_methods/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "54CFF41D-0AA0-4D16-853B-608C5AAF503D",
  "ssn4": "1234",
  "housing_type": "RENT",
  "income_type": "EMPLOYED",
  "housing_cost": 120000,
  "income_amount": 8050000,
  "phone": "+14155552671",
  "first_name": "John",
  "last_name": "Doe",
  "address": {
    "street_line1": "123 Main St",
    "street_line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "USA"
  },
  "type": "CARD",
  "partner_customer_id": "CUST_03476998",
  "partner_identifier": "MCD",
  "housing_cost_currency": "USD",
  "income_amount_currency": "USD",
  "email": "customer@example.com",
  "amount": 123,
  "term_months": 123,
  "metadata": {
    "platform_version": "2.1.0"
  }
}
'
{
  "id": "DCBFC736-2286-42DD-897D-160DCA80AED2",
  "type": "CARD",
  "customer_id": "B40A789E-BD46-4BB9-B63E-F9919582694C",
  "created_at": "2025-02-13T19:08:07.000Z",
  "status": "ACTIVE",
  "metadata": {
    "platform_version": "2.1.0"
  },
  "card": {
    "last4": "1234",
    "network": "VISA",
    "card_type": "PHYSICAL",
    "card_design_id": "3b9c1f3e-52a0-44c1-b131-a7ab0099a214",
    "pci_details": {
      "pan": "5105105105105100",
      "exp_month": "06",
      "exp_year": "26",
      "cvv": "123"
    },
    "tokens": [
      {
        "type": "ADYEN",
        "token": "<string>",
        "created_at": "2025-02-13T19:08:07.000Z",
        "updated_at": "2025-02-13T19:08:07.000Z",
        "pan_reference_id": "<string>"
      }
    ]
  },
  "bank_account": {
    "last4": "1234",
    "routing_number": "<string>",
    "bank_name": "Wells Fargo",
    "account_type": "CHECKING"
  },
  "loan": {
    "amount": 10000,
    "term_months": 12,
    "currency": "USD",
    "remaining_balance": 123,
    "apr": "5.89",
    "loan_status": "PENDING"
  },
  "updated_at": "2025-02-13T19:08:07.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Body

application/json
​
customer_id
string
required

The Imprint customer id

Example:

"54CFF41D-0AA0-4D16-853B-608C5AAF503D"

​
ssn4
string
required

The customer's last 4 digits of their social security number

Example:

"1234"

​
housing_type
enum<string>
required

If the customer rents or owns their home

Available options:
RENT,
OWN,
OTHER
Example:

"RENT"

​
income_type
enum<string>
required

The source of the customer's income

Available options:
EMPLOYED,
SELF-EMPLOYED,
BUSINESS OWNER,
RETIREMENT,
UNEMPLOYMENT,
GOVTASSISTANCE,
OTHER
Example:

"EMPLOYED"

​
housing_cost
integer
required

The monthly amount the customer pays for housing, in cents or lowest currency value. example $1200.00 per month

Example:

120000

​
income_amount
integer
required

The yearly income for the customer, in cents or lowest currency value. Example $80,500.00

Example:

8050000

​
phone
string
required

Customer's phone number in E.164 format

Example:

"+14155552671"

​
first_name
string
required

The customer's first name.

Example:

"John"

​
last_name
string
required

The customer's last name.

Example:

"Doe"

​
address
object
required

Mailing address information

​
type
enum<string>
required
Available options:
CARD,
LOAN
​
partner_customer_id
string

The unique identifier for the customer in the partner's system

Example:

"CUST_03476998"

​
partner_identifier
string

Partner identifier, available from support

Example:

"MCD"

​
housing_cost_currency
string

The currency code for the housing cost amount

Example:

"USD"

​
income_amount_currency
string

The currency code for the income amount

Example:

"USD"

​
email
string<email>

Customer's email address

Example:

"customer@example.com"

​
amount
integer

Required for loan applications

​
term_months
integer

Required for loan applications

​
metadata
object

Additional metadata for the payment method

Example:
{ "platform_version": "2.1.0" }

Response

Payment method application successful

​
id
string
required

The unique ID Imprint assigns to the payment method.

Example:

"DCBFC736-2286-42DD-897D-160DCA80AED2"

​
type
enum<string>
required

The type of payment method

Available options:
CARD,
BANK_ACCOUNT,
LOAN
​
customer_id
string
required

The id of the Imprint customer that the payment method belongs to.

Example:

"B40A789E-BD46-4BB9-B63E-F9919582694C"

​
created_at
string
required

the RFC-3339 timestamp when the payment method was created

Example:

"2025-02-13T19:08:07.000Z"

​
status
enum<string>
required

Current status of the payment method

Available options:
ACTIVE,
INACTIVE,
CANCELED
​
metadata
object
required

Additional metadata for the payment method

Example:
{ "platform_version": "2.1.0" }
​
card
object

When payment method is a CARD type, this object will have card specific data.

​
bank_account
object

When payment method is a BANK_ACCOUNT type, this object will have bank account specific data.

​
loan
object

When payment method is a LOAN type, this object will have loan specific data.

​
updated_at
string

the RFC-3339 timestamp when the payment method was last updated

Example:

"2025-02-13T19:08:07.000Z"