Payments & ACH

Manage payment card operations including loading and balance checks.

Base URL: /api/v1/partner/payments

Endpoints Overview

Method	Endpoint	Description
POST	/load	Load a Payment Card
POST	/balance	Check balance of a Payment Card

---

Load a Payment Card

POST /api/v1/partner/payments/load

Load funds onto a payment card. Send a LoadPaymentCardRequest with the card number and amount. Supports legacy Linx card integration — if paymentCardNumber is empty but linxCardNumber is provided, the system automatically uses the Linx card.

Request Body

Fields

Field	Type	Required	Description
type	string	No	Type. One of: Linx, Clover, Mtrac
paymentCardNumber	string	No	Payment Card Number
amount	number	No	Amount
creditCard	CreditCard	No	Credit Card
linxCardNumber	string	No	Linx Card Number
transactionId	string	No	Transaction identifier

JSON

{
  "type": "Linx",
  "paymentCardNumber": "string",
  "amount": 0,
  "creditCard": {
    "number": "string",
    "name": "string",
    "cvv": "string",
    "expirationMonth": "string",
    "expirationYear": "string",
    "zipCode": "90210",
    "zip_code": "string"
  },
  "linxCardNumber": "string",
  "transactionId": "abc123"
}

Response

Returns a LoadPaymentCardResponse object.

Fields

Field	Type	Required	Description
loadedTotal	number	No	Loaded Total
feeTotal	number	No	Fee Total
chargedTotal	number	No	Charged Total

JSON

{
  "loadedTotal": 0,
  "feeTotal": 0,
  "chargedTotal": 0
}

---

Check balance of a Payment Card

POST /api/v1/partner/payments/balance

Check the current balance of a payment card. Send a PaymentCardBalanceCheckRequest with the card number. Same Linx card backward compatibility applies as the load endpoint.

Request Body

Fields

Field	Type	Required	Description
type	string	No	Type. One of: Linx, Clover, Mtrac
paymentCardNumber	string	No	Payment Card Number
linxCardNumber	string	No	Linx Card Number

JSON

{
  "type": "Linx",
  "paymentCardNumber": "string",
  "linxCardNumber": "string"
}

Response

Returns a PaymentCardBalanceCheckResponse object.

Fields

Field	Type	Required	Description
status	string	No	Status
balance	number	No	Balance
cardStatus	string	No	Card Status

JSON

{
  "status": "string",
  "balance": 0,
  "cardStatus": "string"
}