Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The merchant shall inform a listener HTTPS URL to its account manager in order to set up this feature. The webhook will be sent as HTTP POST call with a JSON in the body.

When your service receives a webhook notification, it must return a 2xx HTTP 200 HTTP status code. Otherwise, the webhook service considers the notification delivery as failed. PrimeiroPay currently does not retry failed webhooks.

Example:

Code Block
languagejson
{
  "uniqueId":"777777777777777",
  "merchantId":"8acda4cb6193d56a0161949d31de0dda",
  "merchantTransactionId":"1331837",
  "amount":1762.0,
  "incomingChargeback":"Nao",
  "adyenMerchantRefId":"4147"
}

Name

Description

Format

Example

UniqueId

Unique Identifier for PrimeiroPay

AN [a-zA-Z0-9_]

8a83948355021710015507ccee0869a1

merchantId

Unique Identifier of the merchant for PrimeiroPay

AN [a-zA-Z0-9_]

8a83948355021710015507ccee0869a1

merchantTransactionId

Unique id of the transaction related to the dispute, if connected via Adyen it is the PSP Reference

AN [a-zA-Z0-9_]

8a83948355021710015507ccee0869a1

amount

Amount of original transaction

N13[0- 9]{1,10}\.[0 -9]{2}

54.12

incomingChargeback

Will have to fixed values:
Nao or Sim
In case of Nao, the payer has not yet filed a chargeback with its issuing bank and it is recommended to refund the transaction if feasible

AN [a-zA-Z0-9_]

Nao

adyenMerchantRefId

Merchant Reference ID from Adyen if Merchant is connected through Adyen to PrimeiroPay

AN [a-zA-Z0-9_]

4147