charges

Create Charge

Create a new charge.

post/charges

Request

Base URL
https://docs.monato.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/monato/apis/direct-debit-service/docs/charges/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-API-Keystring nullable

Idempotency-Keystring uuid nullable

Optional UUID for safely retrying charge creation. Reusing the same key with an identical request body returns the original charge instead of creating a duplicate. Keys are scoped to your organization and expire 24 hours after the request.

Request body

currency'mxn' | 'cop' | 'brl' | 'usd' | 'eur' | 'gbp' required

Currency enum.

instrument_idstring uuid nullable

ID of the payment instrument

customer_idstring uuid nullable

ID of the customer

amountnumber required

Charge amount

referencestring nullable

Reference provided by tenant

Response

Successful Response

org_idstring uuid required

ID of the organization

instrument_idstring uuid nullable

ID of the payment instrument

customer_idstring uuid nullable

ID of the customer

amountnumber required

Charge amount

currency'mxn' | 'cop' | 'brl' | 'usd' | 'eur' | 'gbp'

Currency enum.

referencestring nullable

Reference provided by tenant

inline_instrumentobject nullable

Inline instrument data

inline_customerobject nullable

Inline customer data

idstring uuid required

Charge status enum.

Declined reason enum.

declined_reason_railstring nullable

created_atstring date-time required

updated_atstring date-time nullable

chargeback_atstring date-time nullable

result_atstring date-time nullable

risk_status'pending' | 'ok' | 'cancelled_by_risk'

Risk evaluation outcome for a charge.

risk_evaluated_atstring date-time nullable

risk_reasonsstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.