PayUp Merchant Admin API (1.0.0)

Download OpenAPI specification:Download

Administrative API used by the PayUp merchant dashboard. All routes live under /api/merchant/v1.

Authentication

Except for the explicitly public endpoints (register, login, currency reads/conversion, and gateway request webhooks), every endpoint requires a merchant JWT passed as Authorization: Bearer <jwt>. Obtain the JWT from POST /auth/login or POST /auth/register.

Auth

Register a merchant user

Request Body schema: application/json

email required	string <email>
password required	string >= 8 characters
name required	string non-empty
company	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "stringst",
"name": "string",
"company": "string"
}

Response samples

201
400

Content type

application/json

{"user": {"id": "string",
"email": "user@example.com",
"name": "string",
"companyName": "string",
"isActive": true,
"paymentMode": "string",
"settings": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"token": "string"
}

Log in

Request Body schema: application/json

email required	string <email>
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "string"
}

Response samples

200
401

Content type

application/json

{"user": {"id": "string",
"email": "user@example.com",
"name": "string",
"companyName": "string",
"isActive": true,
"paymentMode": "string",
"settings": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"token": "string"
}

Get the current user profile

Authorizations:

MerchantJwt

Responses

Response samples

200
401

Content type

application/json

{"id": "string",
"email": "user@example.com",
"name": "string",
"companyName": "string",
"isActive": true,
"paymentMode": "string",
"settings": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update the current user profile

Authorizations:

MerchantJwt

Request Body schema: application/json

name	string
companyName	string
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"companyName": "string",
"settings": { }
}

Response samples

200

Content type

application/json

{"id": "string",
"email": "user@example.com",
"name": "string",
"companyName": "string",
"isActive": true,
"paymentMode": "string",
"settings": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Issue a fresh JWT

Requires a currently valid Bearer JWT.

Authorizations:

MerchantJwt

Responses

Response samples

200
401

Content type

application/json

{"user": {"id": "string",
"email": "user@example.com",
"name": "string",
"companyName": "string",
"isActive": true,
"paymentMode": "string",
"settings": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"token": "string"
}

Apps

List the user's apps

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true,
"id": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Create an app

Authorizations:

MerchantJwt

Request Body schema: application/json

name required	string
description	string
webhookUrl	string or null <uri>
brandName	string
brandLogo	string or null <uri>
showProducts	boolean
showCurrencySelector	boolean
showTaxElement	boolean
showCustomerElement	boolean
showAddressElement	boolean
showShipping	boolean
showPayment	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true
}

Response samples

201
400

Content type

application/json

{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true,
"id": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200
404

Content type

application/json

{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true,
"id": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Request Body schema: application/json

name required	string
description	string
webhookUrl	string or null <uri>
brandName	string
brandLogo	string or null <uri>
showProducts	boolean
showCurrencySelector	boolean
showTaxElement	boolean
showCustomerElement	boolean
showAddressElement	boolean
showShipping	boolean
showPayment	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"webhookUrl": "http://example.com",
"brandName": "string",
"brandLogo": "http://example.com",
"showProducts": true,
"showCurrencySelector": true,
"showTaxElement": true,
"showCustomerElement": true,
"showAddressElement": true,
"showShipping": true,
"showPayment": true,
"id": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

API Keys

List masked API keys for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

[{"environment": "sandbox",
"publicKey": "string",
"secretKeyMasked": "sk_live_...a1b2",
"status": "active",
"lastUsedAt": "2019-08-24T14:15:22Z",
"lastRotatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
]

Rotate the key pair for an environment

Authorizations:

MerchantJwt

path Parameters

appId required	string
environment required	string (Environment) Enum: "sandbox" "live"

Responses

Response samples

200

Content type

application/json

{"message": "string",
"environment": "sandbox",
"publicKey": "string",
"secretKey": "string",
"secretKeyPrefix": "string",
"secretKeyLast4": "string"
}

Products

Create a product

Authorizations:

MerchantJwt

Request Body schema: application/json

appId required	string
title required	string
price required	number > 0
sku	string
currency	string
description	string
media	Array of strings
category	string
compareAtPrice	number
unitPrice	number
chargeTax	boolean
costPerItem	number
status	string Enum: "active" "draft" "archived"
quantity	integer
	object
	object
	Array of objects
	object

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { }
}

Response samples

201
400

Content type

application/json

{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { },
"id": "string",
"storeCode": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List products for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

[{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { },
"id": "string",
"storeCode": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Get a product

Authorizations:

MerchantJwt

path Parameters

productId

required

string

Responses

Response samples

200
404

Content type

application/json

{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { },
"id": "string",
"storeCode": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update a product

Authorizations:

MerchantJwt

path Parameters

productId

required

string

Request Body schema: application/json

appId required	string
title required	string
price required	number > 0
sku	string
currency	string
description	string
media	Array of strings
category	string
compareAtPrice	number
unitPrice	number
chargeTax	boolean
costPerItem	number
status	string Enum: "active" "draft" "archived"
quantity	integer
	object
	object
	Array of objects
	object

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { }
}

Response samples

200

Content type

application/json

{"appId": "string",
"title": "string",
"price": 0,
"sku": "string",
"currency": "string",
"description": "string",
"media": ["string"
],
"category": "string",
"compareAtPrice": 0,
"unitPrice": 0,
"chargeTax": true,
"costPerItem": 0,
"status": "active",
"quantity": 0,
"inventory": { },
"shipping": { },
"variants": [{ }
],
"seo": { },
"id": "string",
"storeCode": "string",
"userId": "string",
"isActive": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete a product

Authorizations:

MerchantJwt

path Parameters

productId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true
}

Transactions

List payment sessions

Authorizations:

MerchantJwt

query Parameters

page	integer Default: 1
limit	integer Default: 50

Responses

Response samples

200

Content type

application/json

{"sessions": [{"id": "string",
"sessionId": "string",
"amount": 0,
"currency": "string",
"customerEmail": "string",
"customerName": "string",
"products": [{"sku": "string",
"title": "string",
"price": 0,
"currency": "string",
"quantity": 0,
"productId": "string",
"sessionPrice": 0
}
],
"status": "string",
"gateway": "string",
"description": "string",
"redirectUrl": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}
}

Get payment session details

Authorizations:

MerchantJwt

path Parameters

sessionId

required

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"sessionId": "string",
"amount": 0,
"currency": "string",
"customerEmail": "string",
"customerName": "string",
"products": [{"sku": "string",
"title": "string",
"price": 0,
"currency": "string",
"quantity": 0,
"productId": "string",
"sessionPrice": 0
}
],
"status": "string",
"gateway": "string",
"description": "string",
"redirectUrl": "string",
"expiresAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"returnUrl": "string",
"cancelUrl": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"providerPaymentId": "string",
"gatewayTransactionId": "string",
"error": { }
}

Customers

Create a customer

Authorizations:

MerchantJwt

Request Body schema: application/json

appId required	string
firstName	string
lastName	string
email	string <email>
mobile	string
language	string
	object
	object
notes	string
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
]
}

Response samples

201

Content type

application/json

{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
],
"id": "string",
"userId": "string",
"sessionIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

List customers for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

[{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
],
"id": "string",
"userId": "string",
"sessionIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Get a customer

Authorizations:

MerchantJwt

path Parameters

customerId

required

string

Responses

Response samples

200
404

Content type

application/json

{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
],
"id": "string",
"userId": "string",
"sessionIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Update a customer

Authorizations:

MerchantJwt

path Parameters

customerId

required

string

Request Body schema: application/json

appId required	string
firstName	string
lastName	string
email	string <email>
mobile	string
language	string
	object
	object
notes	string
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
]
}

Response samples

200

Content type

application/json

{"appId": "string",
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"mobile": "string",
"language": "string",
"defaultAddress": { },
"marketingPreferences": { },
"notes": "string",
"tags": ["string"
],
"id": "string",
"userId": "string",
"sessionIds": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete a customer

Authorizations:

MerchantJwt

path Parameters

customerId

required

string

Responses

Response samples

200

Content type

application/json

{"message": "string"
}

Customer payment history

Authorizations:

MerchantJwt

path Parameters

customerId

required

string

query Parameters

page	integer Default: 1
limit	integer Default: 10

Responses

Response samples

200

Content type

application/json

{"payments": [{ }
],
"total": 0,
"page": 0,
"limit": 0,
"totalPages": 0
}

Gateways

List the global gateway catalog

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

{"gateways": [{"name": "string",
"enabled": true,
"displayName": "string",
"description": "string"
}
]
}

List gateways with their available currencies

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

{"gateways": [{"name": "string",
"enabled": true,
"availableCurrencies": ["string"
]
}
]
}

List an app's configured gateways

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{"gateways": [{"id": "string",
"appId": "string",
"name": "string",
"config": { },
"defaultCurrency": "string",
"acceptedCurrencies": ["string"
],
"isDefault": true,
"isActive": true
}
]
}

Configure a gateway for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Request Body schema: application/json

name required	string Enum: "paypal" "stripe" "moyasar" "myfatoorah"
required	object
defaultCurrency	string = 3 characters
acceptedCurrencies	Array of strings
isDefault	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "paypal",
"config": { },
"defaultCurrency": "str",
"acceptedCurrencies": ["string"
],
"isDefault": false
}

Response samples

201

Content type

application/json

{"id": "string",
"appId": "string",
"name": "string",
"config": { },
"defaultCurrency": "string",
"acceptedCurrencies": ["string"
],
"isDefault": true,
"isActive": true
}

Update an app gateway

Authorizations:

MerchantJwt

path Parameters

appId required	string
gatewayId required	string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"id": "string",
"appId": "string",
"name": "string",
"config": { },
"defaultCurrency": "string",
"acceptedCurrencies": ["string"
],
"isDefault": true,
"isActive": true
}

Delete an app gateway

Authorizations:

MerchantJwt

path Parameters

appId required	string
gatewayId required	string

Responses

Response samples

200

Content type

application/json

{"success": true
}

Gateway Requests

List gateway onboarding requests

Authorizations:

MerchantJwt

query Parameters

status	string
gateway	string

Responses

Response samples

200

Content type

application/json

{"requests": [{ }
]
}

Create a gateway onboarding request

Authorizations:

MerchantJwt

Request Body schema: application/json

gateway required	string
	object
	object
website	string
	object
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"gateway": "string",
"customer": { },
"company": { },
"website": "string",
"gatewayExtra": { },
"attachments": [{ }
]
}

Response samples

201

Content type

application/json

{ }

Get a gateway request

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

200
404

Content type

application/json

{ }

Update a draft gateway request

Authorizations:

MerchantJwt

path Parameters

id

required

string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Submit a gateway request

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{ }

Update request status (admin only)

Authorizations:

MerchantJwt

path Parameters

id

required

string

Request Body schema: application/json

status

string

Responses

Request samples

Payload

Content type

application/json

{"status": "string"
}

Response samples

403

Content type

application/json

{"error": "string",
"message": "string"
}

Add corrections to a request (admin only)

Authorizations:

MerchantJwt

path Parameters

id

required

string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

403

Content type

application/json

{"error": "string",
"message": "string"
}

Forward a request to the gateway (admin only)

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json

{"error": "string",
"message": "string"
}

Gateway Rules

List gateway routing rules

Authorizations:

MerchantJwt

query Parameters

appId required	string
environment	string (Environment) Enum: "sandbox" "live"

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Create a gateway routing rule

Authorizations:

MerchantJwt

Request Body schema: application/json

appId required	string
name required	string
ruleType required	string
required	Array of objects
preferredGateway required	string
environment required	string (Environment) Enum: "sandbox" "live"

Responses

Request samples

Payload

Content type

application/json

{"appId": "string",
"name": "string",
"ruleType": "string",
"conditions": [{ }
],
"preferredGateway": "string",
"environment": "sandbox"
}

Response samples

201

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Get a gateway rule

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Update a gateway rule

Authorizations:

MerchantJwt

path Parameters

id

required

string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Delete a gateway rule

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Toggle a gateway rule active state

Authorizations:

MerchantJwt

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Seed default gateway rules

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Test gateway rule matching

Authorizations:

MerchantJwt

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"success": true,
"data": null,
"message": "string",
"error": "string"
}

Gateway Request Webhooks

Provider webhook for gateway request status

path Parameters

provider

required

string

Enum: "stripe" "paypal" "moyasar" "myfatoorah"

Request Body schema: application/json

externalId required	string
status required	string Enum: "approved" "rejected" "pending" "live"
encryptedSecrets	string

Responses

Request samples

Payload

Content type

application/json

{"externalId": "string",
"status": "approved",
"encryptedSecrets": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"request": { }
}

Reports

Dashboard statistics

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

{ }

List all of the user's tokens

Authorizations:

MerchantJwt

Responses

Response samples

200

Content type

application/json

[{ }
]

Tokens

Create an SDK/client token

Authorizations:

MerchantJwt

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

List tokens for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

[{ }
]

Update a token

Authorizations:

MerchantJwt

path Parameters

tokenId

required

string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Delete a token

Authorizations:

MerchantJwt

path Parameters

tokenId

required

string

Responses

Revoke a token

Authorizations:

MerchantJwt

path Parameters

tokenId

required

string

Responses

Add an allowed domain to a token

Authorizations:

MerchantJwt

path Parameters

tokenId

required

string

Request Body schema: application/json

domain

string

Responses

Request samples

Payload

Content type

application/json

{"domain": "string"
}

Remove an allowed domain from a token

Authorizations:

MerchantJwt

path Parameters

tokenId required	string
domain required	string URL-encoded domain.

Responses

Currencies

List currencies

Responses

Response samples

200

Content type

application/json

[{"code": "USD",
"name": "string",
"symbol": "string"
}
]

Create a currency

Authorizations:

MerchantJwt

Request Body schema: application/json

code	string
name	string
symbol	string

Responses

Request samples

Payload

Content type

application/json

{"code": "USD",
"name": "string",
"symbol": "string"
}

Response samples

201

Content type

application/json

{"code": "USD",
"name": "string",
"symbol": "string"
}

Get a currency by ISO code

path Parameters

code

required

string

Example: USD

Responses

Response samples

200
404

Content type

application/json

{"code": "USD",
"name": "string",
"symbol": "string"
}

Update a currency

Authorizations:

MerchantJwt

path Parameters

code

required

string

Example: USD

Request Body schema: application/json

code	string
name	string
symbol	string

Responses

Request samples

Payload

Content type

application/json

{"code": "USD",
"name": "string",
"symbol": "string"
}

Response samples

200

Content type

application/json

{"code": "USD",
"name": "string",
"symbol": "string"
}

Convert an amount for a gateway

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Get a gateway's default currency

path Parameters

gatewayId

required

string

Responses

Response samples

200

Content type

application/json

{ }

Get a gateway's accepted currencies

path Parameters

gatewayId

required

string

Responses

Response samples

200

Content type

application/json

{ }

Validate a currency for a gateway

path Parameters

gatewayId

required

string

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Domain Verification

Generate a domain verification file

Authorizations:

MerchantJwt

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Verify domain ownership

Authorizations:

MerchantJwt

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

List verified domains for an app

Authorizations:

MerchantJwt

path Parameters

appId

required

string

Responses

Response samples

200

Content type

application/json

{ }

Check whether a domain is verified

Authorizations:

MerchantJwt

Request Body schema: application/json

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Libraries

List libraries

Authorizations:

MerchantJwt

query Parameters

activeOnly

boolean

Default: true

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}
]

