API docs by Redocly

BNPL BILLING (v1)

API documentation for BNPL BILLING

accounts

accounts_list

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

accounts_create

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 255 characters
currency
string or null (Currency) <= 3 characters
time_zone
string or null (Time zone) <= 128 characters
locale
string or null (Locale) <= 16 characters
country
string or null (Country) <= 3 characters
notes
string or null (Notes)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_addresses": "http://example.com",
  • "payment_methods": "http://example.com",
  • "installments": "http://example.com",
  • "payments": "http://example.com",
  • "has_active_withdrawal_request": "string",
  • "cashback_total": "string"
}

accounts_read

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Responses

Response samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_addresses": "http://example.com",
  • "payment_methods": "http://example.com",
  • "installments": "http://example.com",
  • "payments": "http://example.com",
  • "has_active_withdrawal_request": "string",
  • "cashback_total": "string"
}

accounts_update

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 255 characters
currency
string or null (Currency) <= 3 characters
time_zone
string or null (Time zone) <= 128 characters
locale
string or null (Locale) <= 16 characters
country
string or null (Country) <= 3 characters
notes
string or null (Notes)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_addresses": "http://example.com",
  • "payment_methods": "http://example.com",
  • "installments": "http://example.com",
  • "payments": "http://example.com",
  • "has_active_withdrawal_request": "string",
  • "cashback_total": "string"
}

accounts_partial_update

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 255 characters
currency
string or null (Currency) <= 3 characters
time_zone
string or null (Time zone) <= 128 characters
locale
string or null (Locale) <= 16 characters
country
string or null (Country) <= 3 characters
notes
string or null (Notes)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "currency": "str",
  • "time_zone": "string",
  • "locale": "string",
  • "country": "str",
  • "notes": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_addresses": "http://example.com",
  • "payment_methods": "http://example.com",
  • "installments": "http://example.com",
  • "payments": "http://example.com",
  • "has_active_withdrawal_request": "string",
  • "cashback_total": "string"
}

accounts_delete

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Responses

accounts_billing-addresses_list

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

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": [
    ]
}

accounts_billing-addresses_create

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

accounts_billing-addresses_default

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

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": [
    ]
}

accounts_billing-addresses_read

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Responses

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

accounts_billing-addresses_update

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

accounts_billing-addresses_partial_update

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

accounts_billing-addresses_delete

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Responses

accounts_cashback_list

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
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": [
    ]
}

accounts_cashback_create

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string (Currency) [ 1 .. 3 ] characters
Default: "USD"
remarks
object or null (Remarks)
order_date
string or null <date-time> (Order date)
credit_date
string or null <date-time> (Credit date)
source
string (Source) non-empty
Default: "affiliate"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

accounts_cashback_get_cashback_report

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
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": [
    ]
}

accounts_cashback_withdraw_req

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string (Currency) [ 1 .. 3 ] characters
Default: "USD"
remarks
object or null (Remarks)
order_date
string or null <date-time> (Order date)
credit_date
string or null <date-time> (Credit date)
source
string (Source) non-empty
Default: "affiliate"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

accounts_cashback_read

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

accounts_cashback_update

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
required
Array of objects (ReadSingleCashback)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

accounts_cashback_partial_update

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
required
Array of objects (ReadSingleCashback)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

accounts_change_info

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Request Body schema: application/json
required
email
string or null (Email) <= 250 characters
phone_number
string or null (Phone number) <= 15 characters

Responses

Request samples

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

Response samples

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

accounts_installments_list

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "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": [
    ]
}

accounts_installments_create

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string"
}

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": "string"
}

accounts_installments_active

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "REFUNDED" "VOIDED"

status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

accounts_installments_all

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "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": [
    ]
}

accounts_installments_get_rejection

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
gateway_code
required
string (Gateway code) [ 1 .. 255 ] characters
gateway_status
required
string (Gateway status) [ 1 .. 255 ] characters
transaction_type
string (Transaction type) [ 1 .. 100 ] characters
Default: "AUTHORIZE"
plugin_name
required
string (Plugin name) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "gateway_code": "string",
  • "gateway_status": "string",
  • "transaction_type": "AUTHORIZE",
  • "plugin_name": "string"
}

Response samples

Content type
application/json
{
  • "gateway_code": "string",
  • "gateway_status": "string",
  • "transaction_type": "AUTHORIZE",
  • "plugin_name": "string"
}

accounts_installments_process_all

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
account_id
required
string (Account id) [ 1 .. 50 ] characters

Responses

Request samples

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

Response samples

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

accounts_installments_record_offline_payment

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
installment_number
required
integer (Installment number)
order_id
required
string (Order id) [ 1 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "installment_number": 0,
  • "order_id": "string"
}

Response samples

Content type
application/json
{
  • "installment_number": 0,
  • "order_id": "string"
}

accounts_installments_void_all_remaining

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
order_id
required
string (Order id) [ 1 .. 50 ] characters
installment_id
required
string (Installment id) [ 1 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "installment_id": "string"
}

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "installment_id": "string"
}

accounts_installments_read

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string 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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

accounts_installments_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)
user_fee_details
required
object or null (User fee details)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "user_fee_details": { }
}

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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

accounts_installments_partial_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)
user_fee_details
required
object or null (User fee details)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "user_fee_details": { }
}

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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

