Payments API

Search & list payments

GET
https://api.sandbox.primer.io/payments

Retrieve a list of your payments.

Results are paginated, they will only return up to 100 payments maximum. To access the next page of result, set the cursor query parameter to the value of nextCursor in your current result payload. Use prevCursor to go back to the previous page.

Note: this endpoint returns a list of summarized payments. Not all payments attributes are present. You can use the query parameters to filter payments. You can separate multiple query parameters with the & symbol. Query parameters with types of the form "Array of strings" (such as the status parameter) can be specified as a comma-separated list.

Note: payments will be available within a minute from being created.

Query parameters

status
optional enum

Filter payments by their status.

payment_method_type
optional enum

Filter payments by their payment method type.

processor
optional string

Filter payments by their payment processor.

currency_code
optional string

Filter payments by their payment currency. e.g. use USD for US dollars.

from_date
optional datetime

Return only payments from this date (inclusive).

to_date
optional datetime

Return only payments up to this date (inclusive).

order_id
optional string

Return payments related to this order ID.

min_amount
optional integer

Return payments of this amount minimum (inclusive).

max_amount
optional integer

Return payments of this amount max (inclusive).

customer_id
optional string

ID of the customer that has made the payment.

merchant_id
optional string

ID of the merchant involved in the payment.

customer_email_address
optional string

Email of the customer that has made the payment.

last_4_digits
optional string

Last 4 digits of the card used for the payment.

paypal_email
optional string

Paypal email address associated with the payment.

klarna_email
optional string

Klarna email address associated with the payment.

limit
optional integer

Maximum number of payments to return per page.

cursor
optional string

If results are paginated, pass the nextCursor to access next page.

Response

This endpoint return an object.
data
optional list of objects
nextCursor
optional string
prevCursor
optional string

Errors

GET
/payments
1
2
curl "https://api.sandbox.primer.io/payments" \
     -H "X-API-KEY: <apiKey>"
Response
1
{}