Create a library

Authorizations:

MerchantJwt

Request Body schema: application/json

id	string
identifier	string
name	string
description	string
scopes	Array of strings
modules	Array of strings
isActive	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}

Response samples

201

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}

Get a library

Authorizations:

MerchantJwt

path Parameters

libraryId

required

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}

Update a library

Authorizations:

MerchantJwt

path Parameters

libraryId

required

string

Request Body schema: application/json

id	string
identifier	string
name	string
description	string
scopes	Array of strings
modules	Array of strings
isActive	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}

Response samples

200

Content type

application/json

{"id": "string",
"identifier": "string",
"name": "string",
"description": "string",
"scopes": ["string"
],
"modules": ["string"
],
"isActive": true
}

Delete a library

Authorizations:

MerchantJwt

path Parameters

libraryId

required

string

Responses

Media

Upload a media file

Authorizations:

MerchantJwt

Request Body schema: multipart/form-data

file required	string <binary>
appId required	string

Responses

Response samples

201

Content type

application/json

{"id": "string",
"appId": "string",
"url": "string",
"type": "string",
"fileName": "string",
"size": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

List media

Authorizations:

MerchantJwt

query Parameters

appId required	string
type	string

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"appId": "string",
"url": "string",
"type": "string",
"fileName": "string",
"size": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
]

Get media metadata

Authorizations:

MerchantJwt

path Parameters

mediaId

required

string

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"appId": "string",
"url": "string",
"type": "string",
"fileName": "string",
"size": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Delete media

Authorizations:

MerchantJwt

path Parameters

mediaId

required

string