v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Payers

Create a Partner Payer

To fund your FBO account, you must first link an external bank account by creating a Payer object. This object acts as the designated source of funds for all Payment to Platform transactions. You may create as many Payers as needed to represent various funding sources. Upon a successful POST request, the API returns a PayerId. You will use this ID in subsequent calls to specify which account should be debited.

To create a valid Payer, you must provide either:

accountNumber, routingNumber, and accountType
token and tokenType

All other fields are mandatory as they are required by the loan servicers themselves.

post/v1/payments/payers/partner

Request body

Example request

{
  "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

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "payerId": "c555734f-6473-4d13-9943-2264cb1ee2dd",
    "payerType": "PARTNER",
    "payerSubType": "PARTNER",
    "accountLast4Digits": "1010",
    "institutionName": "Axis Bank Pvt. Ltd.",
    "tokenType": "PLAID",
    "verificationStatus": {
      "status": "IN_PROGRESS",
      "statusUpdateTs": 1614602485926
    },
    "createdOn": 1614602485926,
    "updatedOn": 1614602485926
  }
}