Get payment

Gets information about a previously created payment. Both regular payments and recurring payments can be retrieved with this method.

  • your-authorization should be replaced with your Authorization header, see Access
  • your-user-id in the URI, should be replaced with your identifier of the user
  • your-payment-id in the URI, should be replaced with the id for the payment that should be retrieved

Request

Copy
Copied
GET /v1/users/$(your-user-id)/payments/$(your-payment-id)

Accept: application/json
Authorization: $(your-authorization)

Response

Success

Response Schema: application/json
object (PaymentDto)
id
string
merchantId
string
type
string
Enum: "PAYMENT" "REFUND"
status
string
Enum: "CREATED" "CONFIRMED" "PROCESSING" "AUTHORIZED" "COMPLETE" "CANCELED" "USER_CANCELED" "PAYMENT_FAILED" "TIMEOUT" "SYSTEM_ERROR"
created
string

Created timestamp

cardAlias
string
cardType
string
Enum: "CARD" "SWISH" "WEBPAY_INVOICE" "RECURRING_CARD"
cardSubType
string

Currently only card brands when applicable, more types might be added later

Enum: "VISA" "MASTERCARD" "AMEX" "UNKNOWN"
amount
number
currency
string
purchaseReference
string
paymentPlanCampaignCode
number <int64>

WebPay payment plan campaign code

processorReference
object <string>

Reference used by the processor

processorCompleted
string

Completed time according to the processor. Currently only used for Swish payments

callback
boolean
application/json
{
  • "payment": {
    }
}
Error responses

Please refer to our HTTP response codes and Error codes to learn what error responses you may expect from the API.

Example

Try it
Loading...