Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Payment Requests

Request Payment Rail Details

post/v1/users/{userId}/liabilities/paymentRails

Path parameters

userIdstring required

Request body

creditCardIdsstring[]

List of credit card liability IDs.

autoLoanIdsstring[]

List of auto loan liability IDs.

homeLoanIdsstring[]

List of home loan liability IDs.

personalLoanIdsstring[]

List of personal loan liability IDs.

studentLoanIdsstring[]

List of student loan liability IDs.

Example request

{
  "creditCardIds": [
    "cc444634-40a8-4a62-849d-4e2db7b8a9ad"
  ],
  "autoLoanIds": [
    "lc444634-40a8-4a62-849d-4e2db7b8a9ad"
  ],
  "homeLoanIds": [
    "hl444634-40a8-4a62-849d-4e2db7b8a9ad"
  ],
  "personalLoanIds": [
    "pl444634-40a8-4a62-849d-4e2db7b8a9ad"
  ],
  "studentLoanIds": [
    "sl444634-40a8-4a62-849d-4e2db7b8a9ad"
  ]
}

Response

Success

creditCardIdstring

Credit card liability ID.

autoLoanIdstring

Auto loan liability ID.

homeLoanIdstring

Home loan liability ID.

personalLoanIdstring

Personal loan liability ID.

studentLoanIdstring

Student loan liability ID.

miscellaneousLiabilityIdstring

Miscellaneous liability ID.

liabilityType'STUDENT_LOAN' | 'CREDIT_CARD' | 'AUTO_LOAN' | 'HOME_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY' required

The type of liability.

status'SUPPORTED' | 'NOT_SUPPORTED' | 'LIABILITY_NOT_FOUND' | 'ACCOUNT_CLOSED' | 'UNKNOWN_ERROR' required

Payment rails resolution status.

Example response

{
  "paymentRails": {
    "rpps": {
      "billerId": "90210334"
    }
  }
}