You can send payment requests using the Odero API for successful or unsuccessful payments made earlier.
Information about the endpoint and HTTP method used for the payment request is provided below:
| HTTP Metрod | URL |
|---|---|
GET |
/payment-reporting/v1/payments/:id |
You can initiate a payment request simply by using the payment identifier.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
integer |
Yes | The payment ID specified in the request |
Parameters returned after a payment operation through the General Payment Page must adhere to the rules specified in the Return Formats section on the main API documentation page. In the absence of systemic or structural errors, the parameters of the returned object in data look like the following:
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
long |
Yes | Payment operation ID |
createdDate |
date |
Yes | Date of the initial creation of the payment operation |
updatedDate |
date |
Yes | Date of updating the payment operation |
orderId |
string |
Yes | Unique identifier created by Odero in the context related to the payment. Created by Odero for wallet-related operations, otherwise by the bank. |
price |
decimal |
Yes | Total payment amount in the basket |
paidPrice |
decimal |
Yes | Paid total amount |
walletPrice |
decimal |
Yes | Amount deducted from the wallet |
paymentType |
PaymentType |
Yes | See Payment Types |
currency |
Currency |
Yes | See Currencies |
paymentStatus |
PaymentStatus |
Yes | See Payment Statuses |
conversationId |
string |
No | Value of conversationId sent by the business in the payment request |
paymentCard |
PaymentCard |
Yes | (see Information about payment card and commission fees) Information about the card and commission fees associated with the payment |
paymentRefunds |
PaymentRefund[] |
Yes | (see Information about payment refunds) List of refunds associated with the payment |
paymentTransactions |
PaymentTransaction[] |
Yes | (see Information about payment transactions) Details of the sections included in the payment |
Sent along with all payments, including the full wallet balance.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
cardType |
CardType |
No | (see: Card Types) Present in case of full or partial deduction from the card. Indicates the type of card |
cardAssociation |
CardAssociation |
No | (see: Card Associations) Present in case of full or partial deduction from the card. Specifies the organization to which the card is linked |
cardBrand |
string |
No | Present in case of full or partial deduction from the card. Corresponds to the cardBrand value in the card data sent in the payment request |
cardHolderName |
string |
No | Present in case of full or partial deduction from the card. Reflects the name and surname of the cardholder |
binNumber |
string |
No | Present in case of full or partial deduction from the card. Reflects the first 6 digits of the card number |
lastFourDigits |
string |
No | Present in case of full or partial deduction from the card. Reflects the last 4 digits of the card number |
installment |
integer |
Yes | Reflects the number of payments on the account. Valid values: 1, 2, 3, 6, 9, and 12 |
isThreeDS |
boolean |
No | Present in case of full or partial deduction from the card. Reflects whether the payment was made using 3D Secure |
mdStatus |
integer |
No | (see: MD Status) Present in case of full or partial deduction from the card, made using 3D Secure. Reflects the status of 3D Secure confirmation |
pfCommissionRateAmount |
decimal |
Yes | The amount of commission charged by Odero as a payment intermediary for the payment |
merchantCommissionRate |
decimal |
Yes | The percentage of commission applied by the business participant to the payment |
merchantCommissionRateAmount |
decimal |
Yes | The total amount of commission charged by the business participant for the payment |
error |
Error |
No | (see: Error Information) Present when processing payments that end in error. Contains error information |
Contains detailed information about fully refunded payments. The parameters included in this information are structured in the table below:
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
long |
Yes | ID of the refund operation created by Odero |
createdDate |
date |
Yes | Date of the refund |
refundStatus |
string |
Yes | See Refund Statuses |
refundDestinationType |
RefundDestinationType |
Yes | See Refund Types |
price |
decimal |
Yes | Cancelled amount |
refundBankPrice |
decimal |
Yes | Refunded to the card after cancellation |
refundWalletPrice |
decimal |
Yes | Refunded to the wallet after cancellation |
conversationId |
string |
Yes | Value of conversationId sent by the business in the cancellation request |
paymentType |
PaymentType |
Yes | See Payment Types. The type of deduction for the cancelled payment |
error |
Error |
No | See Error Information. Present in case of unsuccessful cancellation. Contains error information |
This includes payment distribution information , the pricing of a payment based on these distributions, and refund items related to remittances and breakage.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
long |
Yes | Payment distribution ID |
createdDate |
date |
Yes | Date of payment distribution creation |
externalId |
string |
No | External identifier associated with the payment distribution sent in the payment request |
transactionStatus |
TransactionStatus |
Yes | (see Money Transfer Statuses) Value indicating the money transfer status associated with the distribution |
transactionStatusDate |
date |
Yes | Date of the last change in the money transfer status associated with the distribution |
price |
decimal |
Yes | The amount of the payment distribution in the cart |
paidPrice |
decimal |
Yes | The portion of the total amount withheld for payment |
walletPrice |
decimal |
Yes | The portion of the total amount withheld from the wallet for payment |
merchantPayoutAmount |
decimal |
Yes | The portion of the amount sent to the business participant in connection with the payment, attributed to the corresponding distribution |
subMerchantId |
long |
No | ID of the associated child business participant linked to the distribution |
subMerchantName |
string |
Yes | Occurs if the payment distribution is associated with a child business. Contains the name of the corresponding child business |
subMerchantPrice |
decimal |
Yes | Occurs if the payment distribution is associated with a child business. Represents the share of the total amount that will be transferred to the child business from the total payment amount |
subMerchantPayoutRate |
decimal |
Yes | Occurs if the payment distribution is associated with a child business. Represents the ratio of the amount that will be sent to the child business to the amount sent for payment |
subMerchantPayoutAmount |
decimal |
Yes | Occurs if the payment section is associated with a child business. Represents the amount that will be sent to the child business in connection with the payment |
payout |
Payout |
Yes | (see: Distribution of payment section payouts) Contains information about the distribution of money transfers associated with the payment distribution between the main business, child business, and Odero |
paymentTransactionCard |
PaymentTransactionCard |
Yes | (see: Payment section card and commission fee information) Contains information about the card and commission fee associated with the payment distribution |
paymentTransactionRefunds |
PaymentTransactionRefund[] |
Yes | (see: Payment section refund information) Contains a list of full or partial refund information associated with the payment distribution |
This contains information about the card and fees associated with payment distribution.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
merchantCommissionRate |
decimal |
Yes | The commission rate applied by the merchant to the payment |
merchantCommissionRateAmount |
decimal |
Yes | The amount of commission charged by the merchant for the payment and attributed to the share of the payment |
pfCommissionRateAmount |
decimal |
Yes | The amount of commission charged by Odero as a payment agent for the payment, and attributed to the share of the payment |
This section contains information about the distribution of funds between the main business, sub-business, and Odero related to the execution of a money transfer associated with the payment.
The currency of distribution is always AZN, so there is a conversion rate difference for payments in other currencies. These differences are indicated in the pfConversionRate and pfConversionRateAmount fields.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
paidPrice |
decimal |
Yes | Share of the corresponding amount withheld for payment |
currency |
Currency |
Yes | See: Currencies |
merchantPayoutAmount |
decimal |
Yes | Share of the amount sent to the business member in connection with payment in the respective region |
subMerchantPayoutAmount |
decimal |
Yes | Share of the amount sent to the sub-business in connection with payment in the respective region |
pfCommissionRateAmount |
decimal |
Yes | Share of the amount sent to Odero as a commission for payment |
pfConversionRate |
decimal |
Yes | Exchange rate difference used by Odero for transfers in currencies other than AZN. For payments in AZN, it is 0 |
pfConversionRateAmount |
decimal |
Yes | Exchange rate difference received by Odero for transfers in currencies other than AZN. For payments in AZN, it is 0 |
Information about fully or partially successful or unsuccessful refunds associated with payment distribution.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
id |
long |
Yes | ID created by Odero for the refund operation |
createdDate |
date |
Yes | Refund operation creation date |
refundStatus |
string |
Yes | See: Refund statuses |
refundDestinationType |
RefundDestinationType |
Yes | See: Refund types |
price |
decimal |
Yes | Amount of the refunded payment |
refundBankPrice |
decimal |
Yes | Amount refunded to the bank card after the refund |
refundWalletPrice |
decimal |
Yes | Amount refunded to the wallet after the refund |
conversationId |
string |
Yes | Value of conversationId sent by the participating business in the refund request |
paymentType |
PaymentType |
Yes | (See: Payment types) Type of the canceled payment deduction |
isAfterSettlement |
boolean |
Yes | Determines whether the refund was made after sending money for the business |
error |
Error |
No | (See: Error information) Appears in case of an unsuccessful refund. Contains error information |
Contains error details received from the bank during the payment refund operation. The values of errorCode and errorGroup correspond to those presented on the Error Codes page.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
errorCode |
string |
Yes | Value of errorCode defined by Odero API for the corresponding error |
errorGroup |
string |
Yes | Error group |
errorName |
string |
No | Name of the error returned by the bank |
errorMessage |
string |
No | Error message returned by the bank |