Introduction

Welcome to the CURO Payments API documentation.
This guide provides an overview of the API, its capabilities, and how to get started with integrating CURO Payments into your application.

Overview

The CURO Payments API is a RESTful API that allows merchants to process online payments securely and efficiently. The API supports a wide range of payment methods and provides comprehensive transaction management capabilities.

📘
Key Features:

Transaction Processing — Create and process payment transactions with various payment methods.

Transaction Management — Cancel, capture, refund, or void transactions as needed.

Recurring Payments — Set up and manage recurring payment schedules.

Transaction Status — Query the status of any transaction in real time.

Payment Options — Retrieve available payment methods for your merchant account.

Authentication

All API requests require authentication. You will need to include your user credentials with each request. Login to the backoffice and look under "API keys" to obtain your API credentials.

Request & Response Format

The API is able to process request and response in the following formats: JSON, XML, Serialize.
The default format for the CURO protocol is JSON.

All requests should include the appropriate Content-Type header:

📘Content-Type: application/json

Getting Started

To start using the CURO Payments API:

View your custom API keys via the back-office.
Review the available Payment Options for your account.
Create your first transaction using the Transactions endpoint.
Monitor transaction status via the Transaction Status endpoint.

📘
API Endpoints:
The API is organized into the following sections. Use the menu on the left or visit the API Reference for full details:

Transaction Create — Create new payment transactions.

Transaction Cancel — Cancel pending transactions.

Transaction Capture — Capture authorized transactions.

Transaction Details — Retrieve detailed transaction information.

Transaction Recurring — Manage recurring payments.

Transaction Refund — Process refunds for completed transactions.

Transaction Status — Check the current status of a transaction.

Transaction Void — Void authorized transactions.

Payment Options — Retrieve available payment methods.

Support

If you have any questions or need assistance with the API integration, please contact the CURO Payments support team.