API docs by Redocly

BNPL API (v1)

API documentation for BNPL API

_list

Authorizations:
Basic

Responses

api

api_v1.0_attachments_create

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601",
  • "name": "string",
  • "content_type": "string",
  • "file": "string"
}

api_v1.0_attachments_read

Authorizations:
Basic
path Parameters
attachment_id
required
string <uuid>

A UUID string identifying this attachment.

Responses

Response samples

Content type
application/json
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601",
  • "name": "string",
  • "content_type": "string",
  • "file": "string"
}

api_v1.0_bank-accounts_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_bank-accounts_create

Authorizations:
Basic
Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_bank-accounts_read

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Responses

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_bank-accounts_update

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_bank-accounts_partial_update

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_bank-accounts_delete

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Responses

api_v1.0_billing-addresses_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_billing-addresses_create

Authorizations:
Basic
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
email
required
string <email> (Email)
phone
required
string (Phone)
country
required
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
required
string (City) <= 255 characters
state
required
string (State) <= 255 characters
address1
required
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
required
string (Postal code) <= 255 characters
company
required
string (Company) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string"
}

api_v1.0_billing-addresses_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Responses

api_v1.0_billing-addresses_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
email
string <email> (Email)
phone
string (Phone)
country
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
string (City) <= 255 characters
state
string (State) <= 255 characters
address1
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
string (Postal code) <= 255 characters
company
string (Company) <= 255 characters
is_default
boolean (Is default)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

api_v1.0_billing-addresses_partial_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
email
string <email> (Email)
phone
string (Phone)
country
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
string (City) <= 255 characters
state
string (State) <= 255 characters
address1
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
string (Postal code) <= 255 characters
company
string (Company) <= 255 characters
is_default
boolean (Is default)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

api_v1.0_billing-addresses_delete

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Responses

api_v1.0_careem-pay_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_careem-pay_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_callback_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_careem-pay_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_careem-pay_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_careem-pay_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_cashback_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_cashback_create

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_cashback_issue_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_cashback_issue_create

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_cashback_withdraw_req

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_cashback_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this cashbacks.

Responses

api_v1.0_checkout_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
is_gift_card_checkout
boolean or null (Is gift card checkout)
Default: false
gc_type
string or null (Gc type)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "checkout_url": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

api_v1.0_checkout_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "checkout_url": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

api_v1.0_checkouts_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkouts_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_checkouts_check_ref

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkouts_gc_checkout_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkouts_gc_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
total
string <decimal> (Total)
gc_type
string or null (Gc type)

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "gc_type": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "gc_type": "string",
  • "gift_card_lec": "string"
}

api_v1.0_checkouts_generate_ref

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkouts_timeline

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_checkouts_read

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_checkouts_bind_new_user

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_checkouts_cancel_create

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (CancelCheckout)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_checkouts_cancel_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (CancelCheckout)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Confirms the order.

Approves the order with fraud model API Attaches current order to an authorized user Create the installments in billing app Creates and authorizes the first installment's capture transaction if due today. Emits order confirm event Notifies merchant

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

Confirms the order.

Approves the order with fraud model API Attaches current order to an authorized user Create the installments in billing app Creates and authorizes the first installment's capture transaction if due today. Emits order confirm event Notifies merchant

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_checkouts_confirm_cpay_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
cpay_request
object or null (Cpay request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

api_v1.0_checkouts_confirm_cpay_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
cpay_request
object or null (Cpay request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

api_v1.0_checkouts_confirm_new_card

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
required
object (MarkPaidDetails)

Responses

Request samples

Content type
application/json
{
  • "mark_paid": {
    }
}

Response samples

Content type
application/json
{
  • "mark_paid": {
    }
}

api_v1.0_checkouts_confirm_no_card_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_checkouts_confirm_no_card_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_checkouts_confirm_qr_update

Similar to confirm but triggered from the merchant side (for qr scanner flow) See confirm description

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_checkouts_confirm_qr_partial_update

Similar to confirm but triggered from the merchant side (for qr scanner flow) See confirm description

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

Confirms order by switching plan to No Pay Today.

Approves order for users with ISF on merchants with pass_isf_as_npt active

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (ISFToNPTConfirm)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_checkouts_defer_step

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_checkouts_get_plans_from_risk

Fetch plans from risk when merchant flag set

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_checkouts_status_checkout_card

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { }
}

api_v1.0_consumer-risk-data-upload_list

Authorizations:
Basic

Responses

api_v1.0_consumer-risk-data-upload_create

Authorizations:
Basic

Responses

api_v1.0_consumer-score_create

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_consumer-score_get_merchant_spend_limit

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_consumer-score_get_preapproval

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_consumer-score_get_spend_limit

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_consumer-score_update_consumer_score

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_demos_create

Authorizations:
Basic
Request Body schema: application/json
required
userType
string or null (UserType) <= 100 characters
full_name
required
string (Full name) [ 1 .. 500 ] characters
lastName
string or null (LastName) <= 100 characters
company_name
required
string (Company name) [ 1 .. 500 ] characters
countryCode
string or null (CountryCode) <= 100 characters
company_phone_number
string or null (Company phone number) <= 100 characters
company_email
string or null <email> (Company email) <= 254 characters
companySize
string or null (CompanySize) <= 100 characters
industry
string or null (Industry) <= 100 characters
description
string or null (Description) <= 100 characters
desc
string or null (Desc) <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "userType": "string",
  • "full_name": "string",
  • "lastName": "string",
  • "company_name": "string",
  • "countryCode": "string",
  • "company_phone_number": "string",
  • "company_email": "user@example.com",
  • "companySize": "string",
  • "industry": "string",
  • "description": "string",
  • "desc": "string"
}

Response samples

Content type
application/json
{
  • "userType": "string",
  • "full_name": "string",
  • "lastName": "string",
  • "company_name": "string",
  • "countryCode": "string",
  • "company_phone_number": "string",
  • "company_email": "user@example.com",
  • "companySize": "string",
  • "industry": "string",
  • "description": "string",
  • "desc": "string"
}

api_v1.0_directory_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

display_picture__isnull
string

display_picture__isnull

logo__isnull
string

logo__isnull

favicon__isnull
string

favicon__isnull

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_directory_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "merchant_info": "string",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "display_picture": {
    },
  • "logo": {
    },
  • "favicon": {
    },
  • "sort_order": -2147483648
}

api_v1.0_directorynew_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

display_picture__isnull
string

display_picture__isnull

logo__isnull
string

logo__isnull

favicon__isnull
string

favicon__isnull

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_directorynew_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "display_picture": "string",
  • "logo": "string",
  • "sort_order": -2147483648
}

api_v1.0_drafts_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_drafts_create

Authorizations:
Basic
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_drafts_get_plans_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_drafts_get_plans_create

Authorizations:
Basic
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_drafts_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_drafts_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_drafts_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_drafts_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_drafts_send_otp

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_estimations_create

Authorizations:
Basic
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) = 3 characters
merchant_id
string or null <uuid> (Merchant id)
user_id
string or null <uuid> (User id)

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "str",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "str",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

api_v1.0_estimations_conversions

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_freshworks_create

Authorizations:
Basic

Responses

api_v1.0_freshworks_call

Authorizations:
Basic

Responses

api_v1.0_hyper-pay_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_hyper-pay_create

Authorizations:
Basic
Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_hyper-pay_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_hyper-pay_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_hyper-pay_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_hyper-pay_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_hyper-pay_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_hyper-pay_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_installment_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

per_page
integer

Number of results to return per page.

effective_at
string

effective_at

status
string
Enum: "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED"

status

page
integer

A page number within the paginated result set.

Responses

api_v1.0_installment_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments installment.

Responses

api_v1.0_installment_pay

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments installment.

Request Body schema: application/json
required
payment_method_id
string or null <uuid> (Payment method id)
is_default
boolean or null (Is default)
is_cashback
boolean or null (Is cashback)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true
}

api_v1.0_installments_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

status
string
Enum: "ACTIVE" "COMPLETE" "REFUNDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_installments_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_installments_pay_all

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments.

Request Body schema: application/json
required
payment_method_id
string or null <uuid> (Payment method id)
is_default
boolean or null (Is default)
is_cashback
boolean or null (Is cashback)
parent_installment_ids
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true,
  • "parent_installment_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true,
  • "parent_installment_ids": [
    ]
}

api_v1.0_internal_checkouts_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_checkouts_read

Authorizations:
Basic
path Parameters
checkout_id
required
string <uuid>

A UUID string identifying this Checkout.

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "ip_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "merchant_id": "string",
  • "order_id": "string",
  • "display_reference": "string",
  • "action": "string",
  • "status": "string",
  • "source": "string",
  • "order": {
    }
}

api_v1.0_internal_consumers_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_consumers_read

Authorizations:
Basic
path Parameters
consumer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "info": "string",
  • "complete_orders_count": 2147483647,
  • "currency": "str",
  • "manual_credit_limit": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "credit_limit": "string",
  • "payment_methods": "http://example.com",
  • "payments": "http://example.com"
}

api_v1.0_internal_customers_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_customers_read

Authorizations:
Basic
path Parameters
customer_id
required
string <uuid>

A UUID string identifying this Customer.

Responses

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string"
}

api_v1.0_internal_documents_download

Authorizations:
Basic
path Parameters
document_id
required
string

Responses

api_v1.0_internal_employees_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_employees_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string"
}

api_v1.0_internal_installments_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_installments_payment-methods_list

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_installments_payment-methods_read

Authorizations:
Basic
path Parameters
consumer_id
required
string
id
required
integer

