Payers

Create a User Payer

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

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

Request body

userIdstring required

Example request

{
  "userId": "8772831c-2a22-4b00-bcae-825c6aed93ed",
  "bankAccountDetails": {
    "routingNumber": "222222226",
    "accountNumber": "9110001011010",
    "nameOnAccount": "Test User",
    "institutionName": "Axis Bank Pvt. Ltd.",
    "accountType": "CHECKING",
    "tokenType": "PLAID",
    "token": "processor-sandbox-0asd1-a92nc",
    "accountHolderProfile": {
      "country": "USA",
      "city": "Chicago",
      "state": "CA",
      "zipCode": "60601",
      "email": "testuser@test.com",
      "phone": "9999999999",
      "dateOfBirth": "1980/01/01",
      "addressLine1": "Opp. Willis Tower, 233 S Wacker Dr",
      "addressLine2": "Unit 502"
    }
  }
}

Response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "payerId": "c555734f-6473-4d13-9943-2264cb1ee2dd",
    "userId": "8772831c-2a22-4b00-bcae-825c6aed93ed",
    "payerType": "USER",
    "payerSubType": "USER",
    "accountLast4Digits": "1010",
    "institutionName": "Axis Bank Pvt. Ltd.",
    "createdOn": 1614602485926,
    "updatedOn": 1614602485926,
    "tokenType": "PLAID"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.