Payments

cURL Ruby

Returns information about a payment

GET /payments/:id(.:format)

Example: returns a single payment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/payments/426664223563580962.json?

Response

        
          
          Status: 200 OK
        
      
{
  "id": "426664223563580962",
  "administration_id": 123,
  "invoice_type": "SalesInvoice",
  "invoice_id": "426664223348622869",
  "financial_account_id": "426664223544706590",
  "user_id": 1,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "363.0",
  "price_base": "363.0",
  "payment_date": "2024-07-16",
  "credit_invoice_id": null,
  "financial_mutation_id": "426664223556240929",
  "ledger_account_id": "426664223534220829",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2024-07-16T08:32:13.461Z",
  "updated_at": "2024-07-16T08:32:13.461Z"
}

Example: returns 404 when payment does not exist

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/payments/34123123.json?

Response

        
          
          Status: 404 Not Found
        
      
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}