A unique integer value identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_internal_installments_payments_list

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_installments_payments_last

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_installments_payments_next

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_installments_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_internal_merchants_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_merchants_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "info": "string",
  • "display_picture": {
    },
  • "logo": {
    },
  • "favicon": {
    },
  • "bank_accounts": [
    ],
  • "settlements": "http://example.com",
  • "merchant_employees": "http://example.com",
  • "automatic_settlement_email": true,
  • "settlement_emails": [
    ],
  • "apply_cashback_discount_to": "string",
  • "has_usermanagement": true,
  • "requires_shopper_id": true,
  • "requires_minimal_signup": true,
  • "merchant_number": 100000001,
  • "vat_percent": "string",
  • "spotii_vat_percent": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "can_refund_platform_fee": true,
  • "link_expiration_delay": 15,
  • "currency": "str",
  • "settlement_currency": "str",
  • "rm_name": "string",
  • "order_min_amount": "string",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "payment_callback_url": "http://example.com",
  • "is_payment_callback_enabled": true,
  • "refund_webhook": "string",
  • "allow_payment_links": true,
  • "is_vpuf": true,
  • "is_instore": true,
  • "is_instore_custom_reference_enabled": true,
  • "is_instore_comments_enabled": true,
  • "is_auto_payment_capture_enabled": true,
  • "is_static_qr_order_otp_verification_enabled": true,
  • "sort_order": -2147483648,
  • "requires_unique_checkout": true,
  • "requires_pre_checkout_fraud_check": true,
  • "display_rejections": true,
  • "can_restrict_checkout_type": true,
  • "employee_linked_qr": true,
  • "honeymoon_start": "2019-08-24T14:15:22Z",
  • "honeymoon_duration": 2147483647,
  • "allow_payment_retries": true,
  • "show_back_webview": true,
  • "mobile_gallery_events": true,
  • "can_download_invoice": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "plans": [
    ],
  • "standalone_refund_settlement": true,
  • "is_high_risk": true,
  • "referrer": "string",
  • "is_careem_pay_enabled": true,
  • "is_apple_pay_enabled": true,
  • "pass_isf_as_npt": true,
  • "is_promo_enabled": true,
  • "requires_cust_details_on_checkout": true,
  • "cashback_discount_chance": 100,
  • "is_merchant_barcode": true,
  • "allow_partial_capture": true,
  • "show_payment_link_qr": true,
  • "link_bank_account": true,
  • "requires_nfc": true,
  • "is_user_fee_for_merchant": true,
  • "external_id": -9223372036854776000,
  • "master_merchant": "1d1a07cc-c876-4c41-9007-9c16138b0b97",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_internal_merchants_internal_employees_list

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_merchants_internal_employees_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string"
}

api_v1.0_internal_merchants_settlements_list

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_merchants_settlements_report_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_internal_merchants_settlements_report_create

Authorizations:
Basic
path Parameters
merchant_id
required
string
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_internal_merchants_settlements_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "settlement_date": "2019-08-24",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "transactions": [
    ],
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_amount_refunded": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_internal_notification_capture_notification_event

Authorizations:
Basic

Responses

api_v1.0_internal_orders_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_orders_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "merchant": "string",
  • "merchant_id": "string",
  • "total_captured": "string",
  • "consumer": "string",
  • "installments": "http://example.com"
}

api_v1.0_internal_orders_installments_list

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_orders_installments_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_internal_push_notification_emit_push_notification

Authorizations:
Basic
Request Body schema: application/json
required
event_type
required
string (Event type)
Enum: "installment/purchase/success" "installment/purchase/failed" "installment/purchase/failed/auto-deduct" "installment/purchase/tomorrow" "installment/purchase/manual/reminder" "installment/purchase/account-locked" "installment/purchase/account-locked/auto-deduct" "INSTALLMENT_PURCHASE_ALL_PAID_SUCCESS" "INSTALLMENT_PURCHASE_FAILED_30_DAYS" "INSTALLMENT_PURCHASE_FAILED_23_DAYS"
payload
required
object (Payload)

Responses

Request samples

Content type
application/json
{
  • "event_type": "installment/purchase/success",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "event_type": "installment/purchase/success",
  • "payload": { }
}

api_v1.0_internal_tm-user-session_list

Authorizations:
Basic
query Parameters
user
string

user

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_internal_tm-user-session_read

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Responses

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_lean_create

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_lean_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_lean_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_lean_callback_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_lean_callback_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_lean_callback_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_lean_callback_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_lean_delete_entity

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_lean_intent

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_merchant_employees_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_merchant_employees_create

Authorizations:
Basic
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_merchant_employees_check_email

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_merchant_employees_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_merchant_employees_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_merchant_employees_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_merchant_info_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_merchant_info_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "is_instore": true,
  • "currency": "string",
  • "order_min_amount": "string",
  • "display_name": "string",
  • "display_url": "string",
  • "plans": [
    ],
  • "requires_shopper_id": true,
  • "employee_linked_qr": true,
  • "requires_nfc": true,
  • "plan_dictionary": "string",
  • "plan_rates": "string"
}

api_v1.0_merchant_profile_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_merchant_profile_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "display_rejections": true,
  • "can_restrict_checkout_type": true,
  • "allow_no_call_back_urls": true,
  • "can_download_invoice": true,
  • "is_instore": true,
  • "is_instore_custom_reference_enabled": true,
  • "is_instore_comments_enabled": true,
  • "is_static_qr_order_otp_verification_enabled": true,
  • "currency": "string",
  • "order_min_amount": "string",
  • "logged_employee": "string",
  • "plan_rates": "string",
  • "has_usermanagement": true,
  • "automatic_settlement_email": true,
  • "employee_linked_qr": true,
  • "settlement_emails": [
    ],
  • "requires_cust_details_on_checkout": true,
  • "is_merchant_barcode": true,
  • "allow_partial_capture": true,
  • "display_name": "string",
  • "plan_dictionary": "string",
  • "show_payment_link_qr": true,
  • "is_user_fee_for_merchant": true,
  • "external_id": 0,
  • "apply_cashback_discount_to": "string",
  • "link_bank_account": true,
  • "tenant_subdomain_name": "string"
}

api_v1.0_merchant_profile_set_settlement_emails

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
settlement_emails
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "settlement_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "settlement_emails": [
    ]
}

api_v1.0_merchant_rates_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_merchant_rates_create

Authorizations:
Basic
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_merchant_rates_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_merchant_rates_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_merchant_rates_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_merchant_roles_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_merchant_roles_create

Authorizations:
Basic
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_merchant_roles_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_merchant_roles_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_merchant_roles_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_mobile_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_mobile_create

Authorizations:
Basic
Request Body schema: application/json
required
expo_push_token
required
string (Expo push token) non-empty
os_version
string or null (Os version)
app_version
string or null (App version)
is_active
boolean (Is active)
last_active_date
string <date-time> (Last active date)

Responses

Request samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_version": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_mobile_init_device

Authorizations:
Basic
Request Body schema: application/json
required
expo_push_token
required
string (Expo push token) non-empty
os_type
required
string (Os type)
Enum: "ANDROID" "IOS"
os_version
string or null (Os version)
app_slug
required
string (App slug)
Value: "consumer-mobile"
app_version
string or null (App version)
is_active
boolean (Is active)
last_active_date
string <date-time> (Last active date)

Responses

Request samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "ANDROID",
  • "os_version": "string",
  • "app_slug": "consumer-mobile",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "ANDROID",
  • "os_version": "string",
  • "app_slug": "consumer-mobile",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_mobile_read

Authorizations:
Basic
path Parameters
device_id
required
string <uuid>

A UUID string identifying this Device.

Responses

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_mobile_update_device

Authorizations:
Basic
path Parameters
device_id
required
string <uuid>

A UUID string identifying this Device.

Request Body schema: application/json
required
os_version
required
string (Os version) non-empty
app_version
required
string (App version) non-empty

Responses

Request samples

Content type
application/json
{
  • "os_version": "string",
  • "app_version": "string"
}

Response samples

Content type
application/json
{
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string"
}

api_v1.0_orders_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_orders_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_orders_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_orders_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_orders_capture

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)

Responses

Request samples

Content type
application/json
{
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "amount": "string"
}

api_v1.0_orders_fulfill

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
phone_number
string or null (Phone number)
fulfilled
required
string (Fulfilled) non-empty

Responses

Request samples

Content type
application/json
{
  • "phone_number": "string",
  • "fulfilled": "string"
}

Response samples

Content type
application/json
{
  • "phone_number": "string",
  • "fulfilled": "string"
}

api_v1.0_orders_invoice_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_orders_invoice_create

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
object (InvoiceSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_orders_outstanding

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_orders_payment_method_update

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
payment_method_id
required
string <uuid> (Payment method id)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

api_v1.0_orders_payment_method_partial_update

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
payment_method_id
required
string <uuid> (Payment method id)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

api_v1.0_orders_queue_refund

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_orders_refund

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_orders_refund_invoice_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_orders_refund_invoice_create

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
object (InvoiceSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_orders_status

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_orders_status_checkout

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string"
}

api_v1.0_orders_void

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency) [ 1 .. 3 ] characters
tax_amount
string or null <decimal> (Tax amount)
shipping_amount
string or null <decimal> (Shipping amount)
discount
string or null <decimal> (Discount)
required
object (BillingAddress)
required
object (ShippingAddress)
required
Array of objects or null (LineSerilizer)
referrer
required
string (Referrer) non-empty

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "referrer": "string"
}

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string"
}

api_v1.0_payment-methods_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_payment-methods_create

Authorizations:
Basic
Request Body schema: application/json
required
billing_address_id
string <uuid> (Billing address id)
object (BillingAddressSerializerConsumer)
required
object (CardDetails)

Responses

Request samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "billing_address": {
    },
  • "card_details": {
    }
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "billing_address": {
    },
  • "card_details": {
    }
}

api_v1.0_payment-methods_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_payment-methods_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Request Body schema: application/json
required
is_default
required
boolean or null (Is default)
currency
string (Currency) non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "is_default": true,
  • "currency": ""
}

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_payment-methods_partial_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Request Body schema: application/json
required
is_default
required
boolean or null (Is default)
currency
string (Currency) non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "is_default": true,
  • "currency": ""
}

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_payment-methods_delete

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Responses

api_v1.0_paytabs_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_paytabs_create

Authorizations:
Basic
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_paytabs_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_callback_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_callback_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_callback_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_callback_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_paytabs_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_paytabs_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_paytabs2_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_paytabs2_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_paytabs2_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_paytabs2_callback_read

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_paytabs2_callback_update

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_paytabs2_callback_partial_update

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_paytabs2_callback_delete

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

api_v1.0_paytabs2_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_paytabs2_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_paytabs2_redirect_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_paytabs2_redirect_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_push-notifications_list

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_push-notifications_create

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
Request Body schema: application/json
required
callback_url
required
string <uri> (Callback url) [ 1 .. 2000 ] characters
pattern
required
string (Pattern) [ 1 .. 10000 ] characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_push-notifications_read

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_push-notifications_delete

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

api_v1.0_refund-requests_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_refund-requests_create

Authorizations:
Basic
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_refund-requests_read

