Skip to content

Get Installment

Request

Security
OAuth2ClientCredentials(Required scopes: organization:payflow:read)
Path
payflow_idstring(Payflow Id)^[a-fA-F0-9]{24}$required
installment_idstring(Installment Id)^[a-fA-F0-9]{24}$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.

GET
/api/payments/{payflow_id}/installments/{installment_id}
curl -i -X GET \
  'https://api.spense.no/api/payments/{payflow_id}/installments/{installment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Organization-Id: string'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required
datestring, (date)(Date)required
typestring(Type)required
Enum:"initial""scheduled"
grossAmountnumber(Grossamount)required
statusstring(PaymentStatus)required
Enum:"DRAFT""CREATED""SENT""OPENED""FAILED""PENDING""PAID""CANCELLED"
numTriedinteger(Numtried)required
successfullyChargedAtstring or null(Successfullychargedat)required
Any of:
string (date-time)
numFailedinteger(Numfailed)required
lastFailedAtstring or null(Lastfailedat)required
Any of:
string (date-time)
Response
{
  "id": "string",
  "date": "2019-08-24",
  "type": "initial",
  "grossAmount": 0,
  "status": "DRAFT",
  "numTried": 0,
  "successfullyChargedAt": "2019-08-24T14:15:22Z",
  "numFailed": 0,
  "lastFailedAt": "2019-08-24T14:15:22Z"
}
Copyright © Spense AS