Payment-Gateway Service

Download OpenAPI specification:Download

E-mail: documentation@emporix.com

The Emporix API Payment-Gateway Service allows you to manage your payment methods.

Key Features:

Create payment strategies
Configure payment methods per site
Get transaction logs
Enable refunds and cancellation
Capture payments

Key Benefits:

Simplify payment processes
React quickly to market needs and integrate with any payment provider
Give your customers the choice of their payment methods
Have an overview of transaction history

Payment

Authorizing a payment

Authorizes a given payment.

Required scopes

payment-gateway.authorize_manage

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Request Body schema: application/json

amountToAuthorize	number Amount that should be authorized.
currency	string Currency for the amount that should be authorized.
threeDSToken	string Contains a token generated during the 3DS authentication process.
browserInfo	string Holds information related to the user's web browser.
clientIP	string Stores the Internet Protocol (IP) address of the client or user making a request or transaction.
	object
paymentModeId	string Identifier of a payment mode configured in the payment-gateway service for a given tenant.
creditCardToken	string Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.

Responses

200

Payment authorized

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/authorize

Request samples

application/json

{"amountToAuthorize": 0,
"currency": "string",
"threeDSToken": "string",
"browserInfo": "string",
"clientIP": "string",
"order": {"id": "string"
},
"paymentModeId": "string",
"creditCardToken": "string"
}

Response samples

application/json

{"successful": true,
"paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
"requiresExternalPayment": true,
"externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
"externalPaymentParameters": { }
}

Capturing a payment

Creates a flow to capture a given payment transaction. The capture operation requires transactionId, thus it can be invoked only if the payment had been previously authorized.

Required scopes

payment-gateway.capture_manage

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
transactionId required	string Unique identifier of a payment transaction.

Request Body schema: application/json

amount	number Amount that should be captured. The amount should not be greater than amount that was authorized.
currency	string Currency for the amount that should be captured.

Responses

200

Payment capture response

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/{transactionId}/capture

Request samples

application/json

{"amount": 3.99,
"currency": "EUR"
}

Response samples

application/json

{"successful": true,
"message": "string",
"captureId": "string"
}

Refunding a payment

Creates a flow to return a given payment. The refund operation requires transactionId, thus it can be invoked only if the payment has been authorized and captured previously.

Required scopes

payment-gateway.refund_manage

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
transactionId required	string Unique identifier of a payment transaction.

Request Body schema: application/json

amount	number Amount that should be refunded. The amount should not be greater than amount that was captured.
currency	string Currency for the amount that should be refunded.
captureId	string Capture identifier. The value is mandatory only if there were more captures for a payment and the refund should be related to a specific capture. In another case the value can be skipped and the capture related to the payment will be chosen automatically.

Responses

200

Payment transaction response

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/{transactionId}/refund

Request samples

application/json

{"amount": 3.99,
"currency": "EUR"
}

Response samples

application/json

{"successful": true,
"message": "Success!"
}

Cancelling a payment

Creates a flow to cancel a given payment transaction. The cancel operation requires transactionId, thus it can be invoked only if the payment has been authorized previously.

Required scopes

payment-gateway.cancel_manage

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
transactionId required	string Unique identifier of a payment transaction.

Responses

200

Payment transaction response

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/{transactionId}/cancel

Request samples

Response samples

application/json

{"successful": true,
"message": "Success!"
}

Payment mode

Creating a single payment mode entity

Creates a new payment mode for a given tenant. Currently the service supports the following payment methods:

Payment methods supported by Spreedly: https://docs.spreedly.com/reference/supported-gateways/
Saferpay: https://docs.saferpay.com/home/interfaces/payment-api
Unzer Invoice: https://docs.unzer.com/payment-methods/unzer-invoice-upl/

Required scopes

payment-gateway.paymentmodes_manage

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Request Body schema: application/json

