---
title: "Create a User Payer"
method: POST
path: "/v1/payments/payers/user"
tags: ["Payers"]
---

# Create a User Payer

`POST /v1/payments/payers/user`

## Request

- Base URL: `https://sandbox-api.spinwheel.io`
- URL: `https://sandbox-api.spinwheel.io/v1/payments/payers/user`
- Auth: API key in header `Authorization`

To create a Payer object for a User, you will send a POST request with a request body represented in the sample below*. Since, just like in the real world, a customer may have a number of accounts from which to make payments, Users can have multiple Payers. The PayerId that is returned with a successful API call can be used to specify the source of funds when making a payment.

*NOTE: all fields within bankAccountDetails object are mandatory because they are required by the loan servicers themselves

## Request body

- CreateUserPayerRequest
  - `userId` string, required
  - `bankAccountDetails` PayerBankAccountDetails, required
    - `routingNumber` string: At least one of following sets of fields is required: [routingNumber, accountNumber, accountType] or [token, tokenType]
    - `accountNumber` string
    - `nameOnAccount` string, required
    - `institutionName` string, required
    - `accountType` string
    - `tokenType` 'PLAID': At least one of following sets of fields is required: [token, tokenType] or [routingNumber, accountNumber, accountType]
    - `token` string
    - `accountHolderProfile` AccountHolderProfilePayer, required
      - `country` string, required
      - `city` string, required
      - `state` string, required
      - `zipCode` string, required
      - `email` string, required
      - `phone` string, required
      - `dateOfBirth` string
      - `addressLine1` string, required
      - `addressLine2` string

## Response `200`

- CreateUserPayerResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` CreateUserPayerResponseData, required
    - `payerId` string, required
    - `userId` string, required
    - `payerType` string, required
    - `payerSubType` string, required
    - `accountLast4Digits` string, required
    - `institutionName` string, required
    - `createdOn` number, required
    - `updatedOn` number, required
    - `tokenType` 'PLAID'

## Other responses

- `400`: Bad request response
- `401`: Unauthorized response
- `403`: Forbidden response
- `404`: Not found response
- `500`: Internal server error response

---

[API](https://skmtc.dev/spinwheel/apis/pay.md) - [All operations](https://skmtc.dev/spinwheel/apis/pay/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/pay/revisions/58ba91f8ae13?raw)