API changes - Updates to payment agent create and modification API Calls.

Dear developers,
During the week starting 26 July 2021, we’ll be replacing the following fields in payment agent API calls:

  • url
  • telephone
  • supported banks
  • payment_methods

with these fields:

  • urls: an array of objects with a single attribute url; for example:
    { "urls": [{ "url" :"https://..."}, {"url": "http://...'" }]}

  • phone_numbers: an array of objects with a single attribute phone_number; for example:
    { "phone_numbers": [{ "phone_number" : "+122344"}, {"phone_number" : "+98765"} ]}

  • supported_payment_methods: an array of objects with a single attribute payment_method; for example:
    { "supported_payment_methods": [{ "payment_method" : "Method 1"}, {"payment_method" : "Method 2"} ]}

We’ll remove the deprecated fields from the 'paymentagent_create' request and 'paymentagent_details' response, but we’ll keep them temporarily in the paymentagent_list response.

Here's the paymentagent_list response before and after the change:

  • before:
{
    "name": "Agent 1",
    "url": "http://website.agent",
    "telephone": "+123456",
     "supported_banks': "Bank1, Bank2",
     ...
}
  • after:
{
    "name": "Agent 1",
    "url": "http://website.agent",
    "telephone": "+123456",
    "supported_banks': "Bank1, Bank2",
    "urls": [{ "url" : "http://website.agent"}],
    "phone_numbers": [{ "phone_number" : "+123456"} ],
    "supported_payment_methods": [{ "payment_method" : "Bank1"}, {"payment_method"  : "Bank2"} ],
     ...
}

Please make the necessary changes to your code.

If you have any questions, contact us at api-support@deriv.com.

Thank you.

Sign In or Register to comment.