{"api":"esign_rest","category":"reference"}

Payments Resource

The Payments resource provides methods that allow you to manage payments for an account.

These calls can only be used by users with account administrator privileges.

MethodDescription
list
GET /v2/accounts/{accountId}/billing_payments

Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.

Privileges required: account administrator

create
POST /v2/accounts/{accountId}/billing_payments

Posts a payment to a past due invoice.

Note: This can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling [ML:GetBillingInvoicesPastDue].

The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the nextUri and previousUri properties are not returned.

Privileges required: account administrator

get
GET /v2/accounts/{accountId}/billing_payments/{paymentId}

Retrieves the information for a specified payment.

Privileges required: account administrator