API Reference PomeloEx v#0.1.0

PomeloEx is an Elixir client library for the Pomelo API.

OTP Application module for PomeloEx.

Card-to-account and card-to-credit-line associations.

Card-to-credit-line association management.

Card-to-user-account linking.

Credit products, lines, and lending management.

This service enables you to report user payments and the associated benefits or charges over a credit line. Find more information about allocations in our documentation.

The Available Plans service allows you to obtain installment plans and refinancing plans for each credit line, facilitating the management of flexible payment options for your users.

Credit line management (V1 API).

The Credit Lines V2 service allows you to create and manage credit products, segments, pricing configurations, and credit lines.

The Credit Product service allows you to create and manage credit products and their segments.

Webhooks for debt sale to banks (Bancarización de deuda).

Webhook handler for debt adjustment events.

Webhook handler for debt cancellation events.

Webhook handler for debt creation events.

Webhook handler for debt payment events.

Webhook handler for debt transfer events.

The Hierarchies service allows you to create and manage hierarchical nodes within a credit line, organizing them into a structure of areas and users with their own or inherited credit limits.

This service allows you to query the performed operations.

This service allows you to inquire about the account statements for the different Credit Lines. Find more information about Account Statements in our documentation.

This service will be in charge of notifying you of events related to credit cards.

Webhook handler for created summaries notifications.

Webhook handler for credit line pause/unpause notifications.

Webhook handler for credit arrears notifications.

Webhook handler for processed credit transaction notifications.

Webhook handler for reversed credit transaction notifications.

Card issuance lifecycle management.

Card creation, activation, and lifecycle management.

Card shipment management and tracking.

Transaction processing and authorization.

On-us transaction processing (same-issuer transactions).

Tax calculation and retrieval for card statements.

Transaction authorization, adjustments, and notifications.

Sensitive card data handling.

User authentication for sensitive card data access.

Integration Flow To display sensitive information or activated your users' cards, follow these steps

Digital card token lifecycle management.

Visa Click to Pay management.

The following endpoints are used during the push provisioning flow to generate the cryptographic data that your application needs to send to the virtual wallet. Before using them, confirm with our integrations team that you have everything prepared.

Standalone token management.

Visa Account Updater (VAU) management.

The following endpoints are used during the push provisioning flow to generate the cryptographic data that your application needs to send to the virtual wallet. Before using them, confirm with our integrations team that you have everything prepared.

Webhook notifications for token lifecycle events.

Digital account lifecycle management.

Digital money movements and P2P transactions.

Digital account and activity queries.

Webhook notifications for digital account activities.

Webhook handler for digital account activity notifications.

Financial settlement management.

The Chargebacks service allows you to create and manage chargebacks for payment transactions.

Attaches a file to a chargeback.

Webhook handler for chargeback notifications.

The Soft Block service allows you to temporarily soft-block merchants based on failed transaction attempts, providing protection against suspicious activity.

The Transactional Block service allows you to manage transaction blocks by merchant (name, ID, or MCC) or by country, with flexible duration.

The Travel Notice service allows you to temporarily increase transaction limits for users when they make purchases abroad.

OAuth 2.0 authentication for the Pomelo API.

Manages company records in the Pomelo platform.

Manages user records in the Pomelo platform.

Know Your Business (KYB) identity verification for legal entities.

Know Your Customer (KYC) identity verification for individuals.

Webhook notifications for identity validation sessions.

Webhook handler for identity required file notifications.

Webhook handler for identity validation session notifications.

Loyalty The Loyalty API contains all the endpoints needed to manage loyalty campaigns and their rewards, whether points, cashback, or miles.