IVPAY Docs
  • Welcome
  • Get started
    • Setup guide
    • Concepts
    • Guides
      • Obtaining API Keys
    • Fiat currencies
    • Webhooks
    • Support
  • IVPAY API
    • Introduction
    • Authentication
    • API Reference
      • Payments
Powered by GitBook
On this page
  • GET Get payment
  • Endpoint
  • Headers
  • Response
  • POST Create a new payment
  • Endpoint
  • Headers
  • Body
  • Response
  • Statuses
  1. IVPAY API
  2. API Reference

Payments

The Payment resource in IVPAY allows you to create and read payment requests. You can initiate payments with specified fiat amounts and monitor their statuses. This resource simplifies payment management, ensuring efficient handling of transactions for businesses.

GET Get payment

Get the payment details

Endpoint

GET /payment/{payment_id}

Headers

Name
Value

Content-Type

application/json

X-API-KEY

your_api_key_here

Response

{
  "success": true,
  "data": {
    "payment_id": "6b577835afbefe60335b6e5cd04410a9",
    "foreign_id": "123456",
    "processed_at": 1726248785,
    "status": "PAID"
  }
}
{
  "success": false,
  "error": "Error message"
}
{
  "success": false,
  "error": "Wrong auth parameters"
}

POST Create a new payment

Create a payment for the customer for a specified amount

Endpoint

POST /payment/create

Headers

Name
Value

Content-Type

application/json

X-API-KEY

your_api_key_here

Body

Name
Type
Required
Description

amount_fiat

string

Yes

Amount for payment

currency_fiat

string

Yes

Fiat currency ticker

foreign_id

string

No

Additional field (internal id, for example)

url_success

string

No

URL where to redirect the customer after a successful payment

url_failed

string

No

URL where to redirect the customer after a failed payment

Response

{
  "success": true,
  "data": {
    "payment_id": "6b577835afbefe60335b6e5cd04410a9",
    "payment_url": "https://pay.ivpay.io/payment/6b577835afbefe60335b6e5cd04410a9",
    "created_at": 1726248776,
    "foreign_id": "123456",
  }
}
{
  "success": false,
  "error": "Error message"
}
{
  "success": false,
  "error": "Wrong auth parameters"
}

Statuses

PreviousAPI Reference

Last updated 7 months ago

()

The possible payment statuses are explained .

List of supported currencies
here