List customer payments

Retrieve all payments linked to the customer.

🔑

Access with

API key

Access token with payments.read

Path Params
string
required

Provide the ID of the related customer.

Query Params
string | null

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

boolean | null
Defaults to false

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Responses

Response body
object
integer
1 to 250

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

_embedded
object
payments
array of objects

An array of payment objects. For a complete reference of the payment object, refer to the Get payment endpoint documentation.

payments
object
_links
object

Language
Credentials
Request