code required	string Indicates a code of a given method.
active	boolean Indicates whether a give mode is active.
provider required	string Indicates which provider should be used. Enum: "INVOICE" "CASH_ON_DELIVERY" "SPREEDLY" "SPREEDLY_SAFERPAY" "UNZER"
	object Map of configuration values for a particular gateway. Supported and required values for Spreedly: `Spreedly/GatewayToken` - Indicates Spreedly gateway. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`. `Spreedly/EnvironmentKey` - Indicates Spreedly environment key. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`. `Spreedly/AccessSecret` - Indicates Spreedly access secret. Valid for `SPREEDLY`, `SPREEDLY_SAFERPAY`. `Spreedly/PaymentMethodType` - Indicates payment method type, for example: paypal. Valid for `SPREEDLY`. `Spreedly/RedirectURL` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL. Valid for `SPREEDLY`. `Spreedly/SignatureSecret` - Indicates a signature secret. The value is needed for an offsite flow, when a confirmation callback is used. Valid for `SPREEDLY`. `Spreedly/SCAProviderToken` - Indicates the Spreedly SCA (Strong Customer Authentication) provider token (3DS credit cart). Valid for `SPREEDLY`. `Spreedly/ReceiverId` - Indicates the Spreedly Receiver identifier. Valid for `SPREEDLY_SAFERPAY`. `Saferpay/BasicAuth` - Base64 encoded username and password of Saferpay account. Valid for `SPREEDLY_SAFERPAY`. `Saferpay/CustomerId` - Saferpay customer ID. Valid for `SPREEDLY_SAFERPAY`. `Saferpay/TerminalId` - Saferpay terminal ID. Valid for `SPREEDLY_SAFERPAY`. `Saferpay/TestEnvironment` - Indicates if the configuration is done for test environment or a production one. If `true` then `https://test.saferpay.com` is used as a destination. Otherwise `https://www.saferpay.com` is used. Valid for `SPREEDLY_SAFERPAY`. `Saferpay/RedirectUrl` - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL. Valid for `SPREEDLY_SAFERPAY`. `Unzer/PaymentMethodType` - Indicates a payment method type. Currently supported value is `PAYLATER_INVOICE`. Valid for `UNZER`. `Unzer/PublicKey` - Indicates a Unzer public key. Valid for `UNZER`. `Unzer/PrivateKey` - Indicates a Unzer private key. Valid for `UNZER`. `Unzer/CustomerType` - Indicates a customer type. Currently supported value is `B2C`. Valid for `UNZER`. requestBodies: { }

Responses

200

Payment mode configured in the payment-gateway service for a given tenant.

400

Bad request. The syntax of the request is incorrect.

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

409

Conflict. The resource already exists.

500

Internal Server Error.

post/{tenant}/paymentmodes/config

Request samples

application/json

{"code": "paypal",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "KnQsG1FFJjfcKEUt5ObMilP2Rs4",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU5b9OKuxz",
"Spreedly/AccessSecret": "ZrvF6kkV4KgapqzXzR67SsTR4PMbCGTnXLMasskAXKWePSOgnU3XO4EpIvIPUDcF",
"Spreedly/PaymentMethodType": "paypal",
"Spreedly/RedirectURL": "https://storefront.emporix.io/exmporix/my-account/my-orders",
"Spreedly/SignatureSecret": "_eJMkqevWxAdq9qOyA7fjnfCseO7gIaG28rSRBHKJVeKHM6i_Uqt6fGa_cWhzGvc"
}
}

Response samples

application/json

{"id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
"code": "credit_card",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/PaymentMethodType": "credit_card",
"Spreedly/RedirectURL": "https://example.com",
"Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
}
}

Retrieving a list of payment modes

Retrieves a list of configured payment modes for a given tenant.

Required scopes

payment-gateway.paymentmodes_read

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Responses

200

Get all payment modes configured in the payment-gateway service for a given tenant.

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

500

Internal Server Error.

get/{tenant}/paymentmodes/config

Request samples

Response samples

[{"id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
"code": "credit_card",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/PaymentMethodType": "credit_card",
"Spreedly/RedirectURL": "https://example.com",
"Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
}
},
{"id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5324",
"code": "sprel",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/SignatureSecret": "_eJMkqevWxXcq6qOyA1fjnfCseO7gISG28rSRBHKJVeKHM6i_Pqt6fGa_cWhzGvc",
"Spreedly/PaymentMethodType": "sprel",
"Spreedly/RedirectURL": "https://storefront.emporix.io/emporix/payment-callback"
}
},
{"id": "ef48f439-1c2c-42ff-807d-ed4cac287741",
"code": "paypal",
"siteCode": "main",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/PaymentMethodType": "paypal",
"Spreedly/RedirectURL": "https://storefront.emporix.io/emporix/payment-callback",
"Spreedly/SignatureSecret": "_eJMkqevWxXcq9qOyA7fjnfCseO7gISG28rSRBHKPVeKDM6i_Uqt6fGa_cWhzGvc"
}
}
]

Retrieving a single payment mode

Retrieves a single payment mode configuration for a given tenant based on a payment mode identifier.

Required scopes

