Magnius API (20.03.0)

Magnius payments API

Authentication

API Key

Security Scheme Type API Key
Header parameter name: apikey

JWT

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

3D

Enroll

Enroll a given transaction for 3D-secure to verify whether authentication is supported for the card being used

Responses

200

Transaction enrolled

post /3d/enroll
/v1/3d/enroll

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "pareq": "string",
  • "url": "string"
}

Authorization

An Authorization Request is made by posting your payment profile id and the unmodified pares to /v1/3d/authorization

Request Body schema: application/json

Authorize transaction

pares
required
string

The Payment Authorization Result

Responses

200

Transaction authorized

post /3d/authorization
/v1/3d/authorization

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "pares": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "cavv2": "string",
  • "code": "string",
  • "eci": "string",
  • "status": "string"
}

Bank Account

List bank accounts

query Parameters
_limit
integer
Default: "2000"
_populate
string

Populates the full details of a related resource. Multiple populated fields are also possible if provided several times within the same query string

_skip
integer

Skips a number of results

_sort
string

Sorts the results by ascending order according to the provided field. If the field is prefixed with '-'' (e.g. -created_at), the order is descending. Multiple sort also works if provided several times within the same query string

Responses

200

Success response

get /bankaccount
/v1/bankaccount

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create new bank account

Request Body schema: application/json

Create new bank account

bank_account_number
required
string

Bank account number

description
string

Description

holder_name
required
string

Bank account holder name

Responses

200

Success

post /bankaccount
/v1/bankaccount

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "bank_account_number": "string",
  • "holder_name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organisation": "string",
  • "bank_account_number": "string",
  • "holder_name": "string",
  • "description": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Get bank account

path Parameters
Bankaccount Id
required
string

The id of the bank account to retrieve

Responses

200

Success response

get /bankaccount/{Bankaccount Id}
/v1/bankaccount/{Bankaccount Id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organisation": "string",
  • "bank_account_number": "string",
  • "holder_name": "string",
  • "description": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Update bank account

path Parameters
Bankaccount Id
required
string

The id of the bank account to update

Request Body schema: application/json

Update bankaccount

bank_account_number
required
string

Bank account number

description
string

Description

holder_name
required
string

Bank account holder name

Responses

200

Success

post /bankaccount/{Bankaccount Id}
/v1/bankaccount/{Bankaccount Id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "bank_account_number": "string",
  • "holder_name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organisation": "string",
  • "bank_account_number": "string",
  • "holder_name": "string",
  • "description": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

Delete bank account

path Parameters
Bankaccount Id
required
string

The id of the bank account to delete

Responses

200

Success

delete /bankaccount/{Bankaccount Id}
/v1/bankaccount/{Bankaccount Id}

Card

Get card

path Parameters
Card Id
required
string

The id of the card to retrieve

Responses

200

Success response

get /card/{Card Id}
/v1/card/{Card Id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "bin": "string",
  • "brand": "string",
  • "card_holder_country": "string",
  • "card_holder_name": "string",
  • "cvv_verified": true,
  • "expiry_month": 0,
  • "expiry_year": 0,
  • "issuer_country": "string",
  • "issuer_name": "string",
  • "last_four": "string",
  • "last_update_check": "string",
  • "organisation": "string",
  • "currency": "string",
  • "prepaid": true,
  • "type": "string",
  • "variant": "string",
  • "created_at": "2020-04-01T13:19:14Z"
}

Chargeback

List chargebacks

query Parameters
_limit
integer
Default: "2000"
_populate
string

Populates the full details of a related resource. Multiple populated fields are also possible if provided several times within the same query string

_skip
integer

Skips a number of results

_sort
string

Sorts the results by ascending order according to the provided field. If the field is prefixed with '-'' (e.g. -created_at), the order is descending. Multiple sort also works if provided several times within the same query string

Responses

200

Success response

get /chargeback
/v1/chargeback

Response samples