Digital Payment Requests via the API
  • 26 Apr 2024
  • 1 Minute to read
  • Dark
    Light

Digital Payment Requests via the API

  • Dark
    Light

Article summary

Like all Evolve features, it’s possible to create and manage Digital Payment Requests (DPR) via the API. You will need to do this if you want to use DPR and are not using the Evolve Merchant Portal (e.g. if you are using your own onboarding screens) 

Prerequisite

Before you can use DPR you will need to initialise the merchant settings. This is done by updating the payment request settings to include, at a minimum, the merchant name. 

 

Parameter 

Notes 

paymentGateway* 

This should always be EVOLVE 

ownerId* 

This should be your ISV ID 

merchantId* 

This should be the merchant ID 

merchantName* 

This should be the trading name or the legal name of the merchant 

defaultExpiryDays 

The default value for how long you want the link to be active for. This can be overridden in the individual payment requests 

addressFooter 

This will populate a contact address in the footer 

contactNumberFooter 

This will populate a contact phone number in the footer 

emailIdFooter 

This will populate a contact email address in the footer 

termsUrl 

If the merchant had any terms and conditions this will populate a link to them in the footer 

*mandatory   

Example code 

curl --location --request PUT 'https://api.test.pay360evolve.com/demo/pf-api-gateway/apiGateway/paymentRequestService/paymentRequests/EVOLVE/<ISVID>/<MERCHANTID>/settings' \ 

--header 'If-Match: 0' \ 

--header 'jwt: <API KEY>' \ 

--header 'Content-Type: application/json' \ 

--data-raw '{ 

"paymentGateway": "EVOLVE", 

"ownerId": "< ISVID>", 

"merchantId": "< MERCHANTID>", 

"merchantName": "<Trading Name>", 

"defaultExpiryDays": "30", 

"addressFooter": "10 Test Street, Testton, GBR, TS3 3ST", 

"contactNumberFooter": "+44123456789", 

"emailIdFooter": "contact@example.com", 

"termsUrl": "https://www.example.com/t&c" 

}' 

For the initialisation request the If-Match value will be 0. For any further updates you will need to get the payment request settings and use the eTag value (returned in the response header) as the If-Match value.


Was this article helpful?

What's Next