Authorizations:
Basic
path Parameters
refund_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_refund-requests_update

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_refund-requests_partial_update

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_refund-requests_void

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
object (RefundRequestVoid)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_refunds_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_refunds_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_refunds_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_refunds_comments

Authorizations:
Basic
path Parameters
transaction_id
required
string <uuid>

A UUID string identifying this transaction.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
type
required
string (Type) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
currency
string or null (Currency) <= 3 characters
amount
string or null <decimal> (Amount)
platform_fee
string or null <decimal> (Platform fee)
settlement_amount
string or null <decimal> (Settlement amount)
vat_percent
string or null <decimal> (Vat percent)
percent_fee
string or null <decimal> (Percent fee)
fixed_fee
string or null <decimal> (Fixed fee)
transaction_number
string or null (Transaction number) <= 500 characters
refund_comments
string or null (Refund comments) <= 2048 characters
order
required
string <uuid> (Order)
tenant
string or null <uuid> (Tenant)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "type": "string",
  • "status": "string",
  • "currency": "str",
  • "amount": "string",
  • "platform_fee": "string",
  • "settlement_amount": "string",
  • "vat_percent": "string",
  • "percent_fee": "string",
  • "fixed_fee": "string",
  • "transaction_number": "string",
  • "refund_comments": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

Response samples

Content type
application/json
{
  • "transaction_id": "f2cf8b6f-f27c-4308-b2cb-5192749aac05",
  • "external_key": "string",
  • "type": "string",
  • "status": "string",
  • "currency": "str",
  • "amount": "string",
  • "platform_fee": "string",
  • "settlement_amount": "string",
  • "vat_percent": "string",
  • "percent_fee": "string",
  • "fixed_fee": "string",
  • "transaction_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "refund_comments": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_settlements-report_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_settlements-report_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_settlements-report_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_settlements-report_read

Authorizations:
Basic
path Parameters
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "total_amount_refunded": "string",
  • "settlement_date": "2019-08-24",
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "is_settled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "settlement_record": 0,
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_settlements_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_settlements_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_settlements_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_settlements_read

Authorizations:
Basic
path Parameters
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "total_amount_refunded": "string",
  • "settlement_date": "2019-08-24",
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "is_settled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "settlement_record": 0,
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_shopify_checkout_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_shopify_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
confirm_callback_url
required
string (Confirm callback url) [ 1 .. 2000 ] characters
reject_callback_url
required
string (Reject callback url) [ 1 .. 2000 ] characters
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "plan": "string"
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "merchant_order_min_amount": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "checkout_status": "string",
  • "plan": "string"
}

api_v1.0_shopify_checkout_read

Authorizations:
Basic
path Parameters
checkout_id
required
string <uuid>

A UUID string identifying this Checkout.

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "merchant_order_min_amount": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "checkout_status": "string",
  • "plan": "string"
}

api_v1.0_shopify_configuration_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_shopify_configuration_read

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Responses

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_shopify_configuration_update

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Request Body schema: application/json
required
api_key
string or null (Api key) [ 1 .. 255 ] characters
password
string or null (Password) [ 1 .. 255 ] characters
hostname
string or null (Hostname) [ 1 .. 255 ] characters
shared_secret
string or null (Shared secret) <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_shopify_configuration_partial_update

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Request Body schema: application/json
required
api_key
string or null (Api key) [ 1 .. 255 ] characters
password
string or null (Password) [ 1 .. 255 ] characters
hostname
string or null (Hostname) [ 1 .. 255 ] characters
shared_secret
string or null (Shared secret) <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_shopify_configuration_delete

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Responses

api_v1.0_shopify_hosted_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
x_reference
required
string (X reference) non-empty
x_amount
required
string <decimal> (X amount)
x_currency
required
string (X currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"

Responses

Request samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED"
}

Response samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED",
  • "checkout_url": "string"
}

api_v1.0_shopify_hosted_checkout_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED",
  • "checkout_url": "string"
}

api_v1.0_smi_attachments_create

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601",
  • "name": "string",
  • "content_type": "string",
  • "file": "string"
}

api_v1.0_smi_attachments_read

Authorizations:
Basic
path Parameters
attachment_id
required
string <uuid>

A UUID string identifying this attachment.

Responses

Response samples

Content type
application/json
{
  • "attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601",
  • "name": "string",
  • "content_type": "string",
  • "file": "string"
}

api_v1.0_smi_bank-accounts_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_bank-accounts_create

Authorizations:
Basic
Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_bank-accounts_read

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Responses

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_bank-accounts_update

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_bank-accounts_partial_update

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Request Body schema: application/json
required
bank
required
string (Bank) [ 1 .. 255 ] characters
account_number
required
string (Account number) [ 1 .. 30 ] characters
account_title
string (Account title) [ 1 .. 255 ] characters
iban
string or null (Iban) <= 34 characters
swift
required
string (Swift) [ 1 .. 11 ] characters
country
required
string (Country)
is_default
boolean or null (Is default)

Responses

Request samples

Content type
application/json
{
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "bank": "string",
  • "account_number": "string",
  • "account_title": "string",
  • "iban": "string",
  • "swift": "string",
  • "country": "string",
  • "is_default": true,
  • "approved_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_bank-accounts_delete

Authorizations:
Basic
path Parameters
bank_account_id
required
string <uuid>

A UUID string identifying this bank account.

Responses

api_v1.0_smi_billing-addresses_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_smi_billing-addresses_create

Authorizations:
Basic
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
email
required
string <email> (Email)
phone
required
string (Phone)
country
required
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
required
string (City) <= 255 characters
state
required
string (State) <= 255 characters
address1
required
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
required
string (Postal code) <= 255 characters
company
required
string (Company) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string"
}

api_v1.0_smi_billing-addresses_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Responses

api_v1.0_smi_billing-addresses_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
email
string <email> (Email)
phone
string (Phone)
country
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
string (City) <= 255 characters
state
string (State) <= 255 characters
address1
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
string (Postal code) <= 255 characters
company
string (Company) <= 255 characters
is_default
boolean (Is default)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

api_v1.0_smi_billing-addresses_partial_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Request Body schema: application/json
required
name
string (Name) <= 255 characters
email
string <email> (Email)
phone
string (Phone)
country
string (Country)
Enum: "ARE" "SAU" "OMN" "KWT" "BHR"
city
string (City) <= 255 characters
state
string (State) <= 255 characters
address1
string (Address1) [ 1 .. 255 ] characters
address2
string (Address2) <= 255 characters
address3
string (Address3) <= 255 characters
postal_code
string (Postal code) <= 255 characters
company
string (Company) <= 255 characters
is_default
boolean (Is default)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "ARE",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "is_default": false
}

api_v1.0_smi_billing-addresses_delete

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this billing address.

Responses

api_v1.0_smi_careem-pay_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_careem-pay_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_callback_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_careem-pay_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_careem-pay_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
required
object (AmountDetails)
object or null (CardDetailsSerializerCareem)
Array of objects or null or null (Errors)
required
object (Tags)
id
required
string (Id) [ 1 .. 255 ] characters
invoiceId
required
string (Invoiceid) [ 1 .. 255 ] characters
consentId
required
string (Consentid) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
type
required
string (Type) non-empty
merchant
required
string (Merchant) non-empty

Responses

Request samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "cardDetails": {
    },
  • "errors": [
    ],
  • "tags": {
    },
  • "id": "string",
  • "invoiceId": "string",
  • "consentId": "string",
  • "status": "string",
  • "type": "string",
  • "merchant": "string"
}

api_v1.0_smi_careem-pay_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_cashback_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_smi_cashback_create

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_smi_cashback_issue_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_smi_cashback_issue_create

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_smi_cashback_withdraw_req

Authorizations:
Basic
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
remarks
required
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "str",
  • "remarks": { }
}

api_v1.0_smi_cashback_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this cashbacks.

Responses

api_v1.0_smi_charges_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_charges_create

Authorizations:
Basic
Request Body schema: application/json
required
authority
object (Authority)
amount
string <decimal> (Amount)
currency
string (Currency) non-empty
capture
boolean (Capture)
Default: false

Responses

Request samples

Content type
application/json
{
  • "authority": { },
  • "amount": "string",
  • "currency": "string",
  • "capture": false
}

Response samples

Content type
application/json
{
  • "authority": { },
  • "amount": "string",
  • "currency": "string",
  • "currency_output": "string",
  • "amount_output": "string",
  • "capture": false,
  • "id": "string",
  • "order_output": "string",
  • "reference_output": "string",
  • "customer": "string",
  • "state": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "product": "Spotii",
  • "receipt_number": 0,
  • "metadata": "string"
}

api_v1.0_smi_charges_read

Authorizations:
Basic
path Parameters
order_id
required
string[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9...

Responses

Response samples

Content type
application/json
{
  • "authority": { },
  • "amount": "string",
  • "currency": "string",
  • "currency_output": "string",
  • "amount_output": "string",
  • "capture": false,
  • "id": "string",
  • "order_output": "string",
  • "reference_output": "string",
  • "customer": "string",
  • "state": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "product": "Spotii",
  • "receipt_number": 0,
  • "metadata": "string"
}

api_v1.0_smi_charges_cancel

Authorizations:
Basic
path Parameters
order_id
required
string[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9...
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "reference": "string",
  • "amount": "string",
  • "currency": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "customer": "string",
  • "product": "Spotii",
  • "receipt_number": 0
}

api_v1.0_smi_charges_capture

Authorizations:
Basic
path Parameters
order_id
required
string[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9...
Request Body schema: application/json
required
amount
string <decimal> (Amount)

Responses

Request samples

Content type
application/json
{
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "id": "string",
  • "reference": "string",
  • "currency": "string",
  • "amount_output": "string",
  • "order": "string",
  • "customer": "string",
  • "state": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "product": "Spotii",
  • "receipt_number": 0
}

api_v1.0_smi_checkout_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
is_gift_card_checkout
boolean or null (Is gift card checkout)
Default: false
gc_type
string or null (Gc type)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "checkout_url": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

api_v1.0_smi_checkout_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "checkout_url": "string",
  • "is_gift_card_checkout": false,
  • "gc_type": "string"
}

api_v1.0_smi_checkouts_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_create

Authorizations:
Basic
Request Body schema: application/json
required
order
required
object (Order)
shopper
required
object (Shopper)
config
required
object (Config)

Responses

Request samples

Content type
application/json
{
  • "order": { },
  • "shopper": { },
  • "config": { }
}

Response samples

Content type
application/json
{
  • "order": { },
  • "shopper": { },
  • "config": { },
  • "uri": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shopper_obj": "string",
  • "order_obj": "string",
  • "config_obj": "string",
  • "metadata": "string",
  • "state": "string"
}

api_v1.0_smi_checkouts_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_smi_checkouts_check_ref

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_gc_checkout_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_gc_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
total
string <decimal> (Total)
gc_type
string or null (Gc type)

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "gc_type": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "gc_type": "string",
  • "gift_card_lec": "string"
}