accounts_installments_authorize

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
object (InstallmentsAuthorizeSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

accounts_installments_capture

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string or null (Currency) non-empty

Responses

Request samples

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

Response samples

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

accounts_installments_get_balance

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Responses

Response samples

Content type
application/json
{
  • "balance": "string",
  • "currency": "USD"
}

accounts_installments_pay_all

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
payment_method
string or null <uuid> (Payment method)
is_cashback
boolean or null (Is cashback)
remarks
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

accounts_installments_plan_change

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
new_plan_id
required
string or null (New plan id) <= 255 characters
installments_id
required
string (Installments id) [ 1 .. 255 ] characters
authorise
boolean (Authorise)
Default: true

Responses

Request samples

Content type
application/json
{
  • "new_plan_id": "string",
  • "installments_id": "string",
  • "authorise": true
}

Response samples

Content type
application/json
{
  • "new_plan_id": "string",
  • "installments_id": "string",
  • "authorise": true
}

accounts_installments_refund

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string or null (Currency) non-empty
remarks
object or null (Remarks)

Responses

Request samples

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

Response samples

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

accounts_installments_void

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
object (InstallmentsVoid)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

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": [
    ]
}

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
invoice_id
required
string <uuid>

A UUID string identifying this invoice.

Responses

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "items": [
    ],
  • "balance": "string",
  • "currency": "USD",
  • "type": "FIXED",
  • "status": "DAFT",
  • "created_at": "2019-08-24T14:15:22Z",
  • "target_at": "2019-08-24T14:15:22Z",
  • "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
  • "invoice_number": "string",
  • "account_id": "string"
}

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
invoice_id
required
string <uuid>

A UUID string identifying this invoice.

Request Body schema: application/json
required
action
required
string or null (Action) <= 50 characters

Responses

Request samples

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

Response samples

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

accounts_outstanding

API endpoint that allow account to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string <uuid>

A UUID string identifying this account.

Responses

Response samples

Content type
application/json
{
  • "outstanding_amount": "string",
  • "total_late_fee_count": "string",
  • "pending_late_fee_count": "string",
  • "unpaid_installments_count": "string",
  • "currency": "string",
  • "order_user_fee": "string"
}

accounts_payment-methods_list

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

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": [
    ]
}

accounts_payment-methods_create

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

accounts_payment-methods_default

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
query Parameters
external_key
string

external_key

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": [
    ]
}

accounts_payment-methods_read

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

accounts_payment-methods_update

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

accounts_payment-methods_partial_update

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

accounts_payment-methods_delete

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

accounts_payment-methods_holder

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

API endpoint that allow access to payment.

The Payment resource represents the payments associated to a given customer Account.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
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 endpoint that allow access to payment.

The Payment resource represents the payments associated to a given customer Account.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
payment_id
required
string <uuid>

A UUID string identifying this payment.

Responses

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

accounts_installments_installments_list

Authorizations:
BasicBearer
path Parameters
installments__account_id
required
string
installments_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

effective_at
string

effective_at

account_id
string

account_id

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "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": [
    ]
}

accounts_installments_installments_read

Authorizations:
BasicBearer
path Parameters
installments__account_id
required
string
installments_id
required
string
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Responses

Response samples

Content type
application/json
{
  • "installment_id": "b0641bef-eb28-4add-ac2c-dfeeb9aee69f",
  • "effective_at": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "phase_id": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "payments": [
    ],
  • "account_id": "string",
  • "installments_details": {
    },
  • "payment_method_id": "string",
  • "refunded_transactions": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z",
  • "late_fee": "string",
  • "first_installment_amount_aed": "string",
  • "is_last_installment": "string"
}

accounts_installments_installments_pay

Authorizations:
BasicBearer
path Parameters
installments__account_id
required
string
installments_id
required
string
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Request Body schema: application/json
required
payment_method
string or null <uuid> (Payment method)
is_cashback
boolean or null (Is cashback)
remarks
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

accounts_installments_installments_refund

Authorizations:
BasicBearer
path Parameters
installments__account_id
required
string
installments_id
required
string
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Request Body schema: application/json
required
object (InstallmentRefundSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

billing_addresses

billing_addresses_list

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

billing_addresses_create

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

billing_addresses_default

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

billing_addresses_read

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Responses

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

billing_addresses_update

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

billing_addresses_partial_update

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
string or null (Name) <= 255 characters
first_name_len
integer or null (First name len) [ -2147483648 .. 2147483647 ]
email
string or null <email> (Email) <= 254 characters
phone
string or null (Phone) <= 128 characters
country
string or null (Country) <= 3 characters
city
string or null (City) <= 255 characters
state
string or null (State) <= 255 characters
address1
string or null (Address1) <= 255 characters
address2
string or null (Address2) <= 255 characters
address3
string or null (Address3) <= 255 characters
postal_code
string or null (Postal code) <= 255 characters
company
string or null (Company) <= 255 characters
notes
string or null (Notes)
is_default
boolean or null (Is default)
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "billing_address_id": "8e8c171a-db37-4819-9621-58c64d04ab7d",
  • "external_key": "string",
  • "name": "string",
  • "first_name_len": -2147483648,
  • "email": "user@example.com",
  • "phone": "string",
  • "country": "str",
  • "city": "string",
  • "state": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "company": "string",
  • "notes": "string",
  • "is_default": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

billing_addresses_delete

API endpoint that allow billing address to be created, deleted, viewed or edited

Authorizations:
BasicBearer
path Parameters
billing_address_id
required
string <uuid>

A UUID string identifying this billing address.

Responses

careem-pay

careem-pay_list

Authorizations:
BasicBearer
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

careem-pay_create

Authorizations:
BasicBearer

Responses

careem-pay_get_order

Authorizations:
BasicBearer
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

careem-pay_read

Authorizations:
BasicBearer
path Parameters
cpay_id
required
string <uuid>

Responses

careem-pay_update

Authorizations:
BasicBearer
path Parameters
cpay_id
required
string <uuid>

Responses

careem-pay_partial_update

Authorizations:
BasicBearer
path Parameters
cpay_id
required
string <uuid>

Responses

careem-pay_delete

Authorizations:
BasicBearer
path Parameters
cpay_id
required
string <uuid>

Responses

cashback

cashback_list

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
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": [
    ]
}

