Palla Accounts API

openapi: 3.0.3
info:
  title: Palla Platform Partner Accounts API
  version: '1.0'
  description: The Palla Platform API enables trusted Partners to embed cross-border peer-to-peer (P2P) money transfers into their own applications. Partners exchange client credentials for a scoped Bearer token that authorizes a specific end User, then manage that User's Account, Payment Methods, Links, Relationships, and Transfers. Responses use a consistent envelope with a `meta` block (code, path, requestId, result) plus either a `data` payload on success or an `error` object (message, rc, description) on failure. Derived from the public Palla Platform Partner Docs Postman collection; not an official Palla-published OpenAPI document.
  contact:
    name: Palla Financial
    url: https://www.palla.com
  termsOfService: https://palla.app/terms-and-conditions
servers:
- url: https://api.platform.palla.app
  description: Production
security:
- partnerToken: []
tags:
- name: Accounts
  description: An Account belongs to a User authorized to use Palla.
paths:
  /v1/accounts:
    post:
      operationId: createAccount
      tags:
      - Accounts
      summary: Create Account
      description: 'Create an Account for the authorized User. This endpoint is idempotent: if the account exists, the provided values are used to update it.'
      parameters:
      - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAccountRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/Meta'
                  data:
                    $ref: '#/components/schemas/Account'
    get:
      operationId: fetchAccountDetails
      tags:
      - Accounts
      summary: Fetch Account Details
      description: Get the profile data of an Account, including any associated Identity.
      parameters:
      - $ref: '#/components/parameters/RequestId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/Meta'
                  data:
                    $ref: '#/components/schemas/Account'
components:
  parameters:
    RequestId:
      name: x-palla-request-id
      in: header
      required: false
      description: Partner-supplied request id echoed back in meta.requestId for tracing.
      schema:
        type: string
        example: my-request-id
  schemas:
    CreateAccountRequest:
      type: object
      required:
      - legalName
      properties:
        legalName:
          $ref: '#/components/schemas/LegalName'
        dob:
          $ref: '#/components/schemas/DateOfBirth'
        displayName:
          type: string
          example: Juan Perez
    Meta:
      type: object
      properties:
        code:
          type: integer
          example: 200
        path:
          type: string
          example: /v1/accounts
        requestId:
          type: string
          example: my-request-id
        result:
          type: string
          enum:
          - success
          - failure
          example: success
        requestCountry:
          type: string
          example: US
        itemCount:
          type: integer
        itemLimit:
          type: integer
        itemOffset:
          type: integer
        itemTotal:
          type: integer
    LegalName:
      type: object
      required:
      - first
      - last
      properties:
        first:
          type: string
          example: Juan
        middle:
          type: string
          example: Luis
        last:
          type: string
          example: Perez
    Account:
      type: object
      properties:
        created:
          type: integer
          format: int64
        type:
          type: string
          example: personal
        status:
          type: string
          example: active
        displayName:
          type: string
        legalName:
          $ref: '#/components/schemas/LegalName'
    DateOfBirth:
      type: object
      properties:
        day:
          type: integer
          example: 30
        month:
          type: integer
          example: 5
        year:
          type: integer
          example: 1979
  securitySchemes:
    partnerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Partner Bearer token obtained from POST /v1/auth/token via a client_credentials exchange. Scoped to a single User via user_id.
    clientCredentials:
      type: oauth2
      description: Partner credential exchange (client_credentials grant). Sent as a JSON body to /v1/auth/token with client_id, client_secret, audience, and user_id; returns a Bearer token in data.token.
      flows:
        clientCredentials:
          tokenUrl: https://api.platform.palla.app/v1/auth/token
          scopes: {}
x-generated: '2026-07-20'
x-method: derived
x-source: https://documenter.getpostman.com/view/306637/TzkyP11Z (Palla Platform Partner Docs, Postman collection 306637-8e63aa5e-0996-47f9-b589-997c3e9c81bd)