api_v1.0_smi_checkouts_generate_ref

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_timeline

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPEN" "DRAFT" "SUBMITTED" "FAILED" "CARD_ATTACHED" "PROCESSING_PAYMENT"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_checkouts_read

Authorizations:
Basic
path Parameters
checkout_id
required
string[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9...

Responses

Response samples

Content type
application/json
{
  • "order": { },
  • "shopper": { },
  • "config": { },
  • "uri": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "shopper_obj": "string",
  • "order_obj": "string",
  • "config_obj": "string",
  • "metadata": "string",
  • "state": "string"
}

api_v1.0_smi_checkouts_read

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_smi_checkouts_bind_new_user

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_smi_checkouts_cancel_create

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (CancelCheckout)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_checkouts_cancel_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (CancelCheckout)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Confirms the order.

Approves the order with fraud model API Attaches current order to an authorized user Create the installments in billing app Creates and authorizes the first installment's capture transaction if due today. Emits order confirm event Notifies merchant

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

Confirms the order.

Approves the order with fraud model API Attaches current order to an authorized user Create the installments in billing app Creates and authorizes the first installment's capture transaction if due today. Emits order confirm event Notifies merchant

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_smi_checkouts_confirm_cpay_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
cpay_request
object or null (Cpay request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

api_v1.0_smi_checkouts_confirm_cpay_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
cpay_request
object or null (Cpay request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "cpay_request": { }
}

api_v1.0_smi_checkouts_confirm_new_card

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
required
object (MarkPaidDetails)

Responses

Request samples

Content type
application/json
{
  • "mark_paid": {
    }
}

Response samples

Content type
application/json
{
  • "mark_paid": {
    }
}

api_v1.0_smi_checkouts_confirm_no_card_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_smi_checkouts_confirm_no_card_partial_update

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_smi_checkouts_confirm_qr_update

Similar to confirm but triggered from the merchant side (for qr scanner flow) See confirm description

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

api_v1.0_smi_checkouts_confirm_qr_partial_update

Similar to confirm but triggered from the merchant side (for qr scanner flow) See confirm description

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null (Payment method id) non-empty
otp
string or null (Otp) non-empty
pt2_request
object or null (Pt2 request)

Responses

Request samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { }
}

Response samples

Content type
application/json
{
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "string",
  • "otp": "string",
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string"
}

Confirms order by switching plan to No Pay Today.

Approves order for users with ISF on merchants with pass_isf_as_npt active

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
object (ISFToNPTConfirm)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_checkouts_defer_step

Authorizations:
Basic
path Parameters
token
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"
confirm_callback_url
string <uri> (Confirm callback url) <= 2048 characters
reject_callback_url
string <uri> (Reject callback url) <= 2048 characters
object or null (OrderSerilizer)
source
string or null (Source)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
rejections
Array of strings or null (Rejections) [ items <= 255 characters ]
meta
object or null (Meta)
user_id
string or null (User id)
object (MerchantDetailsSerilizer)
is_cashback_discount
boolean or null (Is cashback discount)

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "source": "string",
  • "plan": "string",
  • "rejections": [
    ],
  • "meta": { },
  • "user_id": "string",
  • "merchant_info": {
    },
  • "is_cashback_discount": true
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_smi_checkouts_get_plans_from_risk

Fetch plans from risk when merchant flag set

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { },
  • "estimations": "string",
  • "merchant_info": {
    },
  • "checkout_url": "string",
  • "merchant_requires_shopper_id": "string",
  • "is_existing_user": "string",
  • "merchant_high_risk": "string",
  • "merchant_promo_enabled": "string",
  • "is_cashback_discount": true,
  • "merchant_requires_minimal_signup": true,
  • "minimal_flow": "string",
  • "merchant_link_bank_account": true,
  • "campaign_id": "string",
  • "returning_customer_banner_info": "string",
  • "tenant_name": "string"
}

api_v1.0_smi_checkouts_status_checkout_card

Authorizations:
Basic
path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "status": "string",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "AED",
  • "confirm_callback_url": "http://example.com",
  • "reject_callback_url": "http://example.com",
  • "order": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "source": "string",
  • "plan": "string",
  • "plan_id": "string",
  • "rejections": [
    ],
  • "order_id": "string",
  • "is_smi": "string",
  • "pre_approved": true,
  • "meta": { },
  • "gift_card_checkout": "string",
  • "gc_reference": "string",
  • "gc_expires_in": "string",
  • "user_fee": "string",
  • "user_id": "string",
  • "step_data": { }
}

api_v1.0_smi_consumer-score_create

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_smi_consumer-score_get_merchant_spend_limit

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_smi_consumer-score_get_preapproval

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_smi_consumer-score_get_spend_limit

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_smi_consumer-score_update_consumer_score

Authorizations:
Basic
Request Body schema: application/json
required
consumer_id
required
string (Consumer id) non-empty
checkout_id
string (Checkout id)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "checkout_id": ""
}

api_v1.0_smi_demos_create

Authorizations:
Basic
Request Body schema: application/json
required
userType
string or null (UserType) <= 100 characters
full_name
required
string (Full name) [ 1 .. 500 ] characters
lastName
string or null (LastName) <= 100 characters
company_name
required
string (Company name) [ 1 .. 500 ] characters
countryCode
string or null (CountryCode) <= 100 characters
company_phone_number
string or null (Company phone number) <= 100 characters
company_email
string or null <email> (Company email) <= 254 characters
companySize
string or null (CompanySize) <= 100 characters
industry
string or null (Industry) <= 100 characters
description
string or null (Description) <= 100 characters
desc
string or null (Desc) <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "userType": "string",
  • "full_name": "string",
  • "lastName": "string",
  • "company_name": "string",
  • "countryCode": "string",
  • "company_phone_number": "string",
  • "company_email": "user@example.com",
  • "companySize": "string",
  • "industry": "string",
  • "description": "string",
  • "desc": "string"
}

Response samples

Content type
application/json
{
  • "userType": "string",
  • "full_name": "string",
  • "lastName": "string",
  • "company_name": "string",
  • "countryCode": "string",
  • "company_phone_number": "string",
  • "company_email": "user@example.com",
  • "companySize": "string",
  • "industry": "string",
  • "description": "string",
  • "desc": "string"
}

api_v1.0_smi_directory_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

display_picture__isnull
string

display_picture__isnull

logo__isnull
string

logo__isnull

favicon__isnull
string

favicon__isnull

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_directory_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "merchant_info": "string",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "display_picture": {
    },
  • "logo": {
    },
  • "favicon": {
    },
  • "sort_order": -2147483648
}

api_v1.0_smi_directorynew_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

display_picture__isnull
string

display_picture__isnull

logo__isnull
string

logo__isnull

favicon__isnull
string

favicon__isnull

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_directorynew_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "display_picture": "string",
  • "logo": "string",
  • "sort_order": -2147483648
}

api_v1.0_smi_drafts_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_drafts_create

Authorizations:
Basic
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_drafts_get_plans_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_drafts_get_plans_create

Authorizations:
Basic
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_drafts_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_drafts_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_drafts_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_drafts_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_smi_drafts_send_otp

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Consumer)
pt2_request
object (Pt2 request)
merchant
required
string <uuid> (Merchant)
employee
string or null <uuid> (Employee)
object (Employee)
consumer
required
string <uuid> (Consumer)
checkout
string or null <uuid> (Checkout)
payment_method_id
string or null <uuid> (Payment method id)
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$
description
string or null (Description) <= 10000 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 3 ] characters
order
string or null <uuid> (Order)
status
string or null (Status) <= 50 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "consumer_detail": {
    },
  • "pt2_request": { },
  • "pt2_redirect_url": "string",
  • "error_code": "string",
  • "error_reason": "string",
  • "draft_id": "d998e5e8-954a-4a68-bb9e-7305e87278c0",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "employee": "582b6557-33f4-480f-b578-984bbca0a925",
  • "employee_data": {
    },
  • "consumer": "0a45b933-fd30-4678-8772-d999c3875012",
  • "checkout": "e9cf21ee-1bbc-4fad-91d0-f5588231d006",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plan": "string",
  • "description": "string",
  • "amount": "string",
  • "currency": "str",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "display_reference": "string"
}

api_v1.0_smi_estimations_create

Authorizations:
Basic
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) = 3 characters
merchant_id
string or null <uuid> (Merchant id)
user_id
string or null <uuid> (User id)

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "str",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "str",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

api_v1.0_smi_estimations_conversions

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_freshworks_create

Authorizations:
Basic

Responses

api_v1.0_smi_freshworks_call

Authorizations:
Basic

Responses

api_v1.0_smi_hyper-pay_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_hyper-pay_create

Authorizations:
Basic
Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_smi_hyper-pay_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_hyper-pay_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_smi_hyper-pay_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_smi_hyper-pay_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_smi_hyper-pay_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string (Mada agreement id) [ 1 .. 255 ] characters
amount
string (Amount) [ 1 .. 10 ] characters
currency
string (Currency) [ 1 .. 10 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string (Order id) [ 1 .. 255 ] characters
object or null (CardDetailsSerializerHyper)
registration_id
string (Registration id) [ 1 .. 255 ] characters
payment_type
string (Payment type)
Default: ""
payment_brand
string (Payment brand)
Default: ""
object (Result)
card_details_id
string or null (Card details id) <= 255 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "card_details_id": ""
}

Response samples

Content type
application/json
{
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "card": {
    },
  • "registration_id": "string",
  • "payment_type": "",
  • "payment_brand": "",
  • "result": {
    },
  • "resultDetails": "string",
  • "card_details_id": ""
}

api_v1.0_smi_hyper-pay_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_installment_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

per_page
integer

Number of results to return per page.

effective_at
string

effective_at

status
string
Enum: "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED"

status

page
integer

A page number within the paginated result set.

Responses