cashback_create

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string (Currency) [ 1 .. 3 ] characters
Default: "USD"
remarks
object or null (Remarks)
order_date
string or null <date-time> (Order date)
credit_date
string or null <date-time> (Credit date)
source
string (Source) non-empty
Default: "affiliate"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

cashback_get_cashback_report

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
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": [
    ]
}

cashback_withdraw_req

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string (Currency) [ 1 .. 3 ] characters
Default: "USD"
remarks
object or null (Remarks)
order_date
string or null <date-time> (Order date)
credit_date
string or null <date-time> (Credit date)
source
string (Source) non-empty
Default: "affiliate"

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "remarks": { },
  • "order_date": "2019-08-24T14:15:22Z",
  • "credit_date": "2019-08-24T14:15:22Z",
  • "source": "affiliate"
}

cashback_read

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

cashback_update

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
required
Array of objects (ReadSingleCashback)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

cashback_partial_update

The cashback resource manages timeline and similar fetches.

Authorizations:
BasicBearer
path Parameters
account_id
required
string
Request Body schema: application/json
required
required
Array of objects (ReadSingleCashback)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cashbacks": [
    ],
  • "total": "string",
  • "bank_withdrawal_total": "string"
}

configurations

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
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
{}

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
value
required
object (Value)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
path Parameters
key
required
string
Request Body schema: application/json
required
value
required
object (Value)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
path Parameters
key
required
string
Request Body schema: application/json
required
value
required
object (Value)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Tenant configuration

Some of the tenant configuration can be overriden at the tenant level to allow different behaviors.

Authorizations:
BasicBearer
path Parameters
key
required
string

Responses

currencies

currencies_list

Authorizations:
BasicBearer
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": [
    ]
}

currencies_read

Authorizations:
BasicBearer
path Parameters
currency
required
string

A unique value identifying this currencies.

Responses

Response samples

Content type
application/json
{
  • "currency": "string",
  • "base_currency": "string",
  • "conversion": "string",
  • "settlement_conversion": "string"
}

hyper-pay

hyper-pay_list

Authorizations:
BasicBearer
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": [
    ]
}

hyper-pay_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
user_id
required
string (User id) [ 1 .. 255 ] characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
payment_brand
required
string (Payment brand) [ 1 .. 255 ] characters
payment_type
required
string (Payment type) [ 1 .. 255 ] characters
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string or null (Mada agreement id) <= 255 characters
registration_id
string or null <uuid> (Registration id)
bin
string or null (Bin) <= 255 characters
last_4_digits
string or null (Last 4 digits) <= 255 characters
expiry_month
string or null (Expiry month) <= 255 characters
expiry_year
string or null (Expiry year) <= 255 characters
result_code
string (Result code) <= 255 characters
result_description
string (Result description) <= 255 characters
extended_description
string (Extended description) <= 255 characters
acquirer_response
string (Acquirer response) <= 255 characters
reconciliation_id
string (Reconciliation id) <= 255 characters
card_type
string or null (Card type) <= 255 characters
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_create_checkout

Authorizations:
BasicBearer
Request Body schema: application/json
required
user_id
required
string (User id) [ 1 .. 255 ] characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
payment_brand
required
string (Payment brand) [ 1 .. 255 ] characters
payment_type
required
string (Payment type) [ 1 .. 255 ] characters
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string or null (Mada agreement id) <= 255 characters
registration_id
string or null <uuid> (Registration id)
bin
string or null (Bin) <= 255 characters
last_4_digits
string or null (Last 4 digits) <= 255 characters
expiry_month
string or null (Expiry month) <= 255 characters
expiry_year
string or null (Expiry year) <= 255 characters
result_code
string (Result code) <= 255 characters
result_description
string (Result description) <= 255 characters
extended_description
string (Extended description) <= 255 characters
acquirer_response
string (Acquirer response) <= 255 characters
reconciliation_id
string (Reconciliation id) <= 255 characters
card_type
string or null (Card type) <= 255 characters
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_payment_status

Authorizations:
BasicBearer
Request Body schema: application/json
required
user_id
required
string (User id) [ 1 .. 255 ] characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
payment_brand
required
string (Payment brand) [ 1 .. 255 ] characters
payment_type
required
string (Payment type) [ 1 .. 255 ] characters
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string or null (Mada agreement id) <= 255 characters
registration_id
string or null <uuid> (Registration id)
bin
string or null (Bin) <= 255 characters
last_4_digits
string or null (Last 4 digits) <= 255 characters
expiry_month
string or null (Expiry month) <= 255 characters
expiry_year
string or null (Expiry year) <= 255 characters
result_code
string (Result code) <= 255 characters
result_description
string (Result description) <= 255 characters
extended_description
string (Extended description) <= 255 characters
acquirer_response
string (Acquirer response) <= 255 characters
reconciliation_id
string (Reconciliation id) <= 255 characters
card_type
string or null (Card type) <= 255 characters
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_read

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment details.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment details.

Request Body schema: application/json
required
user_id
required
string (User id) [ 1 .. 255 ] characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
payment_brand
required
string (Payment brand) [ 1 .. 255 ] characters
payment_type
required
string (Payment type) [ 1 .. 255 ] characters
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string or null (Mada agreement id) <= 255 characters
registration_id
string or null <uuid> (Registration id)
bin
string or null (Bin) <= 255 characters
last_4_digits
string or null (Last 4 digits) <= 255 characters
expiry_month
string or null (Expiry month) <= 255 characters
expiry_year
string or null (Expiry year) <= 255 characters
result_code
string (Result code) <= 255 characters
result_description
string (Result description) <= 255 characters
extended_description
string (Extended description) <= 255 characters
acquirer_response
string (Acquirer response) <= 255 characters
reconciliation_id
string (Reconciliation id) <= 255 characters
card_type
string or null (Card type) <= 255 characters
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment details.

