> ## Documentation Index
> Fetch the complete documentation index at: https://docs.talescria.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a payment

> A payment as it stands. Poll this while `status` is `pending` or `processing`.

`recipientId` is not returned on reads.

Requires the `payments:read` scope.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/transfers/{transferId}
openapi: 3.1.0
info:
  title: Talescria API
  version: 1.0.0
  description: >-
    Accounts, recipients, payments, transfers between your accounts, payment
    links, customers and invoices. Authenticate with an access token from your
    OAuth client.
servers:
  - url: https://api.talescria.com
    description: Production (test and live keys)
security:
  - bearerAuth: []
tags:
  - name: Accounts
    description: Your accounts and their balances.
  - name: Recipients
    description: People and businesses you pay, and where to pay them.
  - name: Payments
    description: Paying recipients, including across currencies.
  - name: Transfers
    description: Moving money between your own accounts.
  - name: Payment links
    description: Links anyone can open to pay you by card.
  - name: Customers
    description: People and businesses who pay you.
  - name: Invoices
    description: One-off invoices and recurring series.
paths:
  /v1/transfers/{transferId}:
    get:
      tags:
        - Payments
      summary: Retrieve a payment
      description: >-
        A payment as it stands. Poll this while `status` is `pending` or
        `processing`.


        `recipientId` is not returned on reads.


        Requires the `payments:read` scope.
      operationId: getTransfer
      parameters:
        - name: transferId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The transfer.
          content:
            application/json:
              schema:
                type: object
                properties:
                  transfer:
                    $ref: '#/components/schemas/Transfer'
        '401':
          description: >-
            `UNAUTHENTICATED`: The access token is missing, expired or revoked.
            Get a new token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            `INSUFFICIENT_SCOPE`: Your API key lacks the scope this operation
            needs. The scope is named in `message` and the `WWW-Authenticate`
            header.


            `ENVIRONMENT_MISMATCH`: The request named a different environment
            from the key's.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            `NOT_FOUND`: It doesn't exist, or isn't yours. The answer is the
            same for both.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`RATE_LIMITED`: Too many requests. Wait for `Retry-After` seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`UPSTREAM_UNAVAILABLE`: Temporarily unavailable. Retry with backoff.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Transfer:
      type: object
      required:
        - id
        - fromAccountId
        - destinationId
        - minorUnits
        - currency
        - status
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        fromAccountId:
          type: string
        recipientId:
          type: string
          description: Returned when the payment is sent; absent on reads.
        destinationId:
          type: string
        minorUnits:
          type: string
          description: Integer minor units as a string.
        currency:
          type: string
        status:
          type: string
          enum:
            - pending
            - processing
            - successful
            - failed
            - reversed
          description: >-
            `pending` and `processing`: accepted, money hasn't moved.
            `successful`: it left. `failed`: it didn't, and the reservation was
            released. `reversed`: it left and came back.
        narration:
          type: string
        reason:
          type: string
          description: Why it was paid, as `SendTransfer.reason`.
        failureReason:
          type: string
          description: Why it failed, in the payment network's words.
        createdAt:
          type: integer
          format: int64
          description: Epoch milliseconds.
        updatedAt:
          type: integer
          format: int64
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Branch on this, not on `message`. See Errors.
            message:
              type: string
              description: For people. Wording can change.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token (`at_test_…` or `at_live_…`) from `POST
        https://idp.talescria.com/oauth/token`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.