api_v1.0_smi_installment_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments installment.

Responses

api_v1.0_smi_installment_pay

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments installment.

Request Body schema: application/json
required
payment_method_id
string or null <uuid> (Payment method id)
is_default
boolean or null (Is default)
is_cashback
boolean or null (Is cashback)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true
}

api_v1.0_smi_installments_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

status
string
Enum: "ACTIVE" "COMPLETE" "REFUNDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_installments_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_smi_installments_pay_all

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this installments.

Request Body schema: application/json
required
payment_method_id
string or null <uuid> (Payment method id)
is_default
boolean or null (Is default)
is_cashback
boolean or null (Is cashback)
parent_installment_ids
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true,
  • "parent_installment_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "is_default": true,
  • "is_cashback": true,
  • "parent_installment_ids": [
    ]
}

api_v1.0_smi_internal_checkouts_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_checkouts_read

Authorizations:
Basic
path Parameters
checkout_id
required
string <uuid>

A UUID string identifying this Checkout.

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "ip_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "merchant_id": "string",
  • "order_id": "string",
  • "display_reference": "string",
  • "action": "string",
  • "status": "string",
  • "source": "string",
  • "order": {
    }
}

api_v1.0_smi_internal_consumers_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_consumers_read

Authorizations:
Basic
path Parameters
consumer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "consumer_id": "string",
  • "info": "string",
  • "complete_orders_count": 2147483647,
  • "currency": "str",
  • "manual_credit_limit": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "credit_limit": "string",
  • "payment_methods": "http://example.com",
  • "payments": "http://example.com"
}

api_v1.0_smi_internal_customers_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_customers_read

Authorizations:
Basic
path Parameters
customer_id
required
string <uuid>

A UUID string identifying this Customer.

Responses

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string"
}

api_v1.0_smi_internal_documents_download

Authorizations:
Basic
path Parameters
document_id
required
string

Responses

api_v1.0_smi_internal_employees_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_employees_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string"
}

api_v1.0_smi_internal_installments_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_installments_payment-methods_list

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_installments_payment-methods_read

Authorizations:
Basic
path Parameters
consumer_id
required
string
id
required
integer

A unique integer value identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_smi_internal_installments_payments_list

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_installments_payments_last

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_installments_payments_next

Authorizations:
Basic
path Parameters
consumer_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_installments_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_smi_internal_merchants_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_merchants_read

Authorizations:
Basic
path Parameters
merchant_id
required
string <uuid>

A UUID string identifying this merchant.

Responses

Response samples

Content type
application/json
{
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "info": "string",
  • "display_picture": {
    },
  • "logo": {
    },
  • "favicon": {
    },
  • "bank_accounts": [
    ],
  • "settlements": "http://example.com",
  • "merchant_employees": "http://example.com",
  • "automatic_settlement_email": true,
  • "settlement_emails": [
    ],
  • "apply_cashback_discount_to": "string",
  • "has_usermanagement": true,
  • "requires_shopper_id": true,
  • "requires_minimal_signup": true,
  • "merchant_number": 100000001,
  • "vat_percent": "string",
  • "spotii_vat_percent": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "can_refund_platform_fee": true,
  • "link_expiration_delay": 15,
  • "currency": "str",
  • "settlement_currency": "str",
  • "rm_name": "string",
  • "order_min_amount": "string",
  • "display_name": "string",
  • "display_category": "string",
  • "display_url": "http://example.com",
  • "payment_callback_url": "http://example.com",
  • "is_payment_callback_enabled": true,
  • "refund_webhook": "string",
  • "allow_payment_links": true,
  • "is_vpuf": true,
  • "is_instore": true,
  • "is_instore_custom_reference_enabled": true,
  • "is_instore_comments_enabled": true,
  • "is_auto_payment_capture_enabled": true,
  • "is_static_qr_order_otp_verification_enabled": true,
  • "sort_order": -2147483648,
  • "requires_unique_checkout": true,
  • "requires_pre_checkout_fraud_check": true,
  • "display_rejections": true,
  • "can_restrict_checkout_type": true,
  • "employee_linked_qr": true,
  • "honeymoon_start": "2019-08-24T14:15:22Z",
  • "honeymoon_duration": 2147483647,
  • "allow_payment_retries": true,
  • "show_back_webview": true,
  • "mobile_gallery_events": true,
  • "can_download_invoice": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "plans": [
    ],
  • "standalone_refund_settlement": true,
  • "is_high_risk": true,
  • "referrer": "string",
  • "is_careem_pay_enabled": true,
  • "is_apple_pay_enabled": true,
  • "pass_isf_as_npt": true,
  • "is_promo_enabled": true,
  • "requires_cust_details_on_checkout": true,
  • "cashback_discount_chance": 100,
  • "is_merchant_barcode": true,
  • "allow_partial_capture": true,
  • "show_payment_link_qr": true,
  • "link_bank_account": true,
  • "requires_nfc": true,
  • "is_user_fee_for_merchant": true,
  • "external_id": -9223372036854776000,
  • "master_merchant": "1d1a07cc-c876-4c41-9007-9c16138b0b97",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_smi_internal_merchants_internal_employees_list

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_merchants_internal_employees_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string"
}

api_v1.0_smi_internal_merchants_settlements_list

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_merchants_settlements_report_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_internal_merchants_settlements_report_create

Authorizations:
Basic
path Parameters
merchant_id
required
string
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_internal_merchants_settlements_read

Authorizations:
Basic
path Parameters
merchant_id
required
string
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "settlement_date": "2019-08-24",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40",
  • "transactions": [
    ],
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_amount_refunded": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_internal_notification_capture_notification_event

Authorizations:
Basic

Responses

api_v1.0_smi_internal_orders_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_orders_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "merchant": "string",
  • "merchant_id": "string",
  • "total_captured": "string",
  • "consumer": "string",
  • "installments": "http://example.com"
}

api_v1.0_smi_internal_orders_installments_list

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_orders_installments_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "installments_number": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "status": "ACTIVE",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": "string",
  • "merchant": "string",
  • "installments": [
    ]
}

api_v1.0_smi_internal_push_notification_emit_push_notification

Authorizations:
Basic
Request Body schema: application/json
required
event_type
required
string (Event type)
Enum: "installment/purchase/success" "installment/purchase/failed" "installment/purchase/failed/auto-deduct" "installment/purchase/tomorrow" "installment/purchase/manual/reminder" "installment/purchase/account-locked" "installment/purchase/account-locked/auto-deduct" "INSTALLMENT_PURCHASE_ALL_PAID_SUCCESS" "INSTALLMENT_PURCHASE_FAILED_30_DAYS" "INSTALLMENT_PURCHASE_FAILED_23_DAYS"
payload
required
object (Payload)

Responses

Request samples

Content type
application/json
{
  • "event_type": "installment/purchase/success",
  • "payload": { }
}

Response samples

Content type
application/json
{
  • "event_type": "installment/purchase/success",
  • "payload": { }
}

api_v1.0_smi_internal_tm-user-session_list

Authorizations:
Basic
query Parameters
user
string

user

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_internal_tm-user-session_read

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Responses

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_lean_create

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_lean_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_callback_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_callback_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_callback_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_callback_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_smi_lean_delete_entity

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_lean_intent

Authorizations:
Basic
Request Body schema: application/json
required
object (LeanCallback)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_merchant_employees_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_merchant_employees_create

Authorizations:
Basic
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_smi_merchant_employees_check_email

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_merchant_employees_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_smi_merchant_employees_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_smi_merchant_employees_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
employee_id
required
string <uuid> (Employee id)
required
object (MerchantEmployeeRole)
api_employee_id
string or null <uuid> (Api employee id)

Responses

Request samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

Response samples

Content type
application/json
{
  • "employee_id": "df4fd699-0854-488d-9cc2-15e751a80ee3",
  • "info": "string",
  • "is_active": "string",
  • "role": {
    },
  • "api_employee_id": "89d31757-5a42-4ebb-9b15-ca74f7abae54"
}

api_v1.0_smi_merchant_info_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_merchant_info_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "is_instore": true,
  • "currency": "string",
  • "order_min_amount": "string",
  • "display_name": "string",
  • "display_url": "string",
  • "plans": [
    ],
  • "requires_shopper_id": true,
  • "employee_linked_qr": true,
  • "requires_nfc": true,
  • "plan_dictionary": "string",
  • "plan_rates": "string"
}

api_v1.0_smi_merchant_profile_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_merchant_profile_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "display_rejections": true,
  • "can_restrict_checkout_type": true,
  • "allow_no_call_back_urls": true,
  • "can_download_invoice": true,
  • "is_instore": true,
  • "is_instore_custom_reference_enabled": true,
  • "is_instore_comments_enabled": true,
  • "is_static_qr_order_otp_verification_enabled": true,
  • "currency": "string",
  • "order_min_amount": "string",
  • "logged_employee": "string",
  • "plan_rates": "string",
  • "has_usermanagement": true,
  • "automatic_settlement_email": true,
  • "employee_linked_qr": true,
  • "settlement_emails": [
    ],
  • "requires_cust_details_on_checkout": true,
  • "is_merchant_barcode": true,
  • "allow_partial_capture": true,
  • "display_name": "string",
  • "plan_dictionary": "string",
  • "show_payment_link_qr": true,
  • "is_user_fee_for_merchant": true,
  • "external_id": 0,
  • "apply_cashback_discount_to": "string",
  • "link_bank_account": true,
  • "tenant_subdomain_name": "string"
}

api_v1.0_smi_merchant_profile_set_settlement_emails

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
settlement_emails
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "settlement_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "settlement_emails": [
    ]
}

api_v1.0_smi_merchant_rates_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_merchant_rates_create

Authorizations:
Basic
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_smi_merchant_rates_read

Authorizations:
Basic
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_smi_merchant_rates_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_smi_merchant_rates_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string
Request Body schema: application/json
required
plan_rate_id
required
string <uuid> (Plan rate id)
order_max_amount
string or null <decimal> (Order max amount)
is_honeymoon
boolean (Is honeymoon)
deleted_at
string or null <date-time> (Deleted at)
merchant
required
string <uuid> (Merchant)

Responses

Request samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "order_max_amount": "string",
  • "is_honeymoon": true,
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

Response samples

