Retrieves the information for a specified payment.

Privileges required: account administrator

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

paymentIdstring

Responses

CodeDescriptionReference
200

Successful response.

Payments
400

Error encountered.

errorDetails

SDK Method

Billing::getPayment

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

Payments

Payments

amountstring

Reserved: TBD

descriptionstring

A sender-defined description of the line item.

paymentDatestring

paymentIdstring

paymentNumberstring

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".

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> 
}} />