Request Body schema: application/json
required
user_id
required
string (User id) [ 1 .. 255 ] characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
payment_brand
required
string (Payment brand) [ 1 .. 255 ] characters
payment_type
required
string (Payment type) [ 1 .. 255 ] characters
initial_transaction_id
required
string (Initial transaction id) [ 1 .. 255 ] characters
mada_agreement_id
string or null (Mada agreement id) <= 255 characters
registration_id
string or null <uuid> (Registration id)
bin
string or null (Bin) <= 255 characters
last_4_digits
string or null (Last 4 digits) <= 255 characters
expiry_month
string or null (Expiry month) <= 255 characters
expiry_year
string or null (Expiry year) <= 255 characters
result_code
string (Result code) <= 255 characters
result_description
string (Result description) <= 255 characters
extended_description
string (Extended description) <= 255 characters
acquirer_response
string (Acquirer response) <= 255 characters
reconciliation_id
string (Reconciliation id) <= 255 characters
card_type
string or null (Card type) <= 255 characters
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "order_id": "string",
  • "payment_brand": "string",
  • "payment_type": "string",
  • "initial_transaction_id": "string",
  • "mada_agreement_id": "string",
  • "registration_id": "7b2966db-5b97-451d-80d4-713d3a44078b",
  • "bin": "string",
  • "last_4_digits": "string",
  • "expiry_month": "string",
  • "expiry_year": "string",
  • "result_code": "string",
  • "result_description": "string",
  • "extended_description": "string",
  • "acquirer_response": "string",
  • "reconciliation_id": "string",
  • "card_type": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

hyper-pay_delete

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment details.

Responses

installment-estimate

installment-estimate_create

The estimation resource calculate estimation for provided amount and currency

Authorizations:
BasicBearer
Request Body schema: application/json
required
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
date
string or null <date-time> (Date)
Default: "2024-11-19T02:27:05.889615Z"
promo_details
object or null (Promo details)
user_fee_details
object or null (User fee details)
consumer_spend_limit
object or null (Consumer spend limit)
structure
string or null (Structure)
merchant_plans
object or null (Merchant plans)

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "date": "2024-11-19T02:27:05.889615Z",
  • "promo_details": { },
  • "user_fee_details": { },
  • "consumer_spend_limit": { },
  • "structure": "string",
  • "merchant_plans": { }
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "currency": "USD",
  • "date": "2024-11-19T02:27:05.889615Z",
  • "promo_details": { },
  • "user_fee_details": { },
  • "consumer_spend_limit": { },
  • "structure": "string",
  • "merchant_plans": { },
  • "estimations": "string",
  • "discounted_amount": "string",
  • "cashback_amount": "string",
  • "available_offer": "string",
  • "vpuf_estimations": "string"
}

installment

installment_list

Authorizations:
BasicBearer
query Parameters
ordering
string

Which field to use when ordering the results.

effective_at
string

effective_at

account_id
string

account_id

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "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": [
    ]
}

installment_read

Authorizations:
BasicBearer
path Parameters
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Responses

Response samples

Content type
application/json
{
  • "installment_id": "b0641bef-eb28-4add-ac2c-dfeeb9aee69f",
  • "effective_at": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "phase_id": "string",
  • "amount": "string",
  • "total": "string",
  • "currency": "string",
  • "payments": [
    ],
  • "account_id": "string",
  • "installments_details": {
    },
  • "payment_method_id": "string",
  • "refunded_transactions": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z",
  • "late_fee": "string",
  • "first_installment_amount_aed": "string",
  • "is_last_installment": "string"
}

installment_pay

Authorizations:
BasicBearer
path Parameters
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Request Body schema: application/json
required
payment_method
string or null <uuid> (Payment method)
is_cashback
boolean or null (Is cashback)
remarks
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

installment_refund

Authorizations:
BasicBearer
path Parameters
installment_id
required
string <uuid>

A UUID string identifying this installments installment.

Request Body schema: application/json
required
object (InstallmentRefundSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

installments-plan

installments-plan_list

Authorizations:
BasicBearer
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": [
    ]
}

installments-plan_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
slug
required
string <slug> (Slug) [ 1 .. 50 ] characters ^[-a-zA-Z0-9_]+$
name
string or null (Name) <= 255 characters
description
string or null (Description)

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

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

installments-plan_read

Authorizations:
BasicBearer
path Parameters
plan_id
required
string

Responses

Response samples

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

installments

installments_list

The installments resource manage installments.

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "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": [
    ]
}

installments_create

The installments resource manage installments.

Authorizations:
BasicBearer
Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string"
}

Response samples

Content type
application/json
{
  • "installments_id": "6a2d5618-f639-49ba-b201-cedda39ab573",
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": "string"
}

installments_active

The installments resource manage installments.

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "REFUNDED" "VOIDED"

status

page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

installments_all

The installments resource manage installments.

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

status
string
Enum: "DRAFT" "AUTHORIZED" "PAID" "SCHEDULED" "MISSED" "REFUNDED" "VOIDED" "DRAFT" "ACTIVE" "COMPLETE" "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": [
    ]
}

installments_get_rejection

The installments resource manage installments.

Authorizations:
BasicBearer
Request Body schema: application/json
required
gateway_code
required
string (Gateway code) [ 1 .. 255 ] characters
gateway_status
required
string (Gateway status) [ 1 .. 255 ] characters
transaction_type
string (Transaction type) [ 1 .. 100 ] characters
Default: "AUTHORIZE"
plugin_name
required
string (Plugin name) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "gateway_code": "string",
  • "gateway_status": "string",
  • "transaction_type": "AUTHORIZE",
  • "plugin_name": "string"
}