payment-gateway.paymentmodes_read

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
id required	string Unique identifier of a payment mode.

Responses

200

Payment mode configured in the payment-gateway service for a given tenant.

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

500

Internal Server Error.

get/{tenant}/paymentmodes/config/{id}

Request samples

Response samples

application/json

{"id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
"code": "credit_card",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/PaymentMethodType": "credit_card",
"Spreedly/RedirectURL": "https://example.com",
"Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
}
}

Updating a single payment mode

Updates a single payment mode for a given tenant based on a unique mode identifier.

Required scopes

payment-gateway.paymentmodes_manage

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
id required	string Unique identifier of a payment mode.

Request Body schema: application/json

active

boolean

Indicates whether a give mode is active.

object

Map of configuration values for a particular gateway. Supported and required values for Spreedly:

Spreedly/GatewayToken - Indicates Spreedly gateway.
Spreedly/EnvironmentKey - Indicates Spreedly environment key.
Spreedly/AccessSecret - Indicates Spreedly access secret.
Spreedly/PaymentMethodType - Indicates payment method type, for example: paypal.
Spreedly/RedirectURL - Indicates a redirect URL where an end user should be redirected when a payment flow is finished. Usually it's a storefront URL.
Spreedly/SignatureSecret - Indicates a signature secret. The value is needed for an offsite flow, when a confirmation callback is used.
Spreedly/SCAProviderToken - Indicates the Spreedly SCA (Strong Customer Authentication) provider token (3DS credit cart). requestBodies: { }

Responses

200

Payment mode configured in the payment-gateway service for a given tenant.

400

Bad request. The syntax of the request is incorrect.

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

500

Internal Server Error.

put/{tenant}/paymentmodes/config/{id}

Request samples

application/json

{"active": true,
"configuration": {"Spreedly/GatewayToken": "KnQsG1FFJjfcKEUt5ObMilP2Rs4",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU5b9OKuxz",
"Spreedly/AccessSecret": "ZrvF6kkV4KgapqzXzR67SsTR4PMbCGTnXLMasskAXKWePSOgnU3XO4EpIvIPUDcF",
"Spreedly/PaymentMethodType": "paypal",
"Spreedly/RedirectURL": "https://storefront.emporix.io/exmporix/my-account/my-orders",
"Spreedly/SignatureSecret": "_eJMkqevWxAdq9qOyA7fjnfCseO7gIaG28rSRBHKJVeKHM6i_Uqt6fGa_cWhzGvc"
}
}

Response samples

application/json

{"id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
"code": "credit_card",
"active": true,
"provider": "SPREEDLY",
"configuration": {"Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
"Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
"Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
"Spreedly/PaymentMethodType": "credit_card",
"Spreedly/RedirectURL": "https://example.com",
"Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
}
}

Deleting a single payment mode

Deletes a single payment mode for a given tenant based on a unique mode identifier.

Required scopes

payment-gateway.paymentmodes_manage

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
id required	string Unique identifier of a payment mode.

Responses

200

400

Bad request. The syntax of the request is incorrect.

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

500

Internal Server Error.

delete/{tenant}/paymentmodes/config/{id}

Request samples

Response samples

application/json

{"code": 400,
"timestamp": "2023-10-03T12:23:31.485306Z",
"message": "The syntax of the request is incorrect."
}

Payment - frontend

Initializing a payment

Initializes a payment by accepting a request sent from the frontend.

Required scopes

No scope is required

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Request Body schema: application/json

	object
paymentModeId	string Identifier of a payment mode configured in the payment-gateway service for a given tenant.
creditCardToken	string Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.

Responses

200

Payment initialized

400

Bad request. The syntax of the request is incorrect.

401

Unauthorized

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/frontend/initialize

Request samples

application/json

{"order": {"id": "string"
},
"paymentModeId": "string",
"creditCardToken": "string"
}

Response samples

application/json

{"successful": true,
"paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
"externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
"externalPaymentParameters": { }
}

Authorizing a payment

Authorize a payment by accepting a request sent from the frontend.

Required scopes

No scope is required

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Request Body schema: application/json

threeDSToken	string Contains a token generated during the 3DS authentication process.
browserInfo	string Holds information related to the user's web browser.
clientIP	string Stores the Internet Protocol (IP) address of the client or user making a request or transaction.
	object
paymentModeId	string Identifier of a payment mode configured in the payment-gateway service for a given tenant.
creditCardToken	string Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.

Responses

200

Payment authorized

400

Bad request. The syntax of the request is incorrect.

401

Unauthorized

422

