Ramp: Update a payment
Ramp payment.patchPaymentDetailResource: arguments, response, policy and SDK examples.
← Payment operations · Get started
Operation ramp.patch_payment_detail_resource
Provider route: PATCH /developer/v1/payments/{payment_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["payment"]["patchPaymentDetailResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.payment.patchPaymentDetailResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.payment.patch_payment_detail_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.payment_id | string | Required within parent | |
body | Model | Required within parent | Expand Update a payment — request body — body |
Referenced models: Update a payment — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch a payment — response body |
Referenced models: Fetch a payment — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Update a payment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Optional | Expand Update a payment — request body — body amount The payment amount and currency. |
external_invoice_number | JSON | Optional | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number associated with this payment. |
external_invoice_number (anyOf 2) | null | Alternative | |
external_ref | string | Optional | An external reference identifier for this payment. |
payment_method | Model | Optional | Expand Update a payment — request body — body payment method The payment method to use for this payment. |
scheduled_date | string | Optional | The date the payment should be initiated (YYYY-MM-DD). Format: date |
source_bank_account_id | string | Optional | Unique identifier of the bank account to pay from. Format: uuid |
Referenced models: Update a payment — request body — body amount, Update a payment — request body — body payment method
Fetch a payment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amount | Model | Required within parent | Expand Fetch a payment — response body — amount The payment amount and currency. Read only: true |
check_details | JSON | Required within parent | |
check_details (anyOf 1) | Model | Alternative | Expand Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url Check-specific delivery tracking details. Populated only for check-funded payments. Read only: true |
check_details (anyOf 2) | null | Alternative | |
customer_friendly_payment_id | JSON | Required within parent | |
customer_friendly_payment_id (anyOf 1) | string | Alternative | Customer-friendly payment identifier for non-card payment methods, if available. Payments sharing the same value belong to the same payment or batch payment. |
customer_friendly_payment_id (anyOf 2) | null | Alternative | |
entity_id | string | Required within parent | Unique identifier of the entity making the payment. Format: uuid |
external_invoice_number | JSON | Required within parent | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number associated with this payment. |
external_invoice_number (anyOf 2) | null | Alternative | |
external_ref | JSON | Required within parent | |
external_ref (anyOf 1) | string | Alternative | An external reference identifier for this payment. |
external_ref (anyOf 2) | null | Alternative | |
failure_reason | JSON | Required within parent | |
failure_reason (anyOf 1) | string | Alternative | The reason for the payment failure, if applicable. Known values: ACCOUNT_HOLDER_DECEASED, CARD_DECLINED, CARD_DETAILS_INVALID, CARD_INSUFFICIENT_FUNDS, CARD_PROCESSING_ERROR, CARD_REVERIFICATION_REQUIRED, CHECK_ATTACHMENT_REJECTED, CHECK_DELIVERY_FAILURE, CHECK_DEPOSIT_REJECTED, CHECK_DEPOSIT_RETURNED, CHECK_EXPIRED, CHECK_VOIDED, CHECK_WITHDRAWAL_INSUFFICIENT_BALANCE, CHECK_WITHDRAWAL_RECIPIENT_NAME_MISMATCH, CHECK_WITHDRAWAL_RETURNED, DEBIT_DISPUTED, DUPLICATE_ACH_ENTRY, FAILURE_NOT_RECOGNIZED, INTERNATIONAL_DIRECT_DEBIT_INSTRUMENT_UNAVAILABLE, INTERNATIONAL_PROVIDER_UNAVAILABLE, INVALID_BANK_BRANCH, INVALID_ROUTING_NUMBER, MANDATE_DATA_MISMATCH, MISSING_PAYEE_BANK_ACCOUNT, MISSING_PAYER_BANK_ACCOUNT, PAYEE_ACCOUNT_CLOSED, PAYEE_ACCOUNT_FROZEN, PAYEE_ACCOUNT_INVALID_BENEFICIARY_DETAILS, PAYEE_ACCOUNT_NON_TRANSACTIONAL, PAYEE_ACCOUNT_NOT_FOUND, PAYEE_ACCOUNT_REJECTED_PAYMENT, PAYEE_ACCOUNT_WRONG_CURRENCY, PAYEE_ACCOUNT_WRONG_NAME, PAYER_ACCOUNT_CLOSED, PAYER_ACCOUNT_DEBIT_BLOCK, PAYER_ACCOUNT_FROZEN, PAYER_ACCOUNT_INSUFFICIENT_FUNDS, PAYER_ACCOUNT_NON_TRANSACTIONAL, PAYER_ACCOUNT_NOT_FOUND, PAYER_ACCOUNT_WRONG_CURRENCY, PAYER_ACCOUNT_WRONG_NAME, PAYER_OUTSTANDING_BALANCE, PAYMENT_FREEZE, PAYMENT_RETURNED_BY_PROVIDER, PROVIDER_ACCOUNT_FROZEN, QUOTE_REJECTED_BY_PROVIDER, QUOTE_TRANSFER_TOO_EXPENSIVE, SETTLEMENT_PAYMENT_CANCELED, UNRESOLVED_COMPLIANCE_RFI, UNRESOLVED_NO_DQ_INSUFFICIENT_FUNDS, UNSUPPORTED_BY_BANKING_PARTNER, WIRE_INCORRECT_ACCOUNT_NUMBER, WIRE_INCORRECT_BENEFICIARY_DETAILS Read only: true |
failure_reason (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the payment. Format: uuid |
is_cancelable | boolean | Required within parent | Whether this payment can be canceled. Read only: true |
payment_method | Model | Required within parent | Expand Fetch a payment — response body — payment method The payment method used for this payment. Read only: true |
scheduled_date | string | Required within parent | The date the payment is scheduled to be initiated. Format: date |
source_bank_account_id | string | Required within parent | Unique identifier of the bank account the payment is sent from. Format: uuid |
status | string | Required within parent | The current status of the payment. Known values: CANCELED, COMPLETED, ERROR, PROCESSING, SCHEDULED Read only: true |
status_detail | JSON | Required within parent | |
status_detail (anyOf 1) | string | Alternative | The detailed processing status for an ACH payment. Null for other payment methods. Known values: CANCELED, DEBITING, DELIVERED, FAILED, INITIATED, SCHEDULED, TRANSFERRING_TO_VENDOR Read only: true |
status_detail (anyOf 2) | null | Alternative | |
vendor_id | string | Required within parent | Unique identifier of the vendor being paid. Format: uuid |
Referenced models: Fetch a payment — response body — amount, Fetch a payment — response body — payment method, Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url
Update a payment — request body — body amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
currency | string | Required within parent | The currency of the amount in ISO 4217 format (e.g. USD). One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
value | integer | Required within parent | The non-negative amount in the smallest denomination of the currency (e.g. cents for USD). Minimum: 0 |
Update a payment — request body — body payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the payment instrument. For ACH, this is the vendor bank account ID. For CHECK, this is the vendor address ID. Format: uuid |
type | string | Required within parent | The type of payment method. One of: ACH, CHECK |
Fetch a payment — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | The currency of the amount in ISO 4217 format (e.g. USD). Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
value | JSON | Required within parent | |
value (anyOf 1) | integer | Alternative | The non-negative amount in the smallest denomination of the currency (e.g. cents for USD). Minimum: 0 |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a payment — response body — payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the payment instrument. Format: uuid |
type | string | Required within parent | The type of payment method. Known values: ACH, CHECK |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.patch_payment_detail_resource. Catalog operation: patch_payment_detail_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["payments:write"]