Retrieves the information for a specified payment.

Privileges required: account administrator

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

paymentId string

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::getPayment

Definitions Expand All | Collapse All

Payments

Payments

amount string

Reserved: TBD

description string

A sender-defined description of the line item.

paymentDate string
paymentId string
paymentNumber string

When set to true, a PDF version of the invoice is available.

To get the PDF, make the call again and change "Accept:" in the header to "Accept: application/pdf".

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Response

Response

{
"paymentId": "sample string 1",
"amount": "sample string 2",
"paymentDate": "sample string 3",
"paymentNumber": "sample string 4",
"description": "sample string 5"
}

Generic XML Response

Response

<billingPaymentItem 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<amount>sample string 2</amount>
<description>sample string 5</description>
<paymentDate>sample string 3</paymentDate>
<paymentId>sample string 1</paymentId>
<paymentNumber>sample string 4</paymentNumber>
</billingPaymentItem>