Versions Compared

Key

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

Process the payment and return to the user defined URL with encoded transaction IDthe banking server redirect url as response. After completion of the transaction, user will be redirected to the return url with url encoded transaction response.


Anchor
ob-process
ob-process

Process


Open Banking

POST /v1 /pay/obv1/processopenbankings

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributesmerchant_idintegerMerchant id.

payment_intentstring
Payment intent token.paymentTokenstring
Payment token.typestring
Type 1 is ECOM payment and type 2 is MOTO.

raw_amountfloat
Payment amount.customer_emailstring
Customer email.

customer_namestring
Customer name.

customer_addressstring (optional)
User’s address details.

customer_postcodestring (optional)
User’s postcode.

transaction_uniquestring
Transaction unique.

merchant_data json (optional)
The merchant can add custom key value pairs in JSON format, for example:

Code Block
{
  "my_order_id": 123,
  "fancy_note": "Order complete",
  "card_discount": false
}

Request

Code Block
POST https://secure.blinkpayment.co.uk/api/v1/pay/obv1/processopenbankings HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "merchant_id": "123456",
    "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
    "customer_email": "random@email.com",
    "customer_name": "A Smith",
    "transaction_unique": "syuryui",
    "merchant_data": "{\"my_order_id\": \"ob-12345678\"}"
}

Response

Code Block
HTTP/1.1 200 OK
Content-Type: application/json

{
    "redirect_url": "https://api-demo-php.blinkpayment.co.uk/return?res=QkwtTVlVRTV...%3D%3D"
}fidelitygate.devandops.com/tobp-gateway/hppcallredirect/643f****************"
}

Response codes

Code

Status

Title

Message

Notes

200

Success

Success

Payment successful

If payment is successful, then this status will be returned

400

Failed

Validation error

Customer name is required

If customer name is not present, this status will be returned

400

Failed

Validation error

Customer email is required

If customer email is not present, this status will be returned

500

Failed

Failed

Payment Failed

If payment is not successful, then this status will be returned