Content type
application/json
{
  • "plan_rate_id": "f36ea703-63b7-4ebd-a640-d9fda0e488e4",
  • "plans": [
    ],
  • "order_min_amount": "string",
  • "slug": "string",
  • "order_max_amount": "string",
  • "fixed_fee": "string",
  • "percent_fee": "string",
  • "is_honeymoon": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "merchant": "0b7ca318-ab7a-439c-a9a6-84a9b5b35a40"
}

api_v1.0_smi_merchant_roles_list

Authorizations:
Basic
query Parameters
q
string

A search term.

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_merchant_roles_create

Authorizations:
Basic
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_smi_merchant_roles_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_smi_merchant_roles_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_smi_merchant_roles_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
role_id
required
string <uuid> (Role id)
display_name
required
string (Display name) non-empty

Responses

Request samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "display_name": "string",
  • "permissions": "string"
}

api_v1.0_smi_mobile_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_mobile_create

Authorizations:
Basic
Request Body schema: application/json
required
expo_push_token
required
string (Expo push token) non-empty
os_version
string or null (Os version)
app_version
string or null (App version)
is_active
boolean (Is active)
last_active_date
string <date-time> (Last active date)

Responses

Request samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_version": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_mobile_init_device

Authorizations:
Basic
Request Body schema: application/json
required
expo_push_token
required
string (Expo push token) non-empty
os_type
required
string (Os type)
Enum: "ANDROID" "IOS"
os_version
string or null (Os version)
app_slug
required
string (App slug)
Value: "consumer-mobile"
app_version
string or null (App version)
is_active
boolean (Is active)
last_active_date
string <date-time> (Last active date)

Responses

Request samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "ANDROID",
  • "os_version": "string",
  • "app_slug": "consumer-mobile",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "ANDROID",
  • "os_version": "string",
  • "app_slug": "consumer-mobile",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_mobile_read

Authorizations:
Basic
path Parameters
device_id
required
string <uuid>

A UUID string identifying this Device.

Responses

Response samples

Content type
application/json
{
  • "expo_push_token": "string",
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string",
  • "is_active": true,
  • "last_active_date": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_mobile_update_device

Authorizations:
Basic
path Parameters
device_id
required
string <uuid>

A UUID string identifying this Device.

Request Body schema: application/json
required
os_version
required
string (Os version) non-empty
app_version
required
string (App version) non-empty

Responses

Request samples

Content type
application/json
{
  • "os_version": "string",
  • "app_version": "string"
}

Response samples

Content type
application/json
{
  • "os_type": "string",
  • "os_version": "string",
  • "app_slug": "string",
  • "app_version": "string"
}

api_v1.0_smi_orders_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_orders_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_orders_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_orders_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_smi_orders_capture

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)

Responses

Request samples

Content type
application/json
{
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "amount": "string"
}

api_v1.0_smi_orders_fulfill

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
phone_number
string or null (Phone number)
fulfilled
required
string (Fulfilled) non-empty

Responses

Request samples

Content type
application/json
{
  • "phone_number": "string",
  • "fulfilled": "string"
}

Response samples

Content type
application/json
{
  • "phone_number": "string",
  • "fulfilled": "string"
}

api_v1.0_smi_orders_invoice_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_smi_orders_invoice_create

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
object (InvoiceSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_orders_outstanding

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_smi_orders_payment_method_update

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
payment_method_id
required
string <uuid> (Payment method id)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

api_v1.0_smi_orders_payment_method_partial_update

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
payment_method_id
required
string <uuid> (Payment method id)

Responses

Request samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a"
}

api_v1.0_smi_orders_queue_refund

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_orders_refund

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_orders_refund_invoice_read

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{ }

api_v1.0_smi_orders_refund_invoice_create

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
object (InvoiceSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_orders_status

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string",
  • "total_refund": "string",
  • "capture_expiration": "string",
  • "employee_name": "string",
  • "employee": "string",
  • "plan_id": "string",
  • "consumer_info": "string",
  • "user_fee": "string",
  • "merchant_name": "string",
  • "installments": "string"
}

api_v1.0_smi_orders_status_checkout

Authorizations:
Basic
path Parameters
reference
required
string

Responses

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string",
  • "status": "string"
}

api_v1.0_smi_orders_void

Authorizations:
Basic
path Parameters
reference
required
string
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
display_reference
string or null (Display reference) <= 255 characters
description
string or null (Description) <= 10000 characters
total
required
string <decimal> (Total)
currency
required
string (Currency) [ 1 .. 3 ] characters
tax_amount
string or null <decimal> (Tax amount)
shipping_amount
string or null <decimal> (Shipping amount)
discount
string or null <decimal> (Discount)
required
object (BillingAddress)
required
object (ShippingAddress)
required
Array of objects or null (LineSerilizer)
referrer
required
string (Referrer) non-empty

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "referrer": "string"
}

Response samples

Content type
application/json
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "reference": "string",
  • "display_reference": "string",
  • "description": "string",
  • "total": "string",
  • "currency": "str",
  • "tax_amount": "string",
  • "shipping_amount": "string",
  • "discount": "string",
  • "customer": "string",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "lines": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "order_number": "string",
  • "referrer": "string"
}

api_v1.0_smi_payment-methods_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_payment-methods_create

Authorizations:
Basic
Request Body schema: application/json
required
billing_address_id
string <uuid> (Billing address id)
object (BillingAddressSerializerConsumer)
required
object (CardDetails)

Responses

Request samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "billing_address": {
    },
  • "card_details": {
    }
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "billing_address": {
    },
  • "card_details": {
    }
}

api_v1.0_smi_payment-methods_read

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_smi_payment-methods_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Request Body schema: application/json
required
is_default
required
boolean or null (Is default)
currency
string (Currency) non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "is_default": true,
  • "currency": ""
}

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_smi_payment-methods_partial_update

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Request Body schema: application/json
required
is_default
required
boolean or null (Is default)
currency
string (Currency) non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "is_default": true,
  • "currency": ""
}

Response samples

Content type
application/json
{
  • "payment_method_id": "string",
  • "card": "string",
  • "is_default": true,
  • "currency": "",
  • "pm_type": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": true,
  • "cpay_instrument": { },
  • "auto_debit": true
}

api_v1.0_smi_payment-methods_delete

Authorizations:
Basic
path Parameters
id
required
integer

A unique integer value identifying this payment method.

Responses

api_v1.0_smi_paytabs_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_paytabs_create

Authorizations:
Basic
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_paytabs_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_callback_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_callback_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_callback_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_callback_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_smi_paytabs_read

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_partial_update

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
transaction_id
string (Transaction id) <= 255 characters
Default: ""
order_id
string (Order id) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
customer_name
string (Customer name) <= 255 characters
Default: ""
customer_email
string (Customer email) <= 255 characters
Default: ""
transaction_amount
string (Transaction amount) <= 255 characters
Default: ""
transaction_currency
string (Transaction currency) <= 255 characters
Default: ""
customer_phone
string (Customer phone) <= 255 characters
Default: ""
last_4_digits
string (Last 4 digits) <= 255 characters
Default: ""
first_4_digits
string (First 4 digits) <= 255 characters
Default: ""
card_brand
string (Card brand) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
pt_customer_email
string (Pt customer email) <= 255 characters
Default: ""
pt_customer_password
string (Pt customer password) <= 255 characters
Default: ""
pt_token
string (Pt token) <= 255 characters
Default: ""
secure_sign
string (Secure sign) <= 255 characters
Default: ""
response_message
string (Response message)
Default: ""
trans_date
string (Trans date)
Default: ""
datetime
string (Datetime)
Default: ""
payment_type
string (Payment type)
Default: ""
transaction_response_code
string (Transaction response code)
Default: ""
authcode
string (Authcode)
Default: ""
rrn
string (Rrn)
Default: ""
tokenization
string (Tokenization)
Default: ""
detail
string (Detail)
Default: ""
profile_id
string (Profile id)
Default: ""
expiry_month
string (Expiry month)
Default: ""
expiry_year
string (Expiry year)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

Response samples

Content type
application/json
{
  • "transaction_id": "",
  • "order_id": "",
  • "response_code": "",
  • "customer_name": "",
  • "customer_email": "",
  • "transaction_amount": "",
  • "transaction_currency": "",
  • "customer_phone": "",
  • "last_4_digits": "",
  • "first_4_digits": "",
  • "card_brand": "",
  • "card_type": "",
  • "pt_customer_email": "",
  • "pt_customer_password": "",
  • "pt_token": "",
  • "secure_sign": "",
  • "response_message": "",
  • "trans_date": "",
  • "datetime": "",
  • "payment_type": "",
  • "transaction_response_code": "",
  • "authcode": "",
  • "rrn": "",
  • "tokenization": "",
  • "detail": "",
  • "profile_id": "",
  • "expiry_month": "",
  • "expiry_year": ""
}

api_v1.0_smi_paytabs_delete

Authorizations:
Basic
path Parameters
id
required
string

Responses

api_v1.0_smi_paytabs2_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_smi_paytabs2_callback_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_paytabs2_callback_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_smi_paytabs2_callback_read

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_smi_paytabs2_callback_update

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_smi_paytabs2_callback_partial_update

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Request Body schema: application/json
required
tran_ref
string (Tran ref) <= 255 characters
Default: ""
tran_currency
string (Tran currency) <= 255 characters
Default: ""
tran_total
string (Tran total) <= 255 characters
Default: ""
cart_id
string (Cart id) <= 255 characters
Default: ""
cart_description
string (Cart description) <= 255 characters
Default: ""
name
string (Name) <= 255 characters
Default: ""
email
string (Email) <= 255 characters
Default: ""
phone
string (Phone) <= 255 characters
Default: ""
card_scheme
string (Card scheme) <= 255 characters
Default: ""
card_type
string (Card type) <= 255 characters
Default: ""
response_message
string (Response message) <= 255 characters
Default: ""
response_code
string (Response code) <= 255 characters
Default: ""
token
string (Token) <= 255 characters
Default: ""
transaction_time
string (Transaction time)
Default: ""
profile_id
string (Profile id)
Default: ""
expiryMonth
string (Expirymonth)
Default: ""
expiryYear
string (Expiryyear)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

Response samples

Content type
application/json
{
  • "tran_ref": "",
  • "tran_currency": "",
  • "tran_total": "",
  • "cart_id": "",
  • "cart_description": "",
  • "name": "",
  • "email": "",
  • "phone": "",
  • "card_scheme": "",
  • "card_type": "",
  • "response_message": "",
  • "response_code": "",
  • "token": "",
  • "transaction_time": "",
  • "profile_id": "",
  • "expiryMonth": "",
  • "expiryYear": ""
}

