Money

Read a single payment request or invoice

Visible to the sender, the receiver, or any member of the chat its bubble lives in (observers included). Unknown id and not-visible-to-you both 404 identically, the same reasoning as GET /api/v1/cards/:id.

get/api/v1/transfer_requests/{id}

Request

  • Base URL: https://saltapp.ai
  • URL: https://saltapp.ai/api/v1/transfer_requests/{id}
  • Auth: one of:
    • API key in header api-key
    • OAuth 2 (authorization code, authorization URL https://saltapp.ai/oauth2/authorize, token URL https://saltapp.ai/api/oauth2/token, scopes: money)

Path parameters

idstring required

Response

OK

idstring uuid required
amountstring required

A plain human-decimal amount, e.g. "1.50" -- never a float, never scientific notation.

messagestring nullable
status'Pending' | 'Paying' | 'Completed' | 'Declined' | 'Cancelled' required
sender_idstring uuid required
receiver_idstring uuid required
transfer_idstring nullable
request_type'invoice' | 'null' nullable
due_atstring date-time nullable
split_idstring nullable
recurring_intervalstring nullable
reminded_atstring date-time nullable
last_failed_atstring date-time nullable
last_failed_reasonstring nullable

One plain classified sentence, never the raw node error.

created_atstring date-time nullable
chat_idstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.