Jump to Content
Shine
HomeGuidesAPI ReferenceChangelog
We are hiringShine
API Reference
We are hiring
HomeGuidesAPI ReferenceChangelog

API Concepts

  • HTTP Responses
  • Pagination
  • Errors
  • Dates and timestamps
  • Code Examples

Authentication

  • OAuth2 Methods
    • Authorizeget
    • Get an access tokenpost
    • Revoke a refresh tokenpost
  • ActionRequest Methods
    • Create an action requestpost
    • Poll an action requestpost
  • Methods
    • Get the public JWKSget

Shine Connect

  • Company profile
    • /companies/profiles/{companyProfileId}get
  • Users
    • /users/profiles/{uid}get
  • Bank Transfers
    • Get a transferget
    • Cancel a transferdelete
    • Create a transferpost
    • Query transfersget
  • Bank Transfer Recipients
    • Get a recipientget
    • Update a recipientput
    • Delete a recipientdelete
    • Create a recipientpost
    • Query recipientsget
  • Bank accounts
    • Get by userget
    • Getget
  • Receipts
    • /receiptspost
    • /receipts/queryget
    • /receipts/{receiptId}get
    • /receipts/{receiptId}put
  • Transactions
    • Queryget
    • Getget
  • Invoices
    • Query - Deprecatedget
    • Get One - Deprecatedget
    • Get Invoice PDF - Deprecatedget
    • Queryget
    • Getget
    • Get invoice pdfget
  • InvoiceMappings
    • /transaction_enrichment/invoice_mappingsget
  • /qseal
    • getget

Code Examples

You can find end-to-end examples for both DSP and public API below.

GitHub Repository
Regulated Partners examplehttps://github.com/shinetools/shine-connect-example
Public API Partners examplehttps://github.com/shinetools/shine-public-api-example