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
  • Deposit Notification example
  • QuickPay Deposit Notification example
  1. API Documentation
  2. Quickpay
  3. Endpoints
  4. Deposit creation endpoint

Notifications

Learn about how the notifications for deposits works

QuickPay notifications about the change of status of a deposit use the same structure than a normal deposits as shown on Deposit Status Endpoint

Deposit Notification example


{
    "deposit_id": 123456789
}

Use the Deposit Status Endpoint to check the status of the transaction.

Also, before approving the transaction we send you an extra notification (if you have configured the callback URL for QuickPay) with the following details

QuickPay Deposit Notification example

{
  "depositId": 123456789,
  "document": "84932568207",
  "fullName": "John Doe",
  "cadastralSituation": "REGULAR",
  "dateOfBirth": "19871027",
  "pep": true,
  "address": "Rua 13, Sao Paulo, 12345-678 ",
  "email": "jon.doe@example.com",
  "success": true
}

You must respond with an HTTP 2XX code for the deposit to be approved. If you respond with anything different, a refund will be initiated.

This also triggers a notification similar to the previous one, but with the addition of the ‘refunded = true’ field.

{
  "depositId": 123456789,
  "document": "84932568207",
  "fullName": "John Doe",
  "cadastralSituation": "REGULAR",
  "dateOfBirth": "19871027",
  "pep": true,
  "address": "Rua 13, Sao Paulo, 12345-678 ",
  "email": "jon.doe@example.com",
  "success": true,
  "refunded":true
}
PreviousDeposit creation endpointNextDeposit status endpoint

Last updated 1 year ago