Sign in

v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB
payments

Retrieve a Payment

Retrieve a single payment by ID.

get/payments/payment/{id}

Path parameters

idstring required

Query parameters

expandstring

Comma-separated list of expandable fields. Supported values: invoices

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successfully retrieved

idstring

The unique identifier of the payment.

payment_methodstring

The method used to send this payment (e.g. ACH, check).

statusstring

The human-readable status of the payment.

status_codeinteger

The numeric status code of the payment.

last_errorstring

The last error message encountered during payment processing, if any.

erp_vendor_idstring

The vendor's unique identifier in your ERP system.

ottimate_company_idinteger

The Ottimate company ID associated with this payment.

customer_account_numberstring

Your account number with the vendor.

scheduled_datestring

The ISO 8601 date and time when the payment is scheduled to be sent.

memostring

The memo or note included with the payment.

payment_numberstring

Your internal identifier for this payment.

expected_delivery_datestring

The expected date the payment will be delivered to the vendor.