> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # Get payment > > 🚧 Beta > This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint. Get a payment by ID. ## OpenAPI ````yaml openapi-v2.json get /payments/{payment_id} openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 2.5.0 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Create and manage spending controls name: Spend Controls (beta) - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Rates name: Rates - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: API for point-in-time account balances name: account_balances - description: Requests to create and manage webhooks name: Webhooks - description: > Vendor-agnostic daily snapshots of a credit account's state (balances, past-due status, per-bucket breakdown). Populated first from LoanPro, but not specific to it. Internal-only: there is no public write path, only an internal sync job. name: Credit Account Daily Snapshots - description: Tenant Config name: Tenant Config - description: Create and manage documents. name: Documents - description: Request to create and manage statements name: Statements - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Lending Config name: Lending Config - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Payments related to lending accounts name: Payments - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Manage negative balance processes name: Negative Balance - description: Create and manage wire transfers name: Wires - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: Create and manage transactions name: Transactions (beta) - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Autopay payment records for billing periods name: Autopays - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Requests to create and manage API keys name: API Keys - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create licenses name: Licenses - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to Admins to grant permissions to user name: Request Permissions - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Bulk card issuance name: Bulk Issuance - description: Requests to search financial institutions name: Institutions (Beta) - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: | Saved prefills for the internal transfer form name: Internal Transfer Templates - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to grant, list, update, and revoke role bindings name: Role Bindings - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) - description: Manage credit disputes name: Credit Disputes paths: /payments/{payment_id}: summary: Payment by ID get: tags: - Payments summary: Get payment description: > > 🚧 Beta > This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint. Get a payment by ID. operationId: getPayment parameters: - $ref: '#/components/parameters/payment_id' responses: '200': content: application/json: schema: $ref: '#/components/schemas/payment1' description: Payment details '401': $ref: '#/components/responses/unauthorized1' '403': $ref: '#/components/responses/forbidden1' '404': $ref: '#/components/responses/not_found1' '500': $ref: '#/components/responses/internal_server_error1' components: parameters: payment_id: description: Payment ID example: 2d0f7601-ecc6-48b4-b82f-5d64fa84628b in: path name: payment_id required: true schema: format: uuid type: string schemas: payment1: description: A one-time payment made against a lending account. properties: attempt_history: $ref: '#/components/schemas/autopay_attempt_history' creation_time: description: Timestamp when the payment was created example: '2024-01-15T10:30:00Z' format: date-time type: string current_amount: description: > The amount in cents associated with this payment. For PENDING payments this is the originally requested amount (payments are not capped at the current balance -- an intentional overpayment is honored). For EXECUTED payments this mirrors executed_amount. example: 5000 format: int64 type: integer description: description: Description for the payment example: Payment type: string effective_date: description: Date the payment was (or will be) made example: '2024-01-25' format: date type: string executed_amount: description: The amount in cents actually paid, once executed. example: 5000 format: int64 type: integer id: description: Unique identifier for the payment example: 2d0f7601-ecc6-48b4-b82f-5d64fa84628b format: uuid type: string last_updated_time: description: Timestamp when the payment was last updated example: '2024-01-15T10:30:00Z' format: date-time type: string lending_account_id: description: The lending account this payment was made against example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string payment_attributes: $ref: '#/components/schemas/autopay_payment_attributes' payment_configs: $ref: '#/components/schemas/autopay_payment_configs' status: $ref: '#/components/schemas/autopay_status' tenant: $ref: '#/components/schemas/tenant' required: - creation_time - description - effective_date - id - last_updated_time - lending_account_id - payment_configs - status type: object autopay_attempt_history: description: History of execution attempts for an autopay properties: attempts: description: List of execution attempts, ordered chronologically items: $ref: '#/components/schemas/autopay_attempt' type: array required: - attempts type: object autopay_payment_attributes: description: | Identifiers for the payment created by an autopay execution. Only one field will be populated depending on the payment method used. properties: ach_id: description: ACH transaction ID when payment method is "ach" example: 6a4b1045-cdd0-82f8-f26c-9e08ce28062f format: uuid type: string transaction_id: description: Internal transaction UUID when payment method is "internal_transfer" example: 7b5c2156-dee1-93a9-a37d-0f19df39173a format: uuid type: string type: object autopay_payment_configs: description: Payment method-specific configurations properties: ach: $ref: '#/components/schemas/ach_payment_config' internal_transfer: $ref: '#/components/schemas/internal_transfer_payment_config' type: object autopay_status: description: | Status of the autopay: - PENDING: Autopay is scheduled and waiting to be executed - EXECUTED: Autopay was successfully executed - SKIPPED: Autopay was skipped (e.g., no balance due) - FAILED: Autopay failed to execute enum: - EXECUTED - FAILED - PENDING - SKIPPED type: string tenant: properties: bank_id: description: Bank ID example: 6 type: integer partner_id: description: Partner ID example: 6 type: integer required: - bank_id - partner_id title: Tenant type: object error1: description: Synctera error responses in API v1 implement a custom error schema. properties: code: description: > A machine-readable string that identifies the error for programmatic use. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'Missing required fields: first_name, dob' type: string status: description: HTTP status code for this response example: 400 type: integer title: Synctera error response type: object autopay_attempt: description: A single attempt to execute an autopay properties: attempted_at: description: Timestamp when the attempt was made example: '2024-01-25T14:30:00Z' format: date-time type: string payment_attributes: $ref: '#/components/schemas/autopay_payment_attributes' reason: description: Reason for failure or skip (if applicable) example: Insufficient funds in payment source account type: string status: $ref: '#/components/schemas/autopay_attempt_status' required: - attempted_at - status type: object ach_payment_config: description: Configuration specific to ACH payment method properties: external_account_id: description: The external account ID to debit via ACH example: 8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e format: uuid type: string is_same_day: description: Whether to send as same-day ACH (default false) example: true type: boolean sec_code: description: Standard Entry Class Code (WEB, CCD, or PPD). Default is WEB. enum: - CCD - PPD - WEB example: WEB type: string required: - external_account_id type: object internal_transfer_payment_config: description: Configuration specific to internal transfer payment method properties: source_account_id: description: The internal Synctera platform account ID to transfer funds from example: 8f5b4c62-f5a0-4e68-9669-19dbc7a74d8e format: uuid type: string subtype: description: >- Transaction subtype for the internal transfer. Defaults to "one_time_payment" when autopay_type is MANUAL (POST /v1/payments), otherwise "auto_payment". example: autopay_payment type: string required: - source_account_id type: object autopay_attempt_status: description: > Status of an autopay attempt: - SUCCESS: The attempt succeeded and payment was initiated - FAILED: The attempt failed (e.g., insufficient funds, validation error) - SKIPPED: The attempt was skipped (e.g., no balance due, already paid) enum: - FAILED - SKIPPED - SUCCESS type: string responses: unauthorized1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Unauthorized forbidden1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Forbidden not_found1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Resource not found internal_server_error1: content: application/json: schema: $ref: '#/components/schemas/error1' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````