api_v1.0_smi_paytabs2_callback_delete

Authorizations:
Basic
path Parameters
profile_id
required
string <uuid>

A UUID string identifying this profile.

Responses

api_v1.0_smi_paytabs2_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_paytabs2_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_smi_paytabs2_redirect_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_paytabs2_redirect_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
tran_type
string (Tran type) non-empty
Default: "auth"
tran_class
string (Tran class) non-empty
Default: "ecom"
cart_description
required
string (Cart description) non-empty
cart_currency
required
string (Cart currency) [ 1 .. 3 ] characters
cart_amount
required
string (Cart amount) non-empty
cart_id
required
string (Cart id) [ 1 .. 255 ] characters
customer_details
required
object (Customer details)

Responses

Request samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

Response samples

Content type
application/json
{
  • "tran_type": "auth",
  • "tran_class": "ecom",
  • "cart_description": "string",
  • "cart_currency": "str",
  • "cart_amount": "string",
  • "cart_id": "string",
  • "customer_details": { }
}

api_v1.0_smi_push-notifications_list

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_push-notifications_create

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
Request Body schema: application/json
required
callback_url
required
string <uri> (Callback url) [ 1 .. 2000 ] characters
pattern
required
string (Pattern) [ 1 .. 10000 ] characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_push-notifications_read

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

Response samples

Content type
application/json
{
  • "push_notification_id": "cacdffe7-24e1-44b8-b52e-25a696016787",
  • "callback_url": "http://example.com",
  • "pattern": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_push-notifications_delete

Push notifications is a convenient way to get notified about events from the system. One can register a callback, i.e a valid URL that will be called whenever there is an event dispatched for this subscriber. Note that this can result in a large numbers of calls

Authorizations:
Basic
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

api_v1.0_smi_refund-requests_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_refund-requests_create

Authorizations:
Basic
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_refund-requests_read

Authorizations:
Basic
path Parameters
refund_request_id
required
string

Responses

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_refund-requests_update

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_refund-requests_partial_update

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
total
required
string <decimal> (Total)
currency
required
string (Currency) non-empty
comments
string or null (Comments) [ 1 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "total": "string",
  • "currency": "string",
  • "comments": "string"
}

api_v1.0_smi_refund-requests_void

Authorizations:
Basic
path Parameters
refund_request_id
required
string
Request Body schema: application/json
required
object (RefundRequestVoid)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_refunds_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

q
string

A search term.

created_at
string

created_at

status
string
Enum: "OPENED" "DRAFT" "COMPLETED" "REFUNDED" "PARTIALLY_REFUNDED" "VOIDED"

Status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_refunds_create

Authorizations:
Basic
Request Body schema: application/json
required
reason
required
string (Reason) non-empty
charge_id
required
string (Charge id) non-empty
amount
required
string <decimal> (Amount)

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "charge_id": "string",
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reason": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "reason_obj": "string",
  • "charge_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "amount_output": "string"
}

api_v1.0_smi_refunds_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_refunds_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

created_at
string

created_at

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_refunds_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_refunds_comments

Authorizations:
Basic
path Parameters
transaction_id
required
string <uuid>

A UUID string identifying this transaction.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
type
required
string (Type) [ 1 .. 255 ] characters
status
required
string (Status) [ 1 .. 255 ] characters
currency
string or null (Currency) <= 3 characters
amount
string or null <decimal> (Amount)
platform_fee
string or null <decimal> (Platform fee)
settlement_amount
string or null <decimal> (Settlement amount)
vat_percent
string or null <decimal> (Vat percent)
percent_fee
string or null <decimal> (Percent fee)
fixed_fee
string or null <decimal> (Fixed fee)
transaction_number
string or null (Transaction number) <= 500 characters
refund_comments
string or null (Refund comments) <= 2048 characters
order
required
string <uuid> (Order)
tenant
string or null <uuid> (Tenant)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "type": "string",
  • "status": "string",
  • "currency": "str",
  • "amount": "string",
  • "platform_fee": "string",
  • "settlement_amount": "string",
  • "vat_percent": "string",
  • "percent_fee": "string",
  • "fixed_fee": "string",
  • "transaction_number": "string",
  • "refund_comments": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

Response samples

Content type
application/json
{
  • "transaction_id": "f2cf8b6f-f27c-4308-b2cb-5192749aac05",
  • "external_key": "string",
  • "type": "string",
  • "status": "string",
  • "currency": "str",
  • "amount": "string",
  • "platform_fee": "string",
  • "settlement_amount": "string",
  • "vat_percent": "string",
  • "percent_fee": "string",
  • "fixed_fee": "string",
  • "transaction_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "refund_comments": "string",
  • "order": "93b532b3-a125-4cd2-9b71-9996b1e164ce",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_smi_refunds_read

Authorizations:
Basic
path Parameters
transactions__transaction_id
required
string[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9...

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "charge_id": "string",
  • "amount": "string",
  • "currency": "string"
}

api_v1.0_smi_settlements-report_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_settlements-report_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_settlements-report_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_settlements-report_read

Authorizations:
Basic
path Parameters
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "total_amount_refunded": "string",
  • "settlement_date": "2019-08-24",
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "is_settled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "settlement_record": 0,
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_smi_settlements_list

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_settlements_report_read

Authorizations:
Basic
query Parameters
ordering
string

Which field to use when ordering the results.

settlement_date
string

settlement_date

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_settlements_report_create

Authorizations:
Basic
Request Body schema: application/json
required
object (ReportSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

api_v1.0_smi_settlements_read

Authorizations:
Basic
path Parameters
settlement_id
required
string

A unique value identifying this settlement.

Responses

Response samples

Content type
application/json
{
  • "settlement_id": "string",
  • "total_amount_refunded": "string",
  • "settlement_date": "2019-08-24",
  • "currency": "str",
  • "count_of_orders": -2147483648,
  • "count_of_refunds": -2147483648,
  • "total_purchase_price": "string",
  • "total_platform_fee": "string",
  • "total_settlement_amount": "string",
  • "net_settlement_amount": "string",
  • "is_settled": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "settlement_record": 0,
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

api_v1.0_smi_shopify_checkout_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_shopify_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
reference
required
string (Reference) [ 1 .. 255 ] characters
confirm_callback_url
required
string (Confirm callback url) [ 1 .. 2000 ] characters
reject_callback_url
required
string (Reject callback url) [ 1 .. 2000 ] characters
plan
string or null <slug> (Plan) <= 50 characters ^[-a-zA-Z0-9_]+$

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "plan": "string"
}

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "merchant_order_min_amount": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "checkout_status": "string",
  • "plan": "string"
}

api_v1.0_smi_shopify_checkout_read

Authorizations:
Basic
path Parameters
checkout_id
required
string <uuid>

A UUID string identifying this Checkout.

Responses

Response samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "reference": "string",
  • "checkout_url": "string",
  • "merchant_order_min_amount": "string",
  • "confirm_callback_url": "string",
  • "reject_callback_url": "string",
  • "checkout_status": "string",
  • "plan": "string"
}

api_v1.0_smi_shopify_configuration_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_shopify_configuration_read

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Responses

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_smi_shopify_configuration_update

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Request Body schema: application/json
required
api_key
string or null (Api key) [ 1 .. 255 ] characters
password
string or null (Password) [ 1 .. 255 ] characters
hostname
string or null (Hostname) [ 1 .. 255 ] characters
shared_secret
string or null (Shared secret) <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_smi_shopify_configuration_partial_update

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Request Body schema: application/json
required
api_key
string or null (Api key) [ 1 .. 255 ] characters
password
string or null (Password) [ 1 .. 255 ] characters
hostname
string or null (Hostname) [ 1 .. 255 ] characters
shared_secret
string or null (Shared secret) <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

Response samples

Content type
application/json
{
  • "configuration_id": "af0daaf4-983e-4703-a7ed-a10f146d6684",
  • "api_key": "string",
  • "password": "string",
  • "hostname": "string",
  • "shared_secret": "string"
}

api_v1.0_smi_shopify_configuration_delete

Authorizations:
Basic
path Parameters
configuration_id
required
string <uuid>

A UUID string identifying this configuration.

Responses

api_v1.0_smi_shopify_hosted_checkout_create

Authorizations:
Basic
Request Body schema: application/json
required
x_reference
required
string (X reference) non-empty
x_amount
required
string <decimal> (X amount)
x_currency
required
string (X currency)
Enum: "AED" "USD" "SAR" "BHD" "KWD" "OMR" "QAR"

Responses

Request samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED"
}

Response samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED",
  • "checkout_url": "string"
}

api_v1.0_smi_shopify_hosted_checkout_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "x_reference": "string",
  • "x_amount": "string",
  • "x_currency": "AED",
  • "checkout_url": "string"
}

api_v1.0_smi_statistics_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_smi_tap_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_tap_create

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_callback

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_tap_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_smi_tap_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_tm-session_init

Authorizations:
Basic
Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_tm-session_read

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Responses

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_tm-session_patch_checkout_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
checkout_id
required
string <uuid> (Checkout id)
deleted_at
string or null <date-time> (Deleted at)
user
string or null <uuid> (User)

Responses

Request samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

api_v1.0_smi_tm-session_patch_checkout_partial_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
checkout_id
required
string <uuid> (Checkout id)
deleted_at
string or null <date-time> (Deleted at)
user
string or null <uuid> (User)

Responses

Request samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

api_v1.0_smi_tm-session_patch_user_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_tm-session_patch_user_partial_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_smi_upload-identities-lock-listen_create

Authorizations:
Basic
Request Body schema: application/json
required
event_id
required
string <uuid> (Event id)
event_type
required
string (Event type) non-empty
object_id
required
string <uuid> (Object id)
account_id
required
string or null <uuid> (Account id)
meta_data
object or null (Meta data)

Responses

Request samples

Content type
application/json
{
  • "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  • "event_type": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "meta_data": { }
}

Response samples

Content type
application/json
{
  • "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  • "event_type": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "meta_data": { }
}

api_v1.0_smi_user_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_smi_user_update_details_create