Unprocessable Entity. The payment action is not supported.

500

Internal Server Error.

post/{tenant}/payment/frontend/authorize

Request samples

application/json

{"threeDSToken": "string",
"browserInfo": "string",
"clientIP": "string",
"order": {"id": "string"
},
"paymentModeId": "string",
"creditCardToken": "string"
}

Response samples

application/json

{"successful": true,
"paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
"requiresExternalPayment": true,
"externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
"externalPaymentParameters": { }
}

Payment mode - frontend

Retrieving all the payment modes

Retrieves a list of configured payment modes for a given tenant with publicly available properties (excluding all secrets, signatures etc). The endpoint should be used by a frontend application to fetch all the possible payment methods configured for a particular tenant.

Required scopes

No scope is required

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Responses

200

Payment modes configured in the payment-gateway service for a given tenant that returns only properties publicly available.

401

Unauthorized

get/{tenant}/paymentmodes/frontend

Request samples

Response samples

application/json

[{"id": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
"code": "credit_card",
"integrationType": "TOKENIZED",
"javascriptUrl": "https://core.spreedly.com/iframe/iframe-v1.min.js",
"paymentMethodType": "credit_card",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
},
{"id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5374",
"code": "sprel",
"integrationType": "OFFSITE",
"paymentMethodType": "sprel",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
},
{"id": "ef48f439-1c3c-42ff-807d-ef4cac237745",
"code": "paypal",
"integrationType": "OFFSITE",
"paymentMethodType": "paypal",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
}
]

Retrieving a single payment mode

Retrieves a single payment mode for a given tenant with publicly available properties (excluding all secrets, signatures etc). The endpoint should be used by a frontend application to fetch a payment method configuration for a particular tenant.

Required scopes

No scope is required

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
id required	string Unique identifier of a payment mode.

Responses

200

Payment modes configured in the payment-gateway service for a given tenant that returns only properties publicly available.

401

Unauthorized

404

Not found. The resource does not exist.

get/{tenant}/paymentmodes/frontend/{id}

Request samples

Response samples

application/json

[{"id": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
"code": "credit_card",
"integrationType": "TOKENIZED",
"javascriptUrl": "https://core.spreedly.com/iframe/iframe-v1.min.js",
"paymentMethodType": "credit_card",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
},
{"id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5374",
"code": "sprel",
"integrationType": "OFFSITE",
"paymentMethodType": "sprel",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
},
{"id": "ef48f439-1c3c-42ff-807d-ef4cac237745",
"code": "paypal",
"integrationType": "OFFSITE",
"paymentMethodType": "paypal",
"environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
}
]

Transaction

Retrieving many transactions

Retrieves many payment transactions. A particular transaction contains all transactions' events attached as an entries of the response body.

Required scopes

payment-gateway.paymenttransactions_read

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

query Parameters

pageNumber	integer >= 1 Default: 1 The page number to be retrieved, where the size of the pages is specified by the `pageSize` parameter. The number of the first page is 1.
pageSize	integer [ 1 .. 50 ] Default: 50 The number of documents being retrieved on one page.
sort	string Fields to sort the response data by following the order of the parameters from left to right. Can contain multiple fields in the following format: `field name:sort direction`, separated by a comma. The colon preceding the `sort direction` parameter is optional, and the descending order is taken only if it is equal to `desc` or `DESC`. The ascending order is assumed in any other case. Example: sort=sort=name,metadata.createdAt:desc

header Parameters

X-Total-Count

boolean

To get information how many entities meet the filtering requirements, the X-Total-Count header has been introduced. The header is optional and its default value is false. If the header is provided and it is set to true, then the total count is returned in the X-Total-Count response header. In both cases (X-Total-Count true, false or not provided), the response body has the same format (array of entities). This means that the information about the total count is returned only on demand, provided that the X-Total-Count header is present in a request.

Responses

200

Payment transactions response

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

500

Internal Server Error.

get/{tenant}/transactions

Request samples

Response samples

application/json

