Arta API Reference

Get an Payment record

GET /payments/{payment_id}

Retrieve an existing Payment record

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Path parameters

payment_id integer Required

payment_id parameter

Responses

• 200 application/json

Successful Payment response
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- amount string
- amount_currency string
- created_at string
- context string
- id integer
- paid_on string | null
- updated_at string
• 404 application/json

Resource Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute
  
  detail string

GET /payments/{payment_id}

curl \
 -X GET https://api.arta.io/payments/{payment_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"

Response examples (200)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "amount": "502.25",
  "amount_currency": "USD",
  "context": "hosted_checkout",
  "created_at": "2021-02-19T19:09:57.954437",
  "id": 1,
  "paid_on": "2021-02-19",
  "updated_at": "2021-02-19T19:09:57.954437"
}

Response examples (404)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}