Skip to main content
GET
/
v1
/
payments
cURL
curl --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/payments
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_type": "charge",
      "payment_date": "2023-12-25",
      "effective_at": "2023-11-07T05:31:56Z",
      "description": "Invoice payment for 100 widgets",
      "external_id": "<string>",
      "amount": 10000,
      "currency": "USD",
      "customer_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Ron Swanson",
        "customer_type": "individual",
        "email": "[email protected]",
        "phone": "+1234567890"
      },
      "paykey": "<string>",
      "paykey_details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Bank of America ****1234",
        "balance": 123
      },
      "status": "created",
      "status_details": {
        "message": "Payment successfully created and awaiting validation.",
        "reason": "insufficient_funds",
        "source": "system",
        "changed_at": "2023-11-07T05:31:56Z",
        "code": null
      },
      "funding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "funding_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "trace_ids": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Headers

Straddle-Account-Id
string<uuid>
Request-Id
string
Correlation-Id
string

Query Parameters

page_number
integer
default:1
page_size
integer
default:100
sort_by
enum<string>
default:id
Available options:
created_at,
payment_date,
effective_at,
id,
amount
sort_order
enum<string>
default:asc
Available options:
asc,
desc
payment_type
enum<string>[]
payment_status
enum<string>[]
payment_id
string<uuid>
external_id
string
customer_id
string<uuid>
paykey_id
string<uuid>
paykey
string
min_amount
integer
max_amount
integer
min_payment_date
string<date>
max_payment_date
string<date>
min_created_at
string<date-time>
max_created_at
string<date-time>
min_effective_at
string<date-time>
max_effective_at
string<date-time>
funding_id
string<uuid>
search_text
string
default_page_size
integer
default_sort
enum<string>
default:id
Available options:
created_at,
payment_date,
effective_at,
id,
amount
default_sort_order
enum<string>
default:asc
Available options:
asc,
desc
status_reason
enum<string>[]
status_source
enum<string>[]

Response

meta
object
required
response_type
enum<string>
required
Available options:
object,
array,
error,
none
data
object[]
required