AlliancePay
🇬🇧 English
🇬🇧 English
  • E Commerce platform AlliancePay v2.32.0
  • Authentication
  • Data Encryption
  • Authorization
  • Using an authorization token
  • Key Management Overview
    • PURCHASE Collection Example
    • A2C Collection Example
  • Payment methods H2H
    • PURCHASE
      • PURCHASE Request - Step 1
      • PURCHASE Request - Step 2
    • A2C
    • C2A
      • C2A Transaction Request - Step 1
      • C2A Transaction Request - Step 2
    • ApplePay decrypted
      • PURCHASE
        • Payment Processing Request - Step 1
        • Payment Processing Request - Step 2 (3DS)
      • C2A
        • C2A request Step 1
        • C2A request Step 2 (3DS)
    • ApplePay encrypted
      • Request aPay support on the page
      • Request to receive aPay merchant data
      • Merchant validation request
      • Session Establishment Request in aPay
      • Payment Processing Request
    • GooglePay™ decrypted
      • PURCHASE
        • Payment Processing Request - Step 1
        • Payment Processing Request - Step 2 (3DS)
      • C2A
        • C2A request Step 1
        • C2A request Step 2 (3DS)
    • GooglePay™ encrypted
      • Google Pay™ Documentation
      • Google Pay™ Support Request on the Page
      • Google Pay™ Merchant Data Retrieval Request
      • Payment request
    • REFUND
    • TOKEN
      • PURCHASE
        • Token payment request Step 1
        • 3DS token payment request Step 2
      • C2A
        • Token payment request Step 1
        • 3DS token payment request Step 2
      • Token Creation
      • Retrieve Token by CustomerId
      • Retrieve Token Data
      • Update Token Status
      • Token Statuses
    • Account Verification
      • Card Verification Request Step 1
      • Card verification request Step 2
    • Getting data
      • By OPERATION_ID
      • By merchantRequestId
    • Getting a balance
    • Callback
  • Payment methods HPP
    • PURCHASE
      • Creating an order
      • Receiving order data
    • REFUND
    • Callback
    • Order statuses
  • Dictionary
    • Transaction status
    • Test cases
    • Error codes
    • Value actionCode, responseCode
    • Limits
    • Instructions for reconciliation by registers
      • Fields Description in Registers
    • Whitelist IP addresses and URLs
  • History of changes
Powered by GitBook
On this page
  • Input parameters:
  • Output parameters:
  • Example of a request body
  • Example of response body
  1. Payment methods H2H

REFUND

{{url}}/ecom/execute_request/payments/v3/refund

A refund is used when it is necessary to return funds to the client for a successfully completed Payment transaction. As a result of this transaction, the funds will be returned to the card from which the original transaction was paid.

Input parameters:

Parameter
Description
Data Format
Required
Example

merchantRequestId

Unique request identifier generated by the merchant's system

string (36)

Yes

137d9304-0368-11ed-b939-0242ac120002

merchantId

Merchant identifier

string

Yes

"1234567890"

operationId

Id транзакціі

string

1712844596346b9F-WwrWZpq

coinAmount

Payment amount.

string

Yes

2000

date

Payment date and time

string

Yes

{{currentdateT}}.00+03:00

notificationUrl

URL to which the CallBack is sent

string

No

notificationEncryption

Callback data encryption feature

string

No

true/false If the parameter is not passed or false is passed, then the data in the CallBack will be unencrypted

merchantComment

Additional merchant comment on the order

string(255) a-zA-Z0-9 ,.;:@#$%'-=+1,256$

No

"merchant Comment id 1258728c1"

Output parameters:

Parameter
Description
Data Format
Example

type

Transaction type.

string

Purchase

rrn

RRN transaction number in MPS.

string

2,55E+09

purpose

Payment purpose.

string

For goods

comment

Comment.

string

test

coinAmount

Payment amount.

int

2000

merchantId

Merchant ID.

string

