Payment

List payments

get

Lists existing payments with pagination

Query parameters

cursorstringOptional

Cursor for pagination

limitinteger · int64 · min: 1 · max: 100Optional

Maximum number of items to return

Example: 20

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/payment

HTTPcURLJavaScriptPython

GET /api/payment HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "items": [
    {
      "actionUrl": "text",
      "amount": 12.34,
      "card": {
        "binCode": "424242",
        "issuer": "visa",
        "last4": "5613",
        "number": "************4242"
      },
      "createdAt": "2023-11-21T02:00:54.465Z",
      "currency": "USD",
      "customer": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "text",
        "ssn": "text"
      },
      "externalId": "text",
      "id": "pay_550e8400-e29b-41d4-a716-446655440000",
      "metadata": "text",
      "responseCode": "text",
      "status": "EMAIL_VERIFICATION",
      "type": "CHECKOUT",
      "updatedAt": "2023-11-21T02:00:54.465Z"
    }
  ],
  "nextCursor": "text"
}

Create payment

post

Requests a new payment

Body

application/json

Payment creation data

amountnumber · decimal · min: 0.01Required

Payment amount

Example: 12.34

currencystringRequired

ISO4217 currency code

Example: USDPattern: ^[A-Z]{3}$

customerIpstringOptional

Customer IP address

externalIdstring · min: 1 · max: 255Required

External reference ID

Pattern: ^[a-zA-Z0-9_-]+$

failureUrlstring · uriOptional

Redirect URL on failed payment

metadatastringOptional

Metadata

successUrlstring · uriOptional

Redirect URL on successful payment

Responses

200

OK

application/json

422

Payment declined

post

/api/payment

HTTPcURLJavaScriptPython

POST /api/payment HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 512

{
  "amount": 12.34,
  "card": {
    "cvc": "123",
    "expiry": {
      "month": 12,
      "year": 2034
    },
    "name": "John Doe",
    "number": "4242424242424242"
  },
  "currency": "USD",
  "customer": {
    "billingAddress": {
      "address1": "645 Washington Blvd",
      "address2": "text",
      "city": "Beaumont",
      "country": "DEU",
      "state": "TX",
      "zip": "77705"
    },
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "[phone]",
    "ssn": "123-45-6789"
  },
  "customerIp": "text",
  "externalId": "text",
  "failureUrl": "https://example.com",
  "metadata": "text",
  "successUrl": "https://example.com"
}

{
  "actionUrl": "text",
  "externalId": "text",
  "id": "pay_550e8400-e29b-41d4-a716-446655440000",
  "message": "text",
  "status": "AUTH_REQUESTED"
}

Create payments batch

post

Creates multiple payments atomically. All payments succeed or none are created. Maximum 100 payments per batch.

Body

application/json

Batch payment creation data

Responses

200

All payments created successfully

application/json

400

Invalid request: batch size exceeded, duplicate externalId in batch, or validation error

409

Duplicate externalId conflicts with existing payment

post

/api/payment/batch

HTTPcURLJavaScriptPython

POST /api/payment/batch HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "payments": [
    {
      "amount": 12.34,
      "card": {
        "cvc": "123",
        "expiry": {
          "month": 12,
          "year": 2034
        },
        "name": "John Doe",
        "number": "4242424242424242"
      },
      "currency": "USD",
      "customer": {
        "billingAddress": {
          "address1": "645 Washington Blvd",
          "address2": "text",
          "city": "Beaumont",
          "country": "DEU",
          "state": "TX",
          "zip": "77705"
        },
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "[phone]",
        "ssn": "123-45-6789"
      },
      "customerIp": "text",
      "externalId": "text",
      "failureUrl": "https://example.com",
      "metadata": "text",
      "successUrl": "https://example.com"
    }
  ]
}

{
  "payments": [
    {
      "actionUrl": "text",
      "externalId": "text",
      "id": "pay_550e8400-e29b-41d4-a716-446655440000",
      "message": "text",
      "status": "AUTH_REQUESTED"
    }
  ]
}

Create push-to-card payment

post

Requests a new push-to-card payment

Body

application/json

Push-to-card payment creation data

amountnumber · decimal · min: 0.01Required

Payment amount

Example: 12.34

currencystringRequired

ISO4217 currency code

Example: USDPattern: ^[A-Z]{3}$

externalIdstring · min: 1 · max: 255Required

External reference ID

Pattern: ^[a-zA-Z0-9_-]+$

metadatastringOptional

Metadata

Responses

200

OK

application/json

422

Push-to-card payment declined

post

/api/payment/ptc

HTTPcURLJavaScriptPython

POST /api/payment/ptc HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "amount": 12.34,
  "card": {
    "cvc": "123",
    "expiry": {
      "month": 12,
      "year": 2034
    },
    "name": "John Doe",
    "number": "4242424242424242"
  },
  "currency": "USD",
  "externalId": "text",
  "metadata": "text"
}

{
  "externalId": "text",
  "id": "ptc_550e8400-e29b-41d4-a716-446655440000",
  "message": "text",
  "status": "AUTH_REQUESTED"
}

Get payment

get

Retrieves an existing payment by ID

Path parameters

idstringRequired

payment ID

Responses

200

OK

application/json

default

Error

application/problem+json

get

/api/payment/{id}

HTTPcURLJavaScriptPython

GET /api/payment/{id} HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "actionUrl": "text",
  "amount": 12.34,
  "card": {
    "binCode": "424242",
    "issuer": "visa",
    "last4": "5613",
    "number": "************4242"
  },
  "createdAt": "2023-11-21T02:00:54.465Z",
  "currency": "USD",
  "customer": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "text",
    "ssn": "text"
  },
  "externalId": "text",
  "id": "pay_550e8400-e29b-41d4-a716-446655440000",
  "metadata": "text",
  "responseCode": "text",
  "status": "EMAIL_VERIFICATION",
  "type": "CHECKOUT",
  "updatedAt": "2023-11-21T02:00:54.465Z"
}

Confirm payment

post

Confirms an existing payment by ID

Path parameters

idstringRequired

payment ID

Responses

200

OK

application/json

default

Error

application/problem+json

post

/api/payment/{id}/confirm

HTTPcURLJavaScriptPython

POST /api/payment/{id}/confirm HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "message": "The payment has been successfully confirmed."
}

Create refund

post

Request payment refund

Path parameters

idstringRequired

payment ID

Body

application/json

Refund creation data

amountnumber · decimal · min: 0.01Optional

Refund amount (full amount if omitted)

Example: 5

externalIdstring · min: 1 · max: 255Required

External reference ID

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

OK

application/json

201

Refund request submitted

422

Request unprocessable

post

/api/payment/{id}/refund

HTTPcURLJavaScriptPython

POST /api/payment/{id}/refund HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "amount": 5,
  "externalId": "text"
}

{
  "amount": 12.34,
  "createdAt": "2023-11-21T02:00:54.465Z",
  "id": "ref_550e8400-e29b-41d4-a716-446655440000",
  "paymentId": "pay_550e8400-e29b-41d4-a716-446655440000"
}