Skip to content

Spense Partner APIs (v1)

Download OpenAPI description
partner.json
partner.yaml
Languages
Servers
Production API
https://api.spensepay.com/partner

Authentication

Operations

Settlements

Operations

Payment Methods

Operations

Payments

Operations

Print receipt on terminal when payment is PAID

Request

Security
OAuth2ClientCredentials
Path
payment_idstring(Payment Id)required
Headers
X-Organization-Idstring(X-Organization-Id)

Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required.

curl -i -X POST \
  'https://api.spensepay.com/partner/payments/{payment_id}/receipts/terminal/print' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Organization-Id: string'

Responses

Successful Response

Bodyapplication/json
object(Response Print Receipt)
Response
application/json
{}

Manually trigger payment as PAID

Request

Mark a payment as PAID manually, for example when receiving a bank transfer or cash payment. The payment must not already be in a final status.

Security
OAuth2ClientCredentials
Path
payment_idstring(Payment Id)required
Headers
X-Organization-Idstring(X-Organization-Id)

Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required.

Bodyapplication/jsonrequired
payment_methodstring(MarkAsPaidPaymentMethod)required
Enum"bank_terminal""bank_transfer""cash"
user_emailstring(email)(User Email)required
reasonReason (string) or Reason (null)(Reason)
Any of:
string(Reason)
curl -i -X POST \
  'https://api.spensepay.com/partner/payments/{payment_id}/manual-paid' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Organization-Id: string' \
  -d '{
    "payment_method": "bank_terminal",
    "user_email": "user@example.com",
    "reason": "string"
  }'

Responses

Successful Response

Bodyapplication/json
object(Response Mark Payment As Paid)
Response
application/json
{}
Copyright © Spense AS