Skip to main content
Propaga’s API provides a comprehensive set of endpoints to integrate Buy Now, Pay Later (BNPL) functionality into your platform. This guide provides an overview of all available API endpoints organized by category.
For detailed API documentation including request/response examples, parameters, and error codes, visit the API Reference section.

​
Authentication

All API requests require authentication using an API key provided by the Propaga team. Include this key in the Authorization header of every request.

Authentication

Learn more about API authentication
 Base URLs:
  • Production: https://api.propaga.io
  • Staging: https://staging-api.propaga.io

​
API Categories

​
Account Management

Manage user accounts, verification codes, and user data updates.

Create verification code

Create a new account record and send an OTP code to the customer

Validate token

Validate the OTP code sent to the user

Resend verification code

Resend the account verification code to the user

Create contract link

Generate a contract link for the user

Update user data

Update user information

​
Transaction Management

Create, manage, and track transactions throughout their lifecycle.

Create transaction

Create a new transaction and send a verification code to the customer

Create transaction by batch

Create multiple transactions in a single request

Create transaction link

Generate a payment link for a transaction

Get transaction

Retrieve transaction details by transaction ID

Get transaction by external ID

Retrieve transaction details using your internal transaction ID

Validate transaction verification

Validate the OTP code for a transaction

Resend transaction verification

Resend the verification code for a transaction

Resend verification code

Resend verification code to the customer

Update transaction delivery

Update the delivery status of a transaction

Update transaction cancel

Cancel a transaction

Update delivery word

Update the delivery word for a transaction

Resend delivery word

Resend the delivery word to the customer

Create transaction invoice

Generate an invoice for a transaction

Get transaction invoice

Retrieve invoice information for a transaction

Create simulation

Create a transaction simulation for testing

Get transactions pending to notify

Retrieve list of transactions pending notification

​
Corner Store Management

Manage corner store information and operations.

Get corner store information

Retrieve corner store details by external ID

Get corner store information batch

Retrieve multiple corner stores in a single request

Get default information

Get default corner store configuration

Create waiting list record

Add a new record to the waiting list

​
KYC (Know Your Customer)

Handle customer onboarding and KYC verification processes.

Corner store onboarding

Complete the onboarding process for a corner store

Create KYC link

Generate a KYC verification link for the customer

Corner store name

Update or retrieve corner store name information

​
External Payments

Integrate with external payment providers and handle payment notifications.

Notify payment

Send payment notification to Propaga

Notify Facilito payment

Send Facilito payment provider notification

Get amount to pay

Retrieve the amount due for a transaction

​
Invoice Management

Retrieve and manage invoice information.

Get invoice information

Retrieve invoice details by invoice ID

​
Integration Flow

The typical integration flow involves the following steps:
1

User Registration

Use the Account Management APIs to create and verify user accounts. This includes sending verification codes and validating OTP tokens.
2

KYC Verification

Complete the KYC process using the KYC endpoints to onboard corner stores and verify customer information.
3

Transaction Creation

Create transactions using the Transaction Management APIs. This includes sending verification codes to customers and managing the transaction lifecycle.
4

Transaction Verification

Validate transaction verification codes and update transaction statuses as needed (delivery, cancellation, etc.).
5

Payment Processing

Integrate with external payment providers using the External Payments APIs to notify Propaga of completed payments.

API Reference

Complete API documentation with detailed endpoints, parameters, and examples

Transaction Flow

Understand the complete transaction lifecycle

Transaction Status

Learn about transaction statuses and their meanings

User Status Flow

Understand user account statuses

Working with Propaga

General overview of how Propaga works

​
Webhooks

Propaga also provides webhooks to notify your system of important events. Learn more about available webhooks in the Webhooks section.