Charge Payment Method
Billing
Charge Payment Method
POST
Charge Payment Method
Request body
Send JSON with the Rainforest pay-in configuration id (not your Decodacharge id):
| Field | Required | Description |
|---|---|---|
payinConfigId | Yes | Value returned by POST /billing/payment-terminal/payin-config as payinConfigId. This ties the charge to Rainforest’s pay-in flow. It is not the same as chargeId / chg_…. |
Two-step flow
-
Create a pay-in config for the outstanding charge(s) — same payload shape as the in-app terminal:
POST /billing/payment-terminal/payin-configInclude the charge(s) (e.g. fullChargeSummaryobjects),paymentMedium,merchantAccountIdas required by that endpoint. The response includespayinConfigId(and oftensessionKeyfor browser components; for server-sidecharge-cardyou only needpayinConfigId). -
Charge the saved card —
POST /billing/payment-terminal/charge-card/{paymentMethodId}Path: DecodapaymentMethodId(e.g.pm_…from the store-details embed). Body:{ "payinConfigId": "<from step 1>" }.
payinConfigId is missing or wrong, Rainforest may respond with an error such as “Field is required” — that refers to the pay-in config id in their API, not chargeId or amount on this endpoint.Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
From POST /billing/payment-terminal/payin-config (not the Decoda charge id).