Response samples

Content type
application/json
{
  • "gateway_code": "string",
  • "gateway_status": "string",
  • "transaction_type": "AUTHORIZE",
  • "plugin_name": "string"
}

installments_process_all

The installments resource manage installments.

Authorizations:
BasicBearer
Request Body schema: application/json
required
account_id
required
string (Account id) [ 1 .. 50 ] characters

Responses

Request samples

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

Response samples

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

installments_record_offline_payment

The installments resource manage installments.

Authorizations:
BasicBearer
Request Body schema: application/json
required
installment_number
required
integer (Installment number)
order_id
required
string (Order id) [ 1 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "installment_number": 0,
  • "order_id": "string"
}

Response samples

Content type
application/json
{
  • "installment_number": 0,
  • "order_id": "string"
}

installments_void_all_remaining

The installments resource manage installments.

Authorizations:
BasicBearer
Request Body schema: application/json
required
order_id
required
string (Order id) [ 1 .. 50 ] characters
installment_id
required
string (Installment id) [ 1 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "installment_id": "string"
}

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "installment_id": "string"
}

installments_read

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string 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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

installments_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)
user_fee_details
required
object or null (User fee details)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "user_fee_details": { }
}

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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

installments_partial_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 255 characters
plan_id
required
string <uuid> (Plan id)
payment_method_id
string or null <uuid> (Payment method id)
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
auto_debit
boolean (Auto debit)
Default: true
variable_amount
string or null <decimal> (Variable amount)
approved_amount
string or null <decimal> (Approved amount)
user_fee_details
required
object or null (User fee details)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "amount": "string",
  • "currency": "USD",
  • "auto_debit": true,
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "user_fee_details": { }
}

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",
  • "amount": "string",
  • "total": "string",
  • "currency": "USD",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "auto_debit": true,
  • "user_fee": "string",
  • "is_upfront_fee": true,
  • "fee_per_installment": "string",
  • "amount_incl_fee": "string",
  • "variable_amount": "string",
  • "approved_amount": "string",
  • "installments": [
    ],
  • "processed_amount": "string",
  • "refunded_amount": "string",
  • "redeemed_amount": "string",
  • "refund_amount": "string",
  • "late_fee": "string",
  • "user_fee_details": { }
}

installments_authorize

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
object (InstallmentsAuthorizeSerilizer)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

installments_capture

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string or null (Currency) non-empty

Responses

Request samples

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

Response samples

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

installments_get_balance

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Responses

Response samples

Content type
application/json
{
  • "balance": "string",
  • "currency": "USD"
}

installments_pay_all

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
payment_method
string or null <uuid> (Payment method)
is_cashback
boolean or null (Is cashback)
remarks
object (Remarks)

Responses

Request samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

Response samples

Content type
application/json
{
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "is_cashback": true,
  • "remarks": { }
}

installments_plan_change

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
new_plan_id
required
string or null (New plan id) <= 255 characters
installments_id
required
string (Installments id) [ 1 .. 255 ] characters
authorise
boolean (Authorise)
Default: true

Responses

Request samples

Content type
application/json
{
  • "new_plan_id": "string",
  • "installments_id": "string",
  • "authorise": true
}

Response samples

Content type
application/json
{
  • "new_plan_id": "string",
  • "installments_id": "string",
  • "authorise": true
}

installments_refund

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
amount
string or null <decimal> (Amount)
currency
string or null (Currency) non-empty
remarks
object or null (Remarks)

Responses

Request samples

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

Response samples

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

installments_void

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
installments_id
required
string <uuid>

A UUID string identifying this installments.

Request Body schema: application/json
required
object (InstallmentsVoid)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

invoices

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
path Parameters
invoice_id
required
string <uuid>

A UUID string identifying this invoice.

Responses

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "items": [
    ],
  • "balance": "string",
  • "currency": "USD",
  • "type": "FIXED",
  • "status": "DAFT",
  • "created_at": "2019-08-24T14:15:22Z",
  • "target_at": "2019-08-24T14:15:22Z",
  • "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
  • "invoice_number": "string",
  • "account_id": "string"
}

The invoice resource represents a specific invoice associated with a given account.

User can generate ivoice by provided apis to add credit or create charges againts the account. Invoices can also be automatically generated by system against the account, for instance by installment.

Authorizations:
BasicBearer
path Parameters
invoice_id
required
string <uuid>

A UUID string identifying this invoice.

Request Body schema: application/json
required
action
required
string or null (Action) <= 50 characters

Responses

Request samples

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

Response samples

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

lean

lean_list

Authorizations:
BasicBearer
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": [
    ]
}

lean_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
customer_id
required
string <uuid> (Customer id)
account
required
string <uuid> (Account)

Responses

Request samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_all

Authorizations:
BasicBearer
Request Body schema: application/json
required
customer_id
required
string <uuid> (Customer id)
account
required
string <uuid> (Account)

Responses

Request samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_callback_list

Authorizations:
BasicBearer
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

lean_callback_create

Authorizations:
BasicBearer

Responses

lean_callback_read

Authorizations:
BasicBearer
path Parameters
id
required
string

Responses

lean_callback_update

Authorizations:
BasicBearer
path Parameters
id
required
string

Responses

lean_callback_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string

Responses

lean_callback_delete

Authorizations:
BasicBearer
path Parameters
id
required
string

Responses

lean_delete_entity

Authorizations:
BasicBearer
Request Body schema: application/json
required
customer_id
required
string <uuid> (Customer id)
account
required
string <uuid> (Account)

Responses

Request samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_intent_list

Authorizations:
BasicBearer
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": [
    ]
}

lean_intent_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
payment_intent_id
required
string <uuid> (Payment intent id)
account
required
string <uuid> (Account)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
amount
required
string <decimal> (Amount)
payment_destination
object or null (Payment destination)
payments
object or null (Payments)
meta
string or null (Meta) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "meta": "string"
}