137d9304-0368-11ed-b939-0242ac120002

operationId

Transaction ID.

string

1712844596346b9F-WwrWZpq

ecomOperationId

Transaction ID in the Ecom system.

string

8c3303e9-7396-43b8-af4e-31d9facdde9b

merchantName

Merchant name.

string

KB test terminal

approvalCode

Authorization code.

string

39203

status

Transaction status.

string

Possible values: SUCCESS, FAIL, PENDING, REQUIRED_3DS, DESIRED_THREEDS_MODE_ERROR

transactionType

Transaction type in numerical form.

string

35

merchantRequestId

Merchant request id

string

72837906-f526-4aef-8d11-58d80b44cb75

transactionCurrency

Payment currency.

string

980

merchantCommission

Commission amount

string

2

createDateTime

Transaction creation date.

string

########

modificationDateTime

Transaction modification date.

string

########

actionCode

Response code

string

0

responseCode

Response details.

string

0

description

Response description.

string

approved

processingMerchantId

Merchant ID in the PC

string

AE100000

processingTerminalId

Terminal ID in the PC

string

AE100000

bankCode

Issuer bank name.

string

BANK_ALLIANCE

paymentSystem

Issuer MPS name.

string

MasterCard

productType

Terminal product type.

string

PURCHASE

notificationUrl

URL to which the CallBack is sent

string

paymentServiceType

Payment type

string

CARD/APPLE_PAY/GOOGLE_PAY

notificationEncryption

Callback data encryption feature

string

true/false If the parameter is not passed or false is passed, then the data in the CallBack will be unencrypted

originalOperationId

Id under which the original transaction was created

string

1712843529623cHAHkmt-G5u

originalCoinAmount

Original payment amount

int

100

originalEcomOperationId

Id in the Ekom system under which the original transaction was created

string

c25ee1cb-a052-439b-b075-bcb632615b11

rrnOriginal

RRN original transaction number in MPS

string

1,2E+08

Example of a request body

{
"merchantRequestId":"137d9304-0368-11ed-b939-0242ac120002",
"operationId":"137d9304-0368-11ed-b939-0242ac120002",
"merchantId":"137d9304-0368-11ed-b939-0242ac120002",
"coinAmount":"2500", 
"notificationUrl": "",
"date": "2022-11-11 11:58:41.56+00:00"
}

Example of response body

{
    "type": "REFUND",
    "rrn": "410213187861",
    "purpose": null,
    "comment": null,
    "coinAmount": 100,
    "merchantId": "137d9304-0368-11ed-b939-0242ac120002",
    "operationId": "1712843529623cHAHkmt-G5u",
    "ecomOperationId": "3af2de3a-035d-44c4-9f63-d3c899687d34",
    "merchantName": null,
    "approvalCode": null,
    "status": "PENDING",
    "transactionType": 76,
    "merchantRequestId": "21f8ab16-3d4e-4ece-a3f5-ecb406c394ff",
    "transactionCurrency": "980",
    "merchantCommission": null,
    "createDateTime": "2024.09.19 15:29:25.675",
    "modificationDateTime": "2024.09.19 15:29:25.675",
    "transactionResponseInfo": {
        "actionCode": null,
        "responseCode": null,
        "description": "Операція успішна"
    },
    "bankCode": null,
    "paymentSystem": null,
    "productType": "PURCHASE",
    "notificationUrl": "https://api-ecom-prod.bankalliance.ua/mock",
    "paymentServiceType": null,
    "notificationEncryption": false,
    "rrnOriginal": "410213187861",
    "originalOperationId": "1712843529623cHAHkmt-G5u",
    "originalCoinAmount": 100,
    "cardNumberMask": null,
    "originalEcomOperationId": "c25ee1cb-a052-439b-b075-bcb632615b11"
}
PreviousPayment requestNextTOKEN

Last updated 2 months ago

​https://merchant.notification_url/​
​https://merchant.notification_url/​