Authorizations:
Basic
Request Body schema: application/json
required
userId
required
string (Userid) non-empty
dateOfBirth
string or null (Dateofbirth)
fullName
string or null (Fullname)
phoneNumber
string or null (Phonenumber)
Default: ""
cardExpiryDate
string or null (Cardexpirydate)
idNumber
string or null (Idnumber)
cardNumber
string or null (Cardnumber)

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

api_v1.0_smi_user_update_details_partial_update

Authorizations:
Basic
Request Body schema: application/json
required
userId
required
string (Userid) non-empty
dateOfBirth
string or null (Dateofbirth)
fullName
string or null (Fullname)
phoneNumber
string or null (Phonenumber)
Default: ""
cardExpiryDate
string or null (Cardexpirydate)
idNumber
string or null (Idnumber)
cardNumber
string or null (Cardnumber)

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

api_v1.0_smi_user_upload_gosi

Authorizations:
Basic

Responses

api_v1.0_smi_user_verify_create

Authorizations:
Basic
Request Body schema: application/json
required
verificationUrl
required
string (Verificationurl) non-empty
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

api_v1.0_smi_user_verify_partial_update

Authorizations:
Basic
Request Body schema: application/json
required
verificationUrl
required
string (Verificationurl) non-empty
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

api_v1.0_smi_user_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_user_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_user_outstanding

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_smi_vgs_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_smi_vgs_create

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_add_card

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_proxy

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_update

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_partial_update

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_smi_vgs_delete

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

api_v1.0_smi_vgs_pay_pending

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
required
object (AddCard)
payment_data
required
object (Payment data)
charge_type
string or null (Charge type) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "processing_details": {
    },
  • "payment_data": { },
  • "charge_type": "string"
}

Response samples

Content type
application/json
{
  • "processing_details": {
    },
  • "payment_data": { },
  • "charge_type": "string"
}

api_v1.0_statistics_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_v1.0_tap_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_tap_create

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_callback

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_redirect_read

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_tap_redirect_create

Authorizations:
Basic
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_partial_update

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
checkout_id
string or null (Checkout id) <= 255 characters
installment_id
string or null (Installment id) <= 255 characters
prepay_type
string or null (Prepay type) <= 255 characters
internal_transaction_id
required
string (Internal transaction id) [ 1 .. 255 ] characters
is_add_card
boolean (Is add card)
Default: false
order_id
string or null (Order id) <= 255 characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency) [ 1 .. 10 ] characters
threeDSecure
boolean (Threedsecure)
Default: true
save_card
boolean (Save card)
Default: true
merchant_id
required
string (Merchant id) [ 1 .. 255 ] characters
product
string or null (Product) <= 255 characters
statement_descriptor
string or null (Statement descriptor) <= 255 characters
description
string or null (Description) <= 255 characters
transaction_authorization_id
string or null (Transaction authorization id) <= 255 characters
reference_track
string or null (Reference track) <= 255 characters
reference_payment
string or null (Reference payment) <= 255 characters
reference_gateway
string or null (Reference gateway) <= 255 characters
reference_acquirer
string or null (Reference acquirer) <= 255 characters
response_code
string or null (Response code) <= 255 characters
response_message
string or null (Response message) <= 255 characters
acquirer_response_code
string or null (Acquirer response code) <= 255 characters
acquirer_response_message
string or null (Acquirer response message) <= 255 characters
gateway_response_code
string or null (Gateway response code) <= 255 characters
gateway_response_message
string or null (Gateway response message) <= 255 characters
card_id
string or null (Card id) <= 255 characters
card_first_six
string or null (Card first six) <= 255 characters
card_first_eight
string or null (Card first eight) <= 255 characters
card_scheme
string or null (Card scheme) <= 255 characters
card_brand
string or null (Card brand) <= 255 characters
card_last_four
string or null (Card last four) <= 255 characters
receipt_id
string or null (Receipt id) <= 255 characters
receipt_email
boolean (Receipt email)
Default: false
receipt_sms
boolean (Receipt sms)
Default: false
customer_id
string or null (Customer id) <= 255 characters
source_id
string or null (Source id) <= 255 characters
source_channel
string or null (Source channel) <= 255 characters
source_payment_type
string or null (Source payment type) <= 255 characters
source_payment_method
string or null (Source payment method) <= 255 characters
authentication_id
string or null (Authentication id) <= 255 characters
payment_agreement_id
string or null (Payment agreement id) <= 255 characters
auto
object or null (Auto)
metadata
object or null (Metadata)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "checkout_id": "string",
  • "installment_id": "string",
  • "prepay_type": "string",
  • "internal_transaction_id": "string",
  • "is_add_card": false,
  • "order_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "threeDSecure": true,
  • "save_card": true,
  • "merchant_id": "string",
  • "product": "string",
  • "statement_descriptor": "string",
  • "description": "string",
  • "transaction_authorization_id": "string",
  • "reference_track": "string",
  • "reference_payment": "string",
  • "reference_gateway": "string",
  • "reference_acquirer": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "acquirer_response_code": "string",
  • "acquirer_response_message": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "card_id": "string",
  • "card_first_six": "string",
  • "card_first_eight": "string",
  • "card_scheme": "string",
  • "card_brand": "string",
  • "card_last_four": "string",
  • "receipt_id": "string",
  • "receipt_email": false,
  • "receipt_sms": false,
  • "customer_id": "string",
  • "source_id": "string",
  • "source_channel": "string",
  • "source_payment_type": "string",
  • "source_payment_method": "string",
  • "authentication_id": "string",
  • "payment_agreement_id": "string",
  • "auto": { },
  • "metadata": { }
}

api_v1.0_tap_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_tm-session_init

Authorizations:
Basic
Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_tm-session_read

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Responses

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_tm-session_patch_checkout_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
checkout_id
required
string <uuid> (Checkout id)
deleted_at
string or null <date-time> (Deleted at)
user
string or null <uuid> (User)

Responses

Request samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

api_v1.0_tm-session_patch_checkout_partial_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
checkout_id
required
string <uuid> (Checkout id)
deleted_at
string or null <date-time> (Deleted at)
user
string or null <uuid> (User)

Responses

Request samples

Content type
application/json
{
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "user": "76f62a58-5404-486d-9afc-07bded328704"
}

api_v1.0_tm-session_patch_user_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_tm-session_patch_user_partial_update

Authorizations:
Basic
path Parameters
session_id
required
string <uuid>

A UUID string identifying this threat metrix session.

Request Body schema: application/json
required
required
object (User)
checkout_id
required
string <uuid> (Checkout id)
created_at
required
string <date-time> (Created at)
updated_at
required
string <date-time> (Updated at)
deleted_at
required
string <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "user": { },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",
  • "user": {
    },
  • "checkout_id": "a0db819d-3316-4040-b9b7-2c905552650c",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

api_v1.0_upload-identities-lock-listen_create

Authorizations:
Basic
Request Body schema: application/json
required
event_id
required
string <uuid> (Event id)
event_type
required
string (Event type) non-empty
object_id
required
string <uuid> (Object id)
account_id
required
string or null <uuid> (Account id)
meta_data
object or null (Meta data)

Responses

Request samples

Content type
application/json
{
  • "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  • "event_type": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "meta_data": { }
}

Response samples

Content type
application/json
{
  • "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  • "event_type": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "meta_data": { }
}

api_v1.0_user_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

api_v1.0_user_update_details_create

Authorizations:
Basic
Request Body schema: application/json
required
userId
required
string (Userid) non-empty
dateOfBirth
string or null (Dateofbirth)
fullName
string or null (Fullname)
phoneNumber
string or null (Phonenumber)
Default: ""
cardExpiryDate
string or null (Cardexpirydate)
idNumber
string or null (Idnumber)
cardNumber
string or null (Cardnumber)

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

api_v1.0_user_update_details_partial_update

Authorizations:
Basic
Request Body schema: application/json
required
userId
required
string (Userid) non-empty
dateOfBirth
string or null (Dateofbirth)
fullName
string or null (Fullname)
phoneNumber
string or null (Phonenumber)
Default: ""
cardExpiryDate
string or null (Cardexpirydate)
idNumber
string or null (Idnumber)
cardNumber
string or null (Cardnumber)

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "dateOfBirth": "string",
  • "fullName": "string",
  • "phoneNumber": "",
  • "cardExpiryDate": "string",
  • "idNumber": "string",
  • "cardNumber": "string"
}

api_v1.0_user_upload_gosi

Authorizations:
Basic

Responses

api_v1.0_user_verify_create

Authorizations:
Basic
Request Body schema: application/json
required
verificationUrl
required
string (Verificationurl) non-empty
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

api_v1.0_user_verify_partial_update

Authorizations:
Basic
Request Body schema: application/json
required
verificationUrl
required
string (Verificationurl) non-empty
code
required
string (Code) non-empty

Responses

Request samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "verificationUrl": "string",
  • "code": "string"
}

api_v1.0_user_read

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_user_delete

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_user_outstanding

Authorizations:
Basic
path Parameters
user_id
required
string <uuid>

A UUID string identifying this user.

Responses

api_v1.0_vgs_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1.0_vgs_create

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_add_card

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_proxy

Authorizations:
Basic
Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_read

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_update

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_partial_update

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
card_number
string or null (Card number) <= 255 characters
object (CardExpiry)
card_security_code
required
string (Card security code) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 10 characters
last_4_digits
string or null (Last 4 digits) <= 4 characters
card_type
string (Card type) [ 1 .. 255 ] characters
card_holder
string or null (Card holder) <= 255 characters
payment_method_id
string or null (Payment method id) <= 255 characters
request_source
string or null (Request source) <= 255 characters
checkout_id
string or null (Checkout id) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

Response samples

Content type
application/json
{
  • "card_number": "string",
  • "card_expiration_date": {
    },
  • "card_security_code": "string",
  • "bin": "string",
  • "last_4_digits": "stri",
  • "card_type": "string",
  • "card_holder": "string",
  • "payment_method_id": "string",
  • "request_source": "string",
  • "checkout_id": "string"
}

api_v1.0_vgs_delete

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Responses

api_v1.0_vgs_pay_pending

Authorizations:
Basic
path Parameters
order_id
required
string <uuid>

A UUID string identifying this Order.

Request Body schema: application/json
required
required
object (AddCard)
payment_data
required
object (Payment data)
charge_type
string or null (Charge type) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "processing_details": {
    },
  • "payment_data": { },
  • "charge_type": "string"
}

Response samples

Content type
application/json
{
  • "processing_details": {
    },
  • "payment_data": { },
  • "charge_type": "string"
}