Response samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "meta": "string"
}

lean_intent_read

Authorizations:
BasicBearer
path Parameters
payment_intent_id
required
string <uuid>

A UUID string identifying this payment intent.

Responses

Response samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "meta": "string"
}

lean_intent_update

Authorizations:
BasicBearer
path Parameters
payment_intent_id
required
string <uuid>

A UUID string identifying this payment intent.

Request Body schema: application/json
required
payment_intent_id
required
string <uuid> (Payment intent id)
account
required
string <uuid> (Account)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
amount
required
string <decimal> (Amount)
payment_destination
object or null (Payment destination)
payments
object or null (Payments)
meta
string or null (Meta) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "meta": "string"
}

Response samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "meta": "string"
}

lean_intent_partial_update

Authorizations:
BasicBearer
path Parameters
payment_intent_id
required
string <uuid>

A UUID string identifying this payment intent.

Request Body schema: application/json
required
payment_intent_id
required
string <uuid> (Payment intent id)
account
required
string <uuid> (Account)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
amount
required
string <decimal> (Amount)
payment_destination
object or null (Payment destination)
payments
object or null (Payments)
meta
string or null (Meta) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "meta": "string"
}

Response samples

Content type
application/json
{
  • "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "currency": "USD",
  • "amount": "string",
  • "payment_destination": { },
  • "payments": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "meta": "string"
}

lean_intent_delete

Authorizations:
BasicBearer
path Parameters
payment_intent_id
required
string <uuid>

A UUID string identifying this payment intent.

Responses

lean_read

Authorizations:
BasicBearer
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",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_update

Authorizations:
BasicBearer
path Parameters
customer_id
required
string <uuid>

A UUID string identifying this customer.

Request Body schema: application/json
required
customer_id
required
string <uuid> (Customer id)
account
required
string <uuid> (Account)

Responses

Request samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_partial_update

Authorizations:
BasicBearer
path Parameters
customer_id
required
string <uuid>

A UUID string identifying this customer.

Request Body schema: application/json
required
customer_id
required
string <uuid> (Customer id)
account
required
string <uuid> (Account)

Responses

Request samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Response samples

Content type
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "payment_sources": [
    ],
  • "entities": [
    ]
}

lean_delete

Authorizations:
BasicBearer
path Parameters
customer_id
required
string <uuid>

A UUID string identifying this customer.

Responses

payment_methods

payment_methods_list

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

payment_methods_create

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

payment_methods_default

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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": [
    ]
}

payment_methods_read

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

payment_methods_update

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

payment_methods_partial_update

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Request Body schema: application/json
required
plugin_properties
object or null (Plugin properties)
required
object (CardDetails)
object (Instrument)
external_key
string or null (External key) [ 1 .. 255 ] characters
is_default
boolean or null (Is default)
name
string or null (Name) <= 255 characters
bkp_plugin_name_init
string or null (Bkp plugin name init) <= 255 characters
billing_address
string or null <uuid> (Billing address)
card_detail
string or null <uuid> (Card detail)

Responses

Request samples

Content type
application/json
{
  • "plugin_properties": { },
  • "card_details": {
    },
  • "cpay_instrument": {
    },
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

payment_methods_delete

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

payment_methods_holder

API endpoint that allow payment method to be viewed or edited

Authorizations:
BasicBearer
path Parameters
payment_method_id
required
string <uuid>

A UUID string identifying this payment method.

Responses

Response samples

Content type
application/json
{
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "plugin_properties": { },
  • "plugin_details": "string",
  • "card_details": {
    },
  • "currency": "string",
  • "plugin_name": "string",
  • "lean_payment_source_id": "string",
  • "lean_customer_id": "string",
  • "lean_bank_name": "string",
  • "cooled_off": "string",
  • "cpay_instrument": {
    },
  • "auto_debit": "string",
  • "external_key": "string",
  • "is_default": true,
  • "name": "string",
  • "bkp_plugin_name_init": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "billing_address": "e8da8a8d-c9c0-4360-932b-5c96eacea461",
  • "card_detail": "16d11445-6e64-4c7e-b154-7422db736efa"
}

payments

API endpoint that allow access to payment.

The Payment resource represents the payments associated to a given customer Account.

Authorizations:
BasicBearer
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 endpoint that allow access to payment.

The Payment resource represents the payments associated to a given customer Account.

Authorizations:
BasicBearer
path Parameters
payment_id
required
string <uuid>

A UUID string identifying this payment.

Responses

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

paytabs

paytabs_list

Authorizations:
BasicBearer
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": [
    ]
}

paytabs_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs_pay_list

Authorizations:
BasicBearer
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": [
    ]
}

paytabs_pay_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
external_key
required
string or null (External key) <= 254 characters
object_id
string or null <uuid> (Object id)
payment_number
required
string (Payment number) [ 1 .. 255 ] characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
created_by
required
string (Created by) [ 1 .. 255 ] characters
updated_by
required
string (Updated by) [ 1 .. 255 ] characters
tenant
required
string <uuid> (Tenant)
account
required
string <uuid> (Account)
payment_method
string or null <uuid> (Payment method)
object_type
integer or null (Object type)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

paytabs_pay_read

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment.

Responses

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

paytabs_pay_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 254 characters
object_id
string or null <uuid> (Object id)
payment_number
required
string (Payment number) [ 1 .. 255 ] characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
created_by
required
string (Created by) [ 1 .. 255 ] characters
updated_by
required
string (Updated by) [ 1 .. 255 ] characters
tenant
required
string <uuid> (Tenant)
account
required
string <uuid> (Account)
payment_method
string or null <uuid> (Payment method)
object_type
integer or null (Object type)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

