Arta API Reference

Get an Invoice Payment record

GET /invoice_payments/{invoice_payment_id}

Retrieve an existing Invoice Payment record

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Path parameters

invoice_payment_id integer Required

invoice_payment_id parameter

Responses

• 200 application/json

Successful Invoice 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
- id integer
- invoice_id integer
- payment_id integer
- shipment_id 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 /invoice_payments/{invoice_payment_id}

curl \
 -X GET https://api.arta.io/invoice_payments/{invoice_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",
  "created_at": "2021-02-19T19:09:57.971464",
  "id": 1,
  "invoice_id": 11,
  "payment_id": 1,
  "shipment_id": "45360593-6c6c-44ab-8a17-0fd198fff058",
  "updated_at": "2021-02-19T19:09:57.971464"
}

Response examples (404)

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

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