Mintcash
API reference

Payments

Create one-time charges and look them up by ID. Supports both hosted payment pages (HPP) and saved-card token flows.

A Payment represents one attempted charge against a customer's card. Every payment starts in created and ends in a terminal state (succeeded, failed, refunded, or voided) — the full state machine is in Concepts → Payments.

Create a payment

Create a payment.

Authentication: Basic Auth (public_key:secret_key) with merchant role.

@returns 200 - The created (or pre-existing) payment @returns 400 - Validation failure (amount, currency, missing returnUrl, missing billing, bad token) @returns 401 - Invalid or missing API credentials @returns 403 - Requires merchant access / merchant not active @returns 500 - No active Corefy provider configured @returns 502 - Provider returned an invalid response @returns 503 - Provider temporarily unreachable

POST
/payments
AuthorizationBasic <token>

In: header

amountnumber
billing?
callbackUrl?string
cardToken?string
currencystring
customer
description?string
externalIdstring
metadata?
returnUrl?string

Response Body

application/json

application/json

curl -X POST "https://sandbox.mintcash.me/payments" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "currency": "string",    "customer": {      "email": "string",      "externalId": "string",      "name": "string"    },    "externalId": "string"  }'
{
  "amount": 0,
  "amountRefundable": 0,
  "amountRefunded": 0,
  "createdAt": "string",
  "currency": "string",
  "externalId": "string",
  "id": "string",
  "providerTransactionId": "string",
  "redirectUrl": "string",
  "status": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}

Retrieve a payment

Get a payment by ID.

Authentication: Basic Auth (public_key:secret_key) with merchant role.

@returns 200 - The payment @returns 401 - Invalid or missing API credentials @returns 403 - Requires merchant access / merchant not active @returns 404 - Payment not found (or not owned by this merchant)

GET
/payments/{paymentId}
AuthorizationBasic <token>

In: header

Path Parameters

paymentIdstring

Response Body

application/json

application/json

curl -X GET "https://sandbox.mintcash.me/payments/string"
{
  "amount": 0,
  "amountRefundable": 0,
  "amountRefunded": 0,
  "createdAt": "string",
  "currency": "string",
  "externalId": "string",
  "id": "string",
  "providerTransactionId": "string",
  "redirectUrl": "string",
  "status": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}