LogoLogo
  • OKP APIs
  • Getting Started with OKP
  • API Documentation
    • Deposits API
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Deposit Creation Endpoint
          • Notifications
        • Transactional Account Endpoint
          • Understanding the Solution
        • PCI Deposit Creation Endpoint
        • Deposit Status Endpoint
        • Payment Methods Endpoint
        • Currency Exchange Endpoint
        • Crypto Exchange Endpoint
        • Country States Codes Endpoint
        • Refund Creation Endpoint
          • Notifications
        • Refund Status Endpoint
      • Payment Methods
        • 🌎America
          • 🇧🇷Brazil
            • PIX Biometric
      • API Codes
    • Cashouts API
      • Technical and Security Aspects
        • Calculating the Payload-Signature
      • Endpoints
        • Cashout Creation Endpoint
          • Notifications
        • Cashout Status Endpoint
        • Cashout Update Status Endpoint
        • Cashout Cancellation Endpoint
        • Cashout Bank Codes
      • Countries Validations
        • American Countries
          • 🇧🇷Brazil
      • API Codes
    • Subscriptions API
      • Technical and Security Aspects
        • Calculating the Signature
      • Subscription Creation Endpoints
        • OneShot Subscription Creation
        • PCI Subscription Creation Endpoint
        • Notifications
      • Subscription Cancellation Endpoint
      • Subscription Status Endpoint
    • Quickpay
      • Endpoints
        • Deposit creation endpoint
          • Notifications
        • Deposit status endpoint
    • Bank Account Validation
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Bank Account Validation Endpoint
          • Pix Key Validation and Details Endpoint
      • API Codes
    • KYC API
      • Technical and Security Aspects
        • Calculating the Signature
      • KYC Endpoint
      • API Codes
  • Deposits Tools
    • Cards SDK
      • With User Interface
        • 🚀Color Customization
      • Without User Interface
    • Java SDK
    • PHP SDK
  • Knowledge Base
    • Deposits with Cards SDK
      • With User Interface
      • Without User Interface
    • Countries Specifications
  • PLUGINS
    • WooCommerce
      • Installation
      • Configuration
  • Status Page
Powered by GitBook
On this page
  1. API Documentation
  2. Quickpay
  3. Endpoints

Deposit status endpoint

Retrieve the status of a previously created deposit

Given that QuickPay uses the same Deposit Status Endpoint than our Deposits APIs, please check Deposit Status Endpoint for further details about the integration.

In the case of QuickPay (and COMPLETED) transactions, this endpoint will add extra information about the customer KYC.

Example response

  • Be aware that the field full_name is the name validated by our KYC engine, while first_name and last_name is the info client was first registered with in our database.

  • Birth date format is yyyyMMdd

{
    "user_id": "11",
    "deposit_id": 123456789,
    "invoice_id": "ql4vhBUlvnic",
    "country": "BR",
    "currency": "BRL",
    "usd_amount": 35.00,
    "local_amount": 281.06,
    "bonus_amount": 0.00,
    "bonus_relative": false,
    "payment_method": "IX",
    "payment_type": "BANK_TRANSFER",
    "status": "COMPLETED",
    "payer": {
        "document": "84932568207",
        "document_type": "CPF",
        "email": "johnSmith12@gmail.com",
        "first_name": "John",
        "last_name": "Smith",
        "birth_date": "19770930",
        "full_name": "John Smith",
        "pep": true,
        "legal_situation": "REGULAR"
    },
    "refunded": false,
    "current_payer_verification": "NO_CURRENT_PAYER_DATA"
}

PreviousNotificationsNextBank Account Validation

Last updated 1 year ago