Ramp: Repayment schemas
2 Ramp schemas with complete fields and constraints.
← Repayment operations · All schemas
List repayments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List repayments — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List repayments — response body — data item
List repayments — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity_id | string | Optional | Unique identifier of the associated business entity. Format: uuid |
funding_method | JSON | Required within parent | |
funding_method (anyOf 1) | string | Alternative | The method used to fund the repayment. Read only: true |
funding_method (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier of the repayment. Format: uuid |
original_transaction_id | JSON | Required within parent | |
original_transaction_id (anyOf 1) | string | Alternative | Original transaction id. Read only: true |
original_transaction_id (anyOf 2) | null | Alternative | |
repaid_at | JSON | Required within parent | |
repaid_at (anyOf 1) | string | Alternative | Time at which the repayment is repaid. Presented in ISO8601 format. Format: date-time Read only: true |
repaid_at (anyOf 2) | null | Alternative | |
repayment_amount | JSON | Required within parent | |
repayment_amount (anyOf 1) | Model | Alternative | Expand Hold Bill — response body — amount Amount and currency of the repayment by the payor. Read only: true |
repayment_amount (anyOf 2) | null | Alternative | |
status | string | Required within parent | Current repayment status. Known values: AWAITING_MANUAL_REPAYMENT, AWAITING_PAYMENT, NONE, REPAID, REPAYMENT_FAILED, REQUESTED_BY_REVIEWER Read only: true |
sync_status | JSON | Required within parent | |
sync_status (anyOf 1) | string | Alternative | Latest accounting sync status of the repayment. Null if no repayment sync has been attempted. Known values: IN_PROGRESS, MARKED_CANCELED, NOT_STARTED, SYNC_FAILURE, SYNC_SUCCESS Read only: true |
sync_status (anyOf 2) | null | Alternative | |
user_id | JSON | Required within parent | |
user_id (anyOf 1) | string | Alternative | Cardholder user id. Read only: true |
user_id (anyOf 2) | null | Alternative | |
user_signature | JSON | Required within parent | |
user_signature (anyOf 1) | string | Alternative | User's signature from the repayment agreement acceptance. Read only: true |
user_signature (anyOf 2) | null | Alternative |
Referenced models: Hold Bill — response body — amount