paytabs_pay_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment.

Request Body schema: application/json
required
external_key
required
string or null (External key) <= 254 characters
object_id
string or null <uuid> (Object id)
payment_number
required
string (Payment number) [ 1 .. 255 ] characters
amount
required
string <decimal> (Amount)
currency
required
string (Currency)
Enum: "USD" "AED" "SAR" "BHD" "KWD" "OMR" "QAR"
created_by
required
string (Created by) [ 1 .. 255 ] characters
updated_by
required
string (Updated by) [ 1 .. 255 ] characters
tenant
required
string <uuid> (Tenant)
account
required
string <uuid> (Account)
payment_method
string or null <uuid> (Payment method)
object_type
integer or null (Object type)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

Response samples

Content type
application/json
{
  • "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71",
  • "transactions": [
    ],
  • "external_key": "string",
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "payment_number": "string",
  • "amount": "string",
  • "currency": "USD",
  • "created_by": "string",
  • "updated_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26",
  • "object_type": 0
}

paytabs_pay_delete

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this payment.

Responses

paytabs_read

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs_delete

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Responses

paytabs2

paytabs2_list

Authorizations:
BasicBearer
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": [
    ]
}

paytabs2_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "string",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs2_read

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "string",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs2_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "string",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs2_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Request Body schema: application/json
required
transaction_id
required
string (Transaction id) [ 1 .. 255 ] characters
bkp_transaction_id_pt1
string or null (Bkp transaction id pt1) <= 255 characters
account_id
required
string (Account id) [ 1 .. 255 ] characters
order_id
required
string (Order id) [ 1 .. 255 ] characters
response_code
required
string (Response code) [ 1 .. 255 ] characters
response_message
required
string (Response message) [ 1 .. 255 ] characters
customer_name
required
string (Customer name) [ 1 .. 255 ] characters
customer_email
required
string (Customer email) [ 1 .. 255 ] characters
transaction_amount
required
string (Transaction amount) [ 1 .. 255 ] characters
transaction_currency
required
string (Transaction currency) [ 1 .. 255 ] characters
customer_phone
required
string (Customer phone) [ 1 .. 255 ] characters
last_4_digits
required
string (Last 4 digits) [ 1 .. 255 ] characters
first_4_digits
required
string (First 4 digits) [ 1 .. 255 ] characters
bin
string or null (Bin) <= 255 characters
card_brand
required
string (Card brand) [ 1 .. 255 ] characters
card_type
string or null (Card type) <= 255 characters
local_network
string or null (Local network) <= 255 characters
expiry_month
string or null (Expiry month) <= 2 characters
expiry_year
string or null (Expiry year) <= 50 characters
trans_date
required
string (Trans date) [ 1 .. 255 ] characters
pt_customer_email
string or null (Pt customer email) <= 255 characters
pt_customer_password
string or null (Pt customer password) <= 255 characters
pt_token
string or null (Pt token) <= 255 characters
secure_sign
string or null (Secure sign) <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payment_method_id": "string",
  • "transaction_id": "string",
  • "bkp_transaction_id_pt1": "string",
  • "account_id": "string",
  • "order_id": "string",
  • "response_code": "string",
  • "response_message": "string",
  • "customer_name": "string",
  • "customer_email": "string",
  • "transaction_amount": "string",
  • "transaction_currency": "string",
  • "customer_phone": "string",
  • "last_4_digits": "string",
  • "first_4_digits": "string",
  • "bin": "string",
  • "card_brand": "string",
  • "card_type": "string",
  • "local_network": "string",
  • "expiry_month": "st",
  • "expiry_year": "string",
  • "trans_date": "string",
  • "pt_customer_email": "string",
  • "pt_customer_password": "string",
  • "pt_token": "string",
  • "secure_sign": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

paytabs2_delete

Authorizations:
BasicBearer
path Parameters
id
required
string <uuid>

A UUID string identifying this billing detail.

Responses

plugin_configurations

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
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
{}

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
Request Body schema: application/json
required
key
required
string (Key) [ 1 .. 255 ] characters
value
required
object (Value)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
path Parameters
key
required
string
Request Body schema: application/json
required
value
required
object (Value)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
path Parameters
key
required
string
Request Body schema: application/json
required
value
required
object (Value)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": { }
}

Plugin configuration

Plugins configuration per tenant level. For instance per-tenant plugin configuration for payment gateway CyberSource (access_keys, test/live environment).

System will generate a TENANT_CONFIGURATION_UPDATED/TENANT_CONFIGURATION_DELETED event, and such event can be handled in the plugin to refresh it's configuration.

Authorizations:
BasicBearer
path Parameters
key
required
string

Responses

push-notifications

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:
BasicBearer
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
{}

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:
BasicBearer
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"
}

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:
BasicBearer
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"
}

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:
BasicBearer
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

push_notifications

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 tenant. Note that this can result in a large numbers of calls, basically everytime there is a state of changes for one of the Account in this tenant, such callback would be invoked.

In case the error, the system will retry the callback as defined by the system settings "billing.notifications.retries"

Authorizations:
BasicBearer
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
{}

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 tenant. Note that this can result in a large numbers of calls, basically everytime there is a state of changes for one of the Account in this tenant, such callback would be invoked.

In case the error, the system will retry the callback as defined by the system settings "billing.notifications.retries"

Authorizations:
BasicBearer
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"
}

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 tenant. Note that this can result in a large numbers of calls, basically everytime there is a state of changes for one of the Account in this tenant, such callback would be invoked.

In case the error, the system will retry the callback as defined by the system settings "billing.notifications.retries"

Authorizations:
BasicBearer
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"
}

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 tenant. Note that this can result in a large numbers of calls, basically everytime there is a state of changes for one of the Account in this tenant, such callback would be invoked.

