Search & list payments

curl --request GET \
  --url https://api.sandbox.primer.io/payments \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>'

{
  "data": [
    {
      "id": "IHQlakKC",
      "date": "2021-03-24T14:56:56.869248",
      "status": "SETTLED",
      "orderId": "my-order-123",
      "currencyCode": "EUR",
      "amount": 700,
      "processor": {
        "name": "STRIPE",
        "processorMerchantId": "acct_stripe_1234"
      },
      "metadata": {
        "productId": 123,
        "merchantId": "a13bsd62s"
      }
    }
  ],
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Search & list 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.

For example, if you wanted to get both FAILED and CANCELLED payments, for customer john-123, you would use:

curl --location --request GET 'https://api.primer.io/payments?status=FAILED,CANCELLED&customer_id=john-123' \
--header 'X-Api-Key: <YOUR_API_KEY>'

You can alternatively specify a list by repeating the parameter multiple times.

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

GET

payments

Search & list payments

curl --request GET \
  --url https://api.sandbox.primer.io/payments \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>'

{
  "data": [
    {
      "id": "IHQlakKC",
      "date": "2021-03-24T14:56:56.869248",
      "status": "SETTLED",
      "orderId": "my-order-123",
      "currencyCode": "EUR",
      "amount": 700,
      "processor": {
        "name": "STRIPE",
        "processorMerchantId": "acct_stripe_1234"
      },
      "metadata": {
        "productId": 123,
        "merchantId": "a13bsd62s"
      }
    }
  ],
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

X-API-VERSION

string

required

Specifies the version of the API to use. This must be set to 2.4.

Example:

"2.4"

Query Parameters

status

enum<string>[]

Filter payments by their status.

Show child attributes

payment_method_type

enum<string>[]

Filter payments by their payment method type.

Show child attributes

processor

string[]

Filter payments by their payment processor.

currency_code

string[]

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

from_date

string<date-time>

Return only payments from this date (inclusive).

to_date

string<date-time>

Return only payments up to this date (inclusive).

order_id

string

Return payments related to this order ID.

min_amount

integer

Return payments of this amount minimum (inclusive).

max_amount

integer

Return payments of this amount max (inclusive).

customer_id

string[]

ID of the customer that has made the payment.

merchant_id

string[]

ID of the merchant involved in the payment.

customer_email_address

string[]

Email of the customer that has made the payment.

last_4_digits

string[]

Last 4 digits of the card used for the payment.

paypal_email

string[]

Paypal email address associated with the payment.

klarna_email

string[]

Klarna email address associated with the payment.

limit

integer

default:100

Maximum number of payments to return per page.

Required range: 1 <= x <= 100

cursor

string

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

Response

Successful Response

data

PaymentSummaryAPISchema · object[]

Show child attributes

nextCursor

string

prevCursor

string

Update client session Create a payment

API reference

Authorizations

Headers

Query Parameters

Response