[{"id": "d8abfb12-0266-43dc-905e-415158029d45",
"provider": "SPREEDLY",
"paymentInformation": {"paymentMode": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
"creditCardToken": "FrHVCFtcshQ8gkOR8t5RlneLy02"
},
"entries": [{"id": "5ab6f875-5414-4845-afe9-8976531a2573",
"createdDate": "2023-07-02T09:19:42.170Z",
"type": "AUTHORIZATION",
"successful": true,
"amount": {"amount": 36.63,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"transaction\" : {\n    \"amount\" : 3663,\n    \"payment_method_token\" : \"O7z9EVXYwzzxgQO78nobou22ET1\",\n    \"currency_code\" : \"EUR\",\n    \"order_id\" : \"EON1562\",\n    \"retain_on_success\" : false\n  }\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"FrHVCFtcshQ8gkOR8t5RlneLy02\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful authorize\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:19:42Z\",\n      \"updated_at\" : \"2023-07-02T09:19:42Z\"\n    },\n    \"state\" : \"succeeded\",\n    \"retained\" : false,\n    \"amount\" : \"3663\",\n    \"gateway_transaction_id\" : \"48\",\n    \"created_at\" : \"2023-07-02T09:19:42Z\",\n    \"updated_at\" : \"2023-07-02T09:19:42Z\",\n    \"transaction_type\" : \"Authorization\",\n    \"order_id\" : \"EON1562\",\n    \"gateway_token\" : \"5xGx9vcZlMe1AVuHQk00CZTS8YM\",\n    \"currency_code\" : \"EUR\",\n    \"shipping_address\" : {\n      \"name\" : \"John Smith\"\n    },\n    \"payment_method\" : {\n      \"token\" : \"O7z9EVXYwzzxgQO78nobou22ET1\",\n      \"test\" : true,\n      \"month\" : 9,\n      \"year\" : 2023,\n      \"number\" : \"XXXX-XXXX-XXXX-1111\",\n      \"fingerprint\" : \"78250e7a0b53b34f526fbf99be66982e1127\",\n      \"created_at\" : \"2023-07-02T09:19:39Z\",\n      \"updated_at\" : \"2023-07-02T09:19:39Z\",\n      \"storage_state\" : \"cached\",\n      \"last_four_digits\" : \"1111\",\n      \"first_name\" : \"John\",\n      \"last_name\" : \"Smith\",\n      \"full_name\" : \"John Smith\",\n      \"eligible_for_card_updater\" : true,\n      \"issuer_identification_number\" : \"41111111\",\n      \"payment_method_type\" : \"credit_card\",\n      \"verification_value\" : \"XXX\"\n    }\n  }\n}"
},
{"id": "b5c995f9-0ae8-455d-af0a-68f6995305bd",
"createdDate": "2023-07-02T09:20:17.333Z",
"type": "CAPTURE",
"successful": true,
"amount": {"amount": 36.63,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 3663,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"ReaQQuCxWIhL1h1gyfE0VAuKQlI\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful capture\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:17Z\",\n      \"updated_at\" : \"2023-07-02T09:20:17Z\"\n    },\n    \"gateway_transaction_id\" : \"51\"\n  }\n}"
},
{"id": "a080a8e1-c48f-410d-bd5a-7b921f5ce549",
"createdDate": "2023-07-02T09:20:28.650Z",
"type": "REFUND",
"successful": true,
"amount": {"amount": 1,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 100,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"Xn8g3ZiTFJ1Sbd3AOlvr2aZtdaW\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful credit\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:28Z\",\n      \"updated_at\" : \"2023-07-02T09:20:28Z\"\n    },\n    \"gateway_transaction_id\" : \"59\"\n  }\n}"
},
{"id": "e7d19c09-322b-4596-9206-4b45a532bff1",
"createdDate": "2023-07-02T09:20:38.441Z",
"type": "REFUND",
"successful": true,
"amount": {"amount": 2,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 200,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"CfcdzCUsXFlkNYNrnQsYoAquNAn\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful credit\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:38Z\",\n      \"updated_at\" : \"2023-07-02T09:20:38Z\"\n    },\n    \"gateway_transaction_id\" : \"68\"\n  }\n}"
}
]
}
]

Retrieving a single transaction

Retrieves a single payment transaction. The transaction contains all the transaction's events attached as an entries of the response body.

Required scopes

payment-gateway.paymenttransactions_read

SecurityOAuth2

Request

path Parameters

tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
transactionId required	string Unique identifier of a payment transaction.

Responses

200

Payment transaction response

401

Unauthorized

403

Access forbidden. The caller is not allowed to access this resource.

404

Not found. The resource does not exist.

500

Internal Server Error.

get/{tenant}/transactions/{transactionId}

Request samples

Response samples

application/json

{"id": "d8abfb12-0266-43dc-905e-415158029d45",
"provider": "SPREEDLY",
"paymentInformation": {"paymentMode": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
"creditCardToken": "FrHVCFtcshQ8gkOR8t5RlneLy02"
},
"entries": [{"id": "5ab6f875-5414-4845-afe9-8976531a2573",
"createdDate": "2023-07-02T09:19:42.170Z",
"type": "AUTHORIZATION",
"successful": true,
"amount": {"amount": 36.63,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"transaction\" : {\n    \"amount\" : 3663,\n    \"payment_method_token\" : \"O7z9EVXYwzzxgQO78nobou22ET1\",\n    \"currency_code\" : \"EUR\",\n    \"order_id\" : \"EON1562\",\n    \"retain_on_success\" : false\n  }\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"FrHVCFtcshQ8gkOR8t5RlneLy02\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful authorize\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:19:42Z\",\n      \"updated_at\" : \"2023-07-02T09:19:42Z\"\n    },\n    \"state\" : \"succeeded\",\n    \"retained\" : false,\n    \"amount\" : \"3663\",\n    \"gateway_transaction_id\" : \"48\",\n    \"created_at\" : \"2023-07-02T09:19:42Z\",\n    \"updated_at\" : \"2023-07-02T09:19:42Z\",\n    \"transaction_type\" : \"Authorization\",\n    \"order_id\" : \"EON1562\",\n    \"gateway_token\" : \"5xGx9vcZlMe1AVuHQk00CZTS8YM\",\n    \"currency_code\" : \"EUR\",\n    \"shipping_address\" : {\n      \"name\" : \"John Smith\"\n    },\n    \"payment_method\" : {\n      \"token\" : \"O7z9EVXYwzzxgQO78nobou22ET1\",\n      \"test\" : true,\n      \"month\" : 9,\n      \"year\" : 2023,\n      \"number\" : \"XXXX-XXXX-XXXX-1111\",\n      \"fingerprint\" : \"78250e7a0b53b34f526fbf99be66982e1127\",\n      \"created_at\" : \"2023-07-02T09:19:39Z\",\n      \"updated_at\" : \"2023-07-02T09:19:39Z\",\n      \"storage_state\" : \"cached\",\n      \"last_four_digits\" : \"1111\",\n      \"first_name\" : \"John\",\n      \"last_name\" : \"Smith\",\n      \"full_name\" : \"John Smith\",\n      \"eligible_for_card_updater\" : true,\n      \"issuer_identification_number\" : \"41111111\",\n      \"payment_method_type\" : \"credit_card\",\n      \"verification_value\" : \"XXX\"\n    }\n  }\n}"
},
{"id": "b5c995f9-0ae8-455d-af0a-68f6995305bd",
"createdDate": "2023-07-02T09:20:17.333Z",
"type": "CAPTURE",
"successful": true,
"amount": {"amount": 36.63,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 3663,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"ReaQQuCxWIhL1h1gyfE0VAuKQlI\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful capture\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:17Z\",\n      \"updated_at\" : \"2023-07-02T09:20:17Z\"\n    },\n    \"gateway_transaction_id\" : \"51\"\n  }\n}"
},
{"id": "a080a8e1-c48f-410d-bd5a-7b921f5ce549",
"createdDate": "2023-07-02T09:20:28.650Z",
"type": "REFUND",
"successful": true,
"amount": {"amount": 1,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 100,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"Xn8g3ZiTFJ1Sbd3AOlvr2aZtdaW\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful credit\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:28Z\",\n      \"updated_at\" : \"2023-07-02T09:20:28Z\"\n    },\n    \"gateway_transaction_id\" : \"59\"\n  }\n}"
},
{"id": "e7d19c09-322b-4596-9206-4b45a532bff1",
"createdDate": "2023-07-02T09:20:38.441Z",
"type": "REFUND",
"successful": true,
"amount": {"amount": 2,
"currency": "EUR"
},
"summary": "Succeeded!",
"remoteRequest": "{\n  \"amount\" : 200,\n  \"currency_code\" : \"EUR\"\n}",
"remoteResponse": "{\n  \"transaction\" : {\n    \"token\" : \"CfcdzCUsXFlkNYNrnQsYoAquNAn\",\n    \"succeeded\" : true,\n    \"message\" : \"Succeeded!\",\n    \"response\" : {\n      \"success\" : true,\n      \"message\" : \"Successful credit\",\n      \"pending\" : false,\n      \"cancelled\" : false,\n      \"result_unknown\" : false,\n      \"created_at\" : \"2023-07-02T09:20:38Z\",\n      \"updated_at\" : \"2023-07-02T09:20:38Z\"\n    },\n    \"gateway_transaction_id\" : \"68\"\n  }\n}"
}
]
}