In case the error, the system will retry the callback as defined by the system settings "billing.notifications.retries"

Authorizations:
BasicBearer
path Parameters
push_notification_id
required
string <uuid>

A UUID string identifying this push notification.

Responses

tap

tap_list

Authorizations:
BasicBearer
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": [
    ]
}

tap_create

Authorizations:
BasicBearer
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
internal_transaction_id
string or null (Internal transaction id) <= 255 characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
threeDSecure
boolean (ThreeDSecure)
save_card
boolean (Save card)
merchant_id
string or null (Merchant id) <= 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)
receipt_sms
boolean (Receipt sms)
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)
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "payment_method_id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

tap_payment_status

Authorizations:
BasicBearer
Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
internal_transaction_id
string or null (Internal transaction id) <= 255 characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
threeDSecure
boolean (ThreeDSecure)
save_card
boolean (Save card)
merchant_id
string or null (Merchant id) <= 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)
receipt_sms
boolean (Receipt sms)
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)
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "payment_method_id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

tap_read

Authorizations:
BasicBearer
path Parameters
id
required
string

A unique value identifying this payment detail.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "payment_method_id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

tap_update

Authorizations:
BasicBearer
path Parameters
id
required
string

A unique value identifying this payment detail.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
internal_transaction_id
string or null (Internal transaction id) <= 255 characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
threeDSecure
boolean (ThreeDSecure)
save_card
boolean (Save card)
merchant_id
string or null (Merchant id) <= 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)
receipt_sms
boolean (Receipt sms)
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)
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "payment_method_id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

tap_partial_update

Authorizations:
BasicBearer
path Parameters
id
required
string

A unique value identifying this payment detail.

Request Body schema: application/json
required
id
required
string (Id) [ 1 .. 255 ] characters
user_id
required
string (User id) [ 1 .. 255 ] characters
order_id
string or null (Order id) <= 255 characters
internal_transaction_id
string or null (Internal transaction id) <= 255 characters
amount
required
string (Amount) [ 1 .. 255 ] characters
currency
required
string (Currency) [ 1 .. 255 ] characters
threeDSecure
boolean (ThreeDSecure)
save_card
boolean (Save card)
merchant_id
string or null (Merchant id) <= 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)
receipt_sms
boolean (Receipt sms)
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)
account
string or null <uuid> (Account)
payment_method
string or null <uuid> (Payment method)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "payment_method_id": "string",
  • "user_id": "string",
  • "order_id": "string",
  • "internal_transaction_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": true,
  • "receipt_sms": true,
  • "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": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment_method": "f4815f3e-3832-4ed6-92fd-134ab34dea26"
}

tap_delete

Authorizations:
BasicBearer
path Parameters
id
required
string

A unique value identifying this payment detail.

Responses

tenants

tenants_list

Tenant

Authorizations:
BasicBearer
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": [
    ]
}

tenants_create

Tenant

Authorizations:
BasicBearer
Request Body schema: application/json
required
external_key
string or null (External key) <= 255 characters
name
required
string (Name) [ 1 .. 255 ] characters
client_key
required
string or null (Client key) <= 255 characters
client_secret
required
string or null (Client secret) <= 255 characters
url
string or null (Url) <= 255 characters
api_url
string or null (Api url) <= 255 characters
deleted_at
string or null <date-time> (Deleted at)

Responses

Request samples

Content type
application/json
{
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "url": "string",
  • "api_url": "string",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "url": "string",
  • "api_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

tenants_read

Tenant

Authorizations:
BasicBearer
path Parameters
tenant_id
required
string <uuid>

A UUID string identifying this tenant.

Responses

Response samples

Content type
application/json
{
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "external_key": "string",
  • "name": "string",
  • "client_key": "string",
  • "client_secret": "string",
  • "url": "string",
  • "api_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

tenants_delete

Tenant

Authorizations:
BasicBearer
path Parameters
tenant_id
required
string <uuid>

A UUID string identifying this tenant.

Responses

transactions

API endpoint that allow access to payment transactions. Transaction belong to a Payment object.

They represent a payment operation.

Authorizations:
BasicBearer
query Parameters
external_key
string

external_key

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 endpoint that allow access to payment transactions. Transaction belong to a Payment object.

They represent a payment operation.

Authorizations:
BasicBearer
path Parameters
transaction_id
required
string <uuid>

A UUID string identifying this transaction.

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "external_key": "string",
  • "payment_external_key": "string",
  • "amount": "string",
  • "currency": "USD",
  • "processed_amount": "string",
  • "processed_currency": "USD",
  • "processed_amount_raw": "string",
  • "processed_currency_raw": "USD",
  • "type": "string",
  • "status": "string",
  • "gateway_response_status": "string",
  • "gateway_response_code": "string",
  • "gateway_response_message": "string",
  • "spotii_response_code": "string",
  • "spotii_response_reason": "string",
  • "refference_id": "string",
  • "redirect_url": "string",
  • "redirect_params": { },
  • "redirect_method": "string",
  • "plugin_properties": { },
  • "effective_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "payment": "4f07e784-b611-49dd-affc-3320a4f95555",
  • "tenant": "93360892-48a4-4f76-a117-3304c9c61771"
}

vgs

vgs_list

The installments resource manage installments.

Authorizations:
BasicBearer
query Parameters
page
integer

A page number within the paginated result set.

per_page
integer

Number of results to return per page.

Responses

vgs_create

The installments resource manage installments.

Authorizations:
BasicBearer

Responses

vgs_read

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
external_key
required
string

Responses

vgs_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
external_key
required
string

Responses

vgs_partial_update

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
external_key
required
string

Responses

vgs_add_card

The installments resource manage installments.

Authorizations:
BasicBearer
path Parameters
external_key
required
string

Responses