Skip to main content

Deposit refund

Deposit refund.

amountint64required

Refund amount in currency minor units. Refund amount can not exceed the refunded payment amount.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
merchantRefNumMerchantReferenceNumber (string)

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Possible values: <= 255 characters

Example: 4bc2deb3-9766-4598-a08e-a98b60615936
idstringrequired

Refund id generated during creation.

Example: 112233
customerIdstringrequired

Customer id.

Example: 10001
accountIdstringrequired

The account funding the refund. Account id deduced from the relevant deposit.

Example: 2100002
slipIdstring

Slip identifier. Slip contains list of transactions associated with the withdrawal operations.

Example: 5009964049
fundingTransactionIdstring

Deposit funding transaction id.

Example: 500005
refundTransactionIdstring

Refund funding transaction id.

Example: 500005
creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimedate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
paymentOptionPaymentOptionType (string)required

Enumeration of supported Payment Option Types

Possible values: [RAPID_TRANSFER, BANK_TRANSFER, OFFLINE_BANK_TRANSFER, CARD, PAYSAFECASH, PAGO_EFECTIVO]

Example: CARD
statusPayment Status (string)required

The payment status:

  • PREVIEW - Payment preview.
  • PENDING - Payment transaction is created and further action is required by the customer.
  • PROCESSING - Payment is scheduled for processing by the payment provider.
  • COMPLETED - Payment is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
  • FAILED - Payment has failed. Check STATUS_REASON property for details.
  • CANCELLED - Payment have been cancelled
  • REFUNDED - Payment has been refunded. Valid only for deposits.

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED]

Example: COMPLETED
statusReasonstring

Status reason for FAILED transaction.

Possible values: <= 60 characters

nextStatusPayment Status (string)[]

Provides the next possible status update the client can request, depending on the chosen payment type and option.

Possible values: [PREVIEW, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED]

Deposit refund
{
  "amount": 0,
  "currencyCode": "EUR",
  "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
  "id": "112233",
  "customerId": "10001",
  "accountId": "2100002",
  "slipId": "5009964049",
  "fundingTransactionId": "500005",
  "refundTransactionId": "500005",
  "creationTime": "2021-07-15T17:54:12Z",
  "expirationTime": "2021-07-15T17:54:12Z",
  "paymentOption": "CARD",
  "status": "COMPLETED",
  "statusReason": "string",
  "nextStatus": [
    "COMPLETED"
  ]
}