Originalcredits


Use Originalcredits to make a refund without referring to a historic payment order. You must define a new and unique payment order reference. Originalcredits supports refunds to credit cards and bank accounts.

Endpoints

POST /api/v2/merchants/{mid}/orders/{orderId}/originalcredits

Makes a refund with a new payment order reference.

Request parameters

Path parameter Requirement Description Type
mid Required The merchant account reference number. Number
orderId Required The reference to uniquely identify a payment. String
Body parameter Requirement Description Type
amount Optional The transaction amount. Number
curency Optional The ISO 4217 currency code. String
cardNumber Optional The shopper’s card account number. String
cardExpiryDate Optional The shopper’s card expiry month and year in the format MM/YY. String
iban Optional The International Bank Account Number. String
swiftBIC Optional The bank identifier code. String
paymentMethodId Optional The reference number to the payment method. Number

Sample request

curl -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172' \
    https://   /api/v2/merchants/1570616552/orders/order_example_1/originalcredits

Request body example

{
   "amount": {
      "amount": 10.50,
      "currency": "EUR"
   },
   "cardInfo": {
      "cardNumber": "5555555555554444",
      "cardExpiryDate": "06-2026"
   }
}
{
   "amount": {
      "amount": 10.50,
      "currency": "EUR"
   },
   "bankBillingInfo": {
      "iban": "SE123456",
      "swiftBIC": "ESSESESS"
   },
   "paymentMethodId": 3502
}

Sample response

{
    "mid": 1570616552,
    "orderId": "order_example",
    "orderAmount": 0.00,
    "fulfilmentAmount": 0.00,
    "capturedAmount": 0.00,
    "refundedAmount": 10.50,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 0.00,
    "baseFulfilmentAmount": 0.00,
    "baseCapturedAmount": 0.00,
    "baseRefundedAmount": 10.50,
    "capturable": false,
    "cancelable": false,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "timestamp": "2020-01-08T14:03:03.144Z",
    "transactionReferences": [
        {
            "transactionId": 10040895226,
            "transactionTypeId": 7,
            "mid": 1570616552,
            "orderId": "order_example",
            "transactionType": "OriginalCredit",
            "transactionDate": "2020-01-08T14:04:13.578Z",
            "transactionDesc": "Transaction Accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.50,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "maskedAccountNumber": "411111xxxxx1111",
            "cardExpiryDate": "12-2024"
        }
    ]
}