Guides
  1. RESTful API

Entry points

Available Entry Points

The following entry points are currently available in the CURO REST API.
All entry points are relative to the API base URL: /rest/v1/curo/

Notation used:

  • <value> — required path parameter
  • [<value>] — optional path parameter (may also be supplied in the request body)

By Category

Information retrieval

Entry PointDescription
/transaction/<transaction-id>Retrieve transaction information for the given transaction-id.
/paymenttypes/[<site-id>]Retrieve payment types available for the given account or specific site-id.

Transaction generic

Entry PointDescription
/payment/[<payment-method>]Create a transaction.
/cancel/[<transaction-id>]Cancel a transaction.
/capture/[<transaction-id>]Capture an authorised transaction.
/refund/[<transaction-id>]Refund a transaction.
/recurring/[<transaction-id>]Create a recurring payment.
/status/[<transaction-id>]Retrieve transaction status.
/void/[<transaction-id>]Void authorisation or cancel transaction.

Alphabetic

Entry PointDescription
/cancel/[<transaction-id>]Cancel a transaction.
/capture/[<transaction-id>]Capture an authorised transaction.
/payment/[<payment-method>]Create a transaction.
/paymenttypes/[<site-id>]Retrieve payment types available for the given account or specific site-id.
/recurring/[<transaction-id>]Create a recurring payment.
/refund/[<transaction-id>]Refund a transaction.
/transaction/<transaction-id>Retrieve transaction information for the given transaction-id.
/void/[<transaction-id>]Void authorisation or cancel transaction.

Examples

Create a payment

POST /rest/v1/curo/payment/ideal/ HTTP/1.1
Host: secure.curopayments.net
Content-Type: application/json
Authorization: Basic <base64(merchant-id:api-key)>

{
    "site_id": "1234",
    "reference": "ORDER-0001",
    "amount": 1000,
    "currency_id": "EUR",
    "description": "Order 0001",
    "ip": "127.0.0.1",
    "url_success": "https://www.example.com/success",
    "url_failure": "https://www.example.com/failure",
    "url_callback": "https://www.example.com/callback"
}

Retrieve transaction information

GET /rest/v1/curo/transaction/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

Retrieve available payment types

GET /rest/v1/curo/paymenttypes/1234 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

Refund a transaction

POST /rest/v1/curo/refund/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Content-Type: application/json
Authorization: Basic <base64(merchant-id:api-key)>

{
    "amount": 1000,
    "currency_id": "EUR",
    "description": "Refund for order 0001"
}

Cancel a transaction

POST /rest/v1/curo/cancel/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

Capture an authorised transaction

POST /rest/v1/curo/capture/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

Create a recurring payment

POST /rest/v1/curo/recurring/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Content-Type: application/json
Authorization: Basic <base64(merchant-id:api-key)>

{
    "reference": "ORDER-0001-R1",
    "amount": 1000,
    "currency_id": "EUR",
    "description": "Recurring payment for order 0001"
}

Retrieve transaction status

GET /rest/v1/curo/status/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

Void a transaction

POST /rest/v1/curo/void/T1234567890 HTTP/1.1
Host: secure.curopayments.net
Authorization: Basic <base64(merchant-id:api-key)>

See also

  • Transactions — generic transaction request and response elements.
  • Refund — generic refund information.
  • Recurring — generic recurring information.

Updated